Skip to content

Commit 65e9888

Browse files
committed
CONTRIBUTING.md: update release instructions
1 parent 8b5486f commit 65e9888

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -354,11 +354,11 @@ Note that there is one design goal to keep in mind, never introduce any meaningl
354354

355355
To build a new version and release it on NPM, follow these steps:
356356

357-
1. Increment the version number in `package.json`.
358-
1. Run `node scripts/setVersion.js` to take that version number over into other files.
359-
1. Update `CHANGELOG.md`.
360-
1. Create a PR.
361-
1. Once that PR is merged, download the `npm-packages.zip` artifact for that commit from the Github Actions page.
357+
1. Verify that the version number is already set correctly for the release. (It should have been incremented after releasing the previous version.)
358+
1. Create a PR to update `CHANGELOG.md`, removing the "(Unreleased)" for the version to be released.
359+
1. Once that PR is merged and built successfully, tag the commit with the version number (e.g., "v10.0.0", or "v10.0.0-beta.1") and push the tag.
360+
1. Verify that this triggers a tag build, and that the playground bundle is uploaded to the CDN as part of the build.
361+
1. Download the `npm-packages.zip` artifact for the tag build from the Github Actions page.
362362
1. Extract `npm-packages.zip` to get the package tarballs to publish.
363363
1. Run the publish commands with `--dry-run` to see if everything (especially the version number) looks good:
364364
```sh
@@ -372,8 +372,10 @@ To build a new version and release it on NPM, follow these steps:
372372
npm publish rescript-<version>.tgz [--tag next]
373373
npm publish rescript-std-<version>.tgz [--tag next]
374374
```
375-
1. Tag the commit with the version number (e.g., "10.0.0", or "10.0.0-beta.1") and push the tag.
376-
1. Create a release entry for that tag on the [Github Releases page](https://github.com/rescript-lang/rescript-compiler/releases), copying the changes from `CHANGELOG.md`.
375+
1. Create a release entry for the version tag on the [Github Releases page](https://github.com/rescript-lang/rescript-compiler/releases), copying the changes from `CHANGELOG.md`.
376+
1. Increment the version number in `package.json` for the next version.
377+
1. Run `node scripts/setVersion.js` to take that version number over into other files.
378+
1. Update `CHANGELOG.md` and add an entry for the next version, e.g., "10.0.0-beta.2 (Unreleased)"
377379
1. Coordinate any forum/blog posts with [@ryyppy](https://github.com/ryyppy).
378380

379381
## Debugging issues from CI builds

0 commit comments

Comments
 (0)