Skip to content

Conversation

pieh
Copy link
Contributor

@pieh pieh commented Dec 27, 2024

🎉 Thanks for submitting a pull request! 🎉

Summary

Fixes https://linear.app/netlify/issue/FRB-1544/bunlock-not-selecting-bun-bunlockb-works

This is a BREAKING CHANGE as it changes the shape of public API


For us to review and ship your PR efficiently, please perform the following steps:

  • Open a bug/issue before writing your code 🧑‍💻. This ensures
    we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or
    something that`s on fire 🔥 (e.g. incident related), you can skip this step.
  • Read the contribution guidelines 📖. This ensures
    your code follows our style guide and passes our tests.
  • Update or add tests (if any source code was changed or added) 🧪
  • Update or add documentation (if features were changed or added) 📝
  • Make sure the status checks below are successful ✅

A picture of a cute animal (not mandatory, but encouraged)

BEGIN_COMMIT_OVERRIDE
fix: use bun as package manager when bun.lock is found

BREAKING CHANGE: packageManager.lockFile field containing single name of lock file is removed from output and packageManager.lockFiles field with array of possible lock files is introduced
END_COMMIT_OVERRIDE

@pieh pieh force-pushed the michalpiechowiak/frb-1544-bunlock-not-selecting-bun-bunlockb-works branch from 9076d8d to c733148 Compare December 27, 2024 15:09
@pieh pieh force-pushed the michalpiechowiak/frb-1544-bunlock-not-selecting-bun-bunlockb-works branch from c733148 to e106db4 Compare December 27, 2024 15:16
@pieh pieh changed the title fix: use bun as package manager when bun.lock is found fix!: use bun as package manager when bun.lock is found Dec 27, 2024
/** The lock file a package manager is using */
lockFile: string
/** The lock files a package manager is using */
lockFiles: string[]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could potentially opt to support both fields for a short period of time while calling the old one deprecated (maybe raise a warning message in the logs?). That way we can understand the scope of affected systems before we look to drop the field.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is limited number of things using @netlify/build-info directly, so I think we can skip on interim period - this package is not meant for public consumption per-se as it's quite Netlify specific, so I don't think it warrants extra effort to have a ~deprecation period. Instead maybe we just have a canary with this change that we adjust consumers of this package before we merge and publish this change so we can minimize "package upgrade downtime"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pieh pieh marked this pull request as ready for review January 8, 2025 14:44
@pieh pieh requested a review from a team as a code owner January 8, 2025 14:44
@pieh pieh merged commit 44bb81c into main Jan 8, 2025
33 checks passed
@pieh pieh deleted the michalpiechowiak/frb-1544-bunlock-not-selecting-bun-bunlockb-works branch January 8, 2025 15:01
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