Validate that current release is present in changelog #192
Assignees
Labels
Comments
Gudahtt
added a commit
to MetaMask/core
that referenced
this issue
May 9, 2024
The version of the `@metamask/profile-sync-controller` package has been updated to `0.0.0`, which is what our publishing automation expects of all unpublished public packages. The current version is `0.1.0`, which caused problems for our most recent release, requiring a rollback. It broke publishing because our publishing scripts tried to find version `0.1.0` in the package changelog but were unable to. This should have been caught by our linter, but it wasn't due to a deficiency in the `@metamask/auto-changelog` validation command (it doesn't validate that the current release exists). This problem has been documented here: MetaMask/auto-changelog#192
3 tasks
Gudahtt
added a commit
to MetaMask/core
that referenced
this issue
May 9, 2024
## Explanation The version of the `@metamask/profile-sync-controller` package has been updated to `0.0.0`, which is what our publishing automation expects of all unpublished public packages. The current version is `0.1.0`, which caused problems for our most recent release, requiring a rollback. It broke publishing because our publishing scripts tried to find version `0.1.0` in the package changelog but were unable to. This should have been caught by our linter, but it wasn't due to a deficiency in the `@metamask/auto-changelog` validation command (it doesn't validate that the current release exists). This problem has been documented here: MetaMask/auto-changelog#192 ## References Unblocks #4272 ## Changelog N/A ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The
validatecommand does not validate that the current release exists in the changelog (unless the--rcflag is used). Some of our publishing workflows depend upon the release existing, so we need this tool to help us ensure it's present.The
validatecommand already checks this correctly in--rcmode.Acceptance criteria:
--rcflag:auto-changelog validatethrows an error if the release is present in the changelog (0.0.0 should indicate that the package has not yet been released)auto-changelog validatethrows an error when the current release is missingThe text was updated successfully, but these errors were encountered: