Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: move @mapquest/team to optionalDependencies #2

Merged
merged 2 commits into from
Dec 20, 2024

Conversation

igoforth
Copy link

Moving internal tooling dependency to optionalDependencies to prevent installation failures for public users while maintaining internal development workflows.

Jira ticket number: N/A - Public GitHub contribution

Does this PR introduce a breaking change? No

Are all of the original requirements satisfied in this PR? Yes

What is the current behavior?

Currently, attempting to install iso-3166 from GitHub fails because npm/yarn try to fetch the @mapquest/team package from GitHub's package registry, which requires authentication. This prevents public users from being able to install and use the package.

Error message example:

npm error code E401
npm error 401 Unauthorized - GET https://npm.pkg.github.com/download/@mapquest/team/0.3.8/6a517b00cd28546eae76bd98c593b263da17dae2 - authentication token not provided

What is the new behavior?

  • Package can be installed by public users without authentication errors
  • Internal MapQuest development workflows remain unchanged
  • @mapquest/team package is now optional, allowing the installation to succeed even when the package cannot be accessed

How to test

  1. Clone this PR's branch
  2. Run yarn add . or npm install . in a clean directory
  3. Verify the installation succeeds without authentication errors
  4. For MapQuest team members: verify that eslint and jest configurations still work as expected when authenticated

Motivation and context

The package is MIT licensed and publicly available on GitHub, but the current dependency structure prevents public users from installing it directly. This change maintains all internal tooling while making the package more accessible to the open source community.

Checklist

  • The title of this PR follows the conventional commit guidelines
  • Acceptance criteria from the original issue has been satisfied
  • I have performed a self-review of my code and the expected functionality
  • Changes are minimal and focused on solving the installation issue
  • No documentation changes needed as this is an internal configuration change
  • The changes introduced can go live immediately
  • Product or Business stakeholders have performed acceptance testing

Moving internal tooling dependency to optionalDependencies to prevent installation failures for public users while maintaining internal development workflows.
@Ignigena Ignigena changed the title move @mapquest/team to optionalDependencies build: move @mapquest/team to optionalDependencies Dec 20, 2024
@Ignigena
Copy link
Member

@igoforth Thank you for your contribution! 🎉

@Ignigena Ignigena merged commit c980393 into MapQuest:main Dec 20, 2024
2 checks passed
Copy link

codecov bot commented Dec 20, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants