Skip to content

Commit 03159f5

Browse files
committed
chore: update how-to-release
1 parent f194ce6 commit 03159f5

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

docs/how-to-release.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ You will then be prompted with your `$EDITOR` to select which packages you want
3636
# - "minor" (if you want to bump the minor part of the package's version)
3737
# - "patch" (if you want to bump the patch part of the package's version)
3838
# - an exact version with major, minor, and patch parts (e.g. "1.2.3")
39+
# - "intentionally-skip" (if you want to skip releasing this package)
3940
#
4041
# When you're finished, save this file and close it. The tool will update the
4142
# versions of the packages you've listed and will move the changelog entries to
@@ -51,10 +52,19 @@ packages:
5152
5253
Select your packages alongside their version specifier, then save and close your `$EDITOR`.
5354

55+
If a package is not going to be released, mark it as `intentionally-skip` instead of removing it from the list.
56+
5457
Update each package's CHANGELOGs (the one you selected) and update them the usual
5558
way and commit those changes.
5659

5760
> [!IMPORTANT]
5861
> Your PR **HAS TO BE NAMED**: `release: x.y.z`
5962
>
60-
> The CI will use this commit name when finalizing/publishing the release to NPM.
63+
> The [CI workflow](https://github.com/MetaMask/accounts/blob/f194ce6fd8a1c7383ef5d74ca30d6d33fe6bfcec/.github/workflows/main.yml#L64) uses this commit name to detect release commits and trigger publishing to NPM.
64+
65+
## Handling Release Errors
66+
67+
If the release process errors out because of CHANGELOG validation issues, follow these steps:
68+
69+
1. Correct the CHANGELOG entries that caused the error
70+
2. Run `yarn create-release-branch` to continue the release process

0 commit comments

Comments
 (0)