Skip to content
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

Update release instructions and versioning process #5541

Merged
merged 3 commits into from
Jul 12, 2022
Merged

Update release instructions and versioning process #5541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
df938d0
Move version to top of package.json
cknitt Jul 11, 2022
752c61b
Run npm install to update version in package-lock.json, too
cknitt Jul 11, 2022
db898b3
Update release instructions
cknitt Jul 11, 2022
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: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,8 @@ 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. Coordinate any forum/blog posts with [@ryyppy](https://github.com/ryyppy).

## Contribution Licensing

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "rescript",
"version": "10.0.0-beta.2",
"devDependencies": {
"mocha": "^7.2.0",
"nyc": "^15.0.0",
Expand All @@ -22,7 +23,6 @@
"test-env-compiler": "RESCRIPT_FORCE_REBUILD=1 node scripts/install.js -use-env-compiler",
"coverage": "nyc --timeout=3000 --reporter=html mocha jscomp/test/*test.js && open ./coverage/index.html"
},
"version": "10.0.0-beta.2",
"description": "ReScript toolchain",
"files": [
"Changes.md",
Expand Down
5 changes: 4 additions & 1 deletion scripts/setVersion.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* This file is used only in dev time, feel free to use es6
*/
const fs = require("fs");
const path = require("path");
const { execSync } = require("child_process");

const packageSpec = JSON.parse(fs.readFileSync("./package.json", "utf8"));
const { version, name } = packageSpec;
Expand Down Expand Up @@ -48,3 +48,6 @@ let package_name = ref "${name}"
`,
"utf8"
);

// For some reason, the version number is also in npm's package-lock.json. This updates it.
execSync("npm i --ignore-scripts", { stdio: "inherit" });