Skip to content

Commit f73d289

Browse files
authored
Update release instructions; Changes.md -> CHANGELOG.md (#5652)
1 parent 42c61fd commit f73d289

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

.prettierignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ ninja/
66
syntax/
77
ocaml-tree/
88
_opam
9-
Changes.md
9+
CHANGELOG.md
1010
README.md
1111
playground/

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -392,8 +392,8 @@ To build a new version and release it on NPM, follow these steps:
392392

393393
1. Increment the version number in `package.json`.
394394
1. Run `node scripts/setVersion.js` to take that version number over into other files.
395-
1. Snapshot (run ninja build to regenerate `whole_compiler.ml` etc.).
396-
1. Update `Changes.md`.
395+
1. Snapshot (run `make` to regenerate `whole_compiler.ml` etc.).
396+
1. Update `CHANGELOG.md`.
397397
1. Create a PR.
398398
1. Once that PR is merged, download the `npm-packages.zip` artifact for that commit from the Github Actions page.
399399
1. Extract `npm-packages.zip` to get the package tarballs to publish.
@@ -410,7 +410,7 @@ To build a new version and release it on NPM, follow these steps:
410410
npm publish rescript-std-<version>.tgz [--tag next]
411411
```
412412
1. Tag the commit with the version number (e.g., "10.0.0", or "10.0.0-beta.1") and push the tag.
413-
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 `Changes.md`.
413+
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`.
414414
1. Coordinate any forum/blog posts with [@ryyppy](https://github.com/ryyppy).
415415

416416
## Contribution Licensing

0 commit comments

Comments
 (0)