chore: Forgo keeping version in package.json up to date#1006
Merged
Conversation
Currently when a new release is made (via Semantic Release), a robot will raise and merge a PR to update `version` in `package.json`. This is handy as we can browse the file to see what the latest version is. I don't think it's necessary for the release process - Semantic Release gets the latest version number from npm. It comes at a slight cost, however: - A bit of PR noise. We're not expected to interacted with the robot's PRs, but the `CODEOWNERS` rules mean we get added as reviewers. - An odd scenario where our CI checks don't pass and the robot's PR cannot be automatically merged. See #998. This change moves to a simpler model of keeping `version` in `package.json` completly static between releases. If one would like to find the number of the latest version, npm or GitHub releases can be used.
jacobwinch
approved these changes
Dec 23, 2021
2 tasks
Member
Author
|
Bah! The version number is being used on the documentation site!
|
Contributor
|
🎉 This PR is included in version 32.2.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
akash1810
added a commit
that referenced
this pull request
May 30, 2023
A second attempt at #1006 following a recent change in how permissions are granted to GitHub workflows. See: - #1006 - #1876 (comment).
2 tasks
akash1810
added a commit
that referenced
this pull request
Jun 13, 2023
A second attempt at #1006 following a recent change in how permissions are granted to GitHub workflows. See: - #1006 - #1876 (comment).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this change?
Currently when a new release is made (via Semantic Release), a robot will raise and merge a PR to update
versioninpackage.json.This is handy as we can browse the file to see what the latest version is.
I don't think it's necessary for the release process - Semantic Release gets the latest version number from npm.
It comes at a slight cost, however:
CODEOWNERSrules mean we get added as reviewers.This change moves to a simpler model of keeping
versioninpackage.jsoncompletly static between releases.If one would like to find the number of the latest version, npm or GitHub releases can be used.
How to test
Might be one to try on the
betabranch?How can we measure success?
Releasing a new version of the library produces less noise.
Have we considered potential risks?
This should not have any impact on the release process as Semantic Release gets the latest number from npm, rather than reading form the
package.json.Checklist
Footnotes
Consider whether this is something that will mean changes to projects that have already been migrated, or to the CDK CLI tool. If changes are required, consider adding a checklist here and/or linking to related PRs. ↩
If you are adding a new construct or pattern, has new documentation been added? If you are amending defaults or changing behaviour, are the existing docs still valid? ↩