Skip to content

Commit 4b3c372

Browse files
committed
Update release instructions in CONTRIBUTING.md
1 parent bfc5514 commit 4b3c372

File tree

1 file changed

+11
-18
lines changed

1 file changed

+11
-18
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -357,25 +357,18 @@ To build a new version and release it on NPM, follow these steps:
357357
1. Verify that the version number is already set correctly for the release. (It should have been incremented after releasing the previous version.)
358358
1. Create a PR to update `CHANGELOG.md`, removing the "(Unreleased)" for the version to be released.
359359
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 (check https://cdn.rescript-lang.org/ after the build completes).
361-
1. Download the `npm-packages.zip` artifact for the tag build from the Github Actions page.
362-
1. Extract `npm-packages.zip` to get the package tarballs to publish.
363-
1. Run the publish commands with `--dry-run` to see if everything (especially the version number) looks good:
364-
```sh
365-
# Use the tag "next" when publishing an alpha/beta version.
366-
npm publish rescript-<version>.tgz [--tag next] --dry-run
367-
npm publish rescript-std-<version>.tgz [--tag next] --dry-run
368-
```
369-
1. Publish for real:
370-
```sh
371-
# Use the tag "next" when publishing an alpha/beta version.
372-
npm publish rescript-<version>.tgz [--tag next]
373-
npm publish rescript-std-<version>.tgz [--tag next]
374-
```
360+
1. This triggers a tag build that will upload the playground bundle to KeyCDN and publish the `rescript` and `@rescript/std` npm packages with the tag "ci".
361+
1. Verify that the playground bundle for the new version is now present on https://cdn.rescript-lang.org/.
362+
1. Run `npm info rescript` to verify that the new version is now present with tag "ci".
363+
1. Test the new version.
364+
1. Tag the new version as appropriate (`latest` or `next`):
365+
- `npm dist-tag add rescript@<version> <tag>`
366+
- `npm dist-tag add @rescript/std@<version> <tag>`
375367
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)"
368+
1. Create a PR with the following changes to prepare for development of the next version:
369+
- Increment the version number in `package.json` for the next version.
370+
- Run `node scripts/setVersion.js` to take that version number over into other files.
371+
- Update `CHANGELOG.md` and add an entry for the next version, e.g., "10.0.0-beta.2 (Unreleased)"
379372
1. Coordinate any forum/blog posts with [@ryyppy](https://github.com/ryyppy).
380373

381374
## Debugging issues from CI builds

0 commit comments

Comments
 (0)