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

Update preview builds instructions #1629

Merged
merged 2 commits into from
Aug 24, 2023
Merged

Conversation

mcmire
Copy link
Contributor

@mcmire mcmire commented Aug 23, 2023

Explanation

The existing instructions for using preview builds did not quite work. To prevent errors we need to redirect two kinds of references to preview builds: import statements and transitive dependencies. The best way to achieve this is to make use of resolutions/overrides instead of changing the dependency lines directly. This replaces the production version of a package with its preview build across the entire dependency tree.

References

Relates to #1075.

Changelog

(No consumer-facing changes)

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate

The existing instructions for using preview builds did not quite work.
To prevent errors we need to redirect two kinds of references to preview
builds: import statements and transitive dependencies. The best way to
achieve this is to make use of `resolutions`/`overrides` instead of
changing the dependency lines directly. This replaces the production
version of a package with its preview build across the entire dependency
tree.
@mcmire mcmire requested a review from a team as a code owner August 23, 2023 22:00
Copy link
Member

@Gudahtt Gudahtt left a comment

Choose a reason for hiding this comment

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

Good catch!

@Gudahtt Gudahtt merged commit bcc4dc7 into main Aug 24, 2023
@Gudahtt Gudahtt deleted the update-preview-builds-instructions branch August 24, 2023 12:46
MajorLift pushed a commit that referenced this pull request Oct 11, 2023
The existing instructions for using preview builds did not quite work.
To prevent errors we need to redirect two kinds of references to preview
builds: import statements and transitive dependencies. The best way to
achieve this is to make use of `resolutions`/`overrides` instead of
changing the dependency lines directly. This replaces the production
version of a package with its preview build across the entire dependency
tree.
MajorLift pushed a commit that referenced this pull request Oct 11, 2023
The existing instructions for using preview builds did not quite work.
To prevent errors we need to redirect two kinds of references to preview
builds: import statements and transitive dependencies. The best way to
achieve this is to make use of `resolutions`/`overrides` instead of
changing the dependency lines directly. This replaces the production
version of a package with its preview build across the entire dependency
tree.
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