Skip to content

Commit 678aa69

Browse files
committed
docs: clarify release checklist
1 parent 8219d5c commit 678aa69

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,15 @@ View the coverage report locally by opening `coverage/index.html` in your browse
8383

8484
Only maintainers can make releases. Releases to [npm](https://www.npmjs.com) are automated using GitHub actions. To make a release, perform the following steps:
8585

86-
1. Update the version using npm, `npm version`. This will update the version in the `package.json` file and create a git tag. E.g.:
86+
1. Update `CHANGELOG.md` with a new entry describing the release.
87+
2. Update the version using npm, `npm version`. This will update the version in the `package.json` file and create a git tag. E.g.:
8788

8889
- `npm version patch`
8990
- `npm version prerelease` (for pre-releases)
9091

91-
2. Push the tag to GitHub: `git push origin main --tags`
92-
3. If the tests pass, GitHub actions will now publish the new version to npm.
93-
4. When successful add [release notes](https://github.com/transloadit/node-sdk/releases).
94-
5. If this was a pre-release, remember to run this to reset the [npm `latest` tag](https://www.npmjs.com/package/transloadit?activeTab=versions) to the previous version (replace `x.y.z` with previous version):
92+
3. Push the tag to GitHub: `git push origin main --tags`
93+
4. If the tests pass, GitHub actions will now publish the new version to npm.
94+
5. When successful add [release notes](https://github.com/transloadit/node-sdk/releases).
95+
6. If this was a pre-release, remember to run this to reset the [npm `latest` tag](https://www.npmjs.com/package/transloadit?activeTab=versions) to the previous version (replace `x.y.z` with previous version):
9596

9697
- `npm dist-tag add transloadit@X.Y.Z latest`

0 commit comments

Comments
 (0)