You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/how-to-release.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,7 @@ You will then be prompted with your `$EDITOR` to select which packages you want
36
36
# - "minor" (if you want to bump the minor part of the package's version)
37
37
# - "patch" (if you want to bump the patch part of the package's version)
38
38
# - 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)
39
40
#
40
41
# When you're finished, save this file and close it. The tool will update the
41
42
# versions of the packages you've listed and will move the changelog entries to
@@ -51,10 +52,19 @@ packages:
51
52
52
53
Select your packages alongside their version specifier, then save and close your `$EDITOR`.
53
54
55
+
If a package is not going to be released, mark it as `intentionally-skip` instead of removing it from the list.
56
+
54
57
Update each package's CHANGELOGs (the one you selected) and update them the usual
55
58
way and commit those changes.
56
59
57
60
> [!IMPORTANT]
58
61
> Your PR **HAS TO BE NAMED**: `release: x.y.z`
59
62
>
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