Skip to content

Update release instructions; Changes.md -> CHANGELOG.md #5652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2022
Merged

Update release instructions; Changes.md -> CHANGELOG.md #5652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ ninja/
syntax/
ocaml-tree/
_opam
Changes.md
CHANGELOG.md
README.md
playground/
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,8 +392,8 @@ To build a new version and release it on NPM, follow these steps:

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

## Contribution Licensing
Expand Down