Repository navigation
docs(processes): correct the releasing guide - #265
Open
georgewrmarshall wants to merge 1 commit into
Open
georgewrmarshall wants to merge 1 commit into
georgewrmarshall wants to merge 1 commit into
Conversation
The guide named yarn create-release-branch and yarn changelog:validate, which do not exist, and listed the publish steps out of order. Replace them with the actual flow: the Create Release PR workflow dispatch cuts the release branch and PR, validation is yarn lint:changelog --rc plus build/test/pack:dry-run, and publish-release.yml runs the npm dry-run, the gated npm publish, then the GitHub release and tag. Also note to merge main into the release branch when PRs land after the cut, and to fold them into the release entries. Co-authored-by: George Marshall <georgewrmarshall@users.noreply.github.com>
Merged
This branch has not been deployed
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
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.
Description
Follow-up from the review on the 0.4.0 release PR:
docs/processes/releasing.mdwas out of date.yarn create-release-branchandyarn changelog:validate, which do not exist. The release branch and PR come from the Create Release PR workflow dispatch (MetaMask/action-create-release-pr), and validation isyarn lint:changelog --rcplusyarn build/yarn test/yarn pack:dry-run.publish-release.ymlactually runs the npm dry-run first, then the gatedPublish to NPMjob (npm-publishenvironment,NPM_TOKENneeded only for the first publish), andMetaMask/action-publish-releasecreates the GitHub release and tag last.maininto the release branch when pull requests land after the cut, and fold their changes into the release entries so nothing in the tag ships without a changelog entry (this came up while updatingrelease/0.4.0for chore(recipe-cook): recommend mm-harness 0.96.32 and require a recorded baseline before the fix #258, docs(perps-review-pr): accept a branch or commit range as the review request #260, chore(perps-review-pr): regenerate from the Perps rules at f8b9642 #261 and later merges).No
CHANGELOG.mdentry:docs/processes/is contributor documentation and is not part of the published package.Type of Change
Skill Details (if adding a new skill)
Provider Name: N/A
Skill Name: N/A
Brief Description: N/A
Checklist