From 97e7fc4965b0879aa7c7d59f9460ef53df922935 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Thu, 30 Jan 2025 13:51:02 -0500 Subject: [PATCH 1/4] Add instructions for creating a release to the readme. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index cc7ca50..9474410 100755 --- a/README.md +++ b/README.md @@ -456,6 +456,21 @@ If you need to build lib/lexer.wat (optional) you must first install [wabt](https://github.com/WebAssembly/wabt) as a sibling folder to this project. The wat file is then build by running `make lib/lexer.wat` +### Creating a Release +These are the steps to create and publish a release. You will need docker +installed as well as having installed [wabt](https://github.com/WebAssembly/wabt) +as outlined above: + +- [ ] Update the package.json version, and run a full build and test + - npm install + - npm run build + - npm run test +- [ ] Commit and tag the changes, pushing up to main and the tag + - git tag -a 1.4.2 -m "1.4.2" +- [ ] Create the GitHub release +- [ ] Run npm publish from an account with access (asking somebody with access + the nodejs-foundation account is an option if you don't have access. + ### License MIT From 507b28341efe4f9c54874cf24681545b6e589406 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Thu, 30 Jan 2025 13:52:15 -0500 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9474410..7850b4f 100755 --- a/README.md +++ b/README.md @@ -466,7 +466,7 @@ as outlined above: - npm run build - npm run test - [ ] Commit and tag the changes, pushing up to main and the tag - - git tag -a 1.4.2 -m "1.4.2" + - For example - `git tag -a 1.4.2 -m "1.4.2"` - [ ] Create the GitHub release - [ ] Run npm publish from an account with access (asking somebody with access the nodejs-foundation account is an option if you don't have access. From baab700e400f796a1806b500ba40a58e013372ea Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Fri, 31 Jan 2025 11:54:12 -0500 Subject: [PATCH 3/4] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7850b4f..3e39475 100755 --- a/README.md +++ b/README.md @@ -461,6 +461,8 @@ These are the steps to create and publish a release. You will need docker installed as well as having installed [wabt](https://github.com/WebAssembly/wabt) as outlined above: +- [ ] Figure out if the release should be semver patch, minor or major based on the changes since + the last release and determine the new version. - [ ] Update the package.json version, and run a full build and test - npm install - npm run build From 83e68684632d049026246ff91f7be2088af9fcee Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Fri, 31 Jan 2025 12:03:39 -0500 Subject: [PATCH 4/4] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3e39475..addf5ed 100755 --- a/README.md +++ b/README.md @@ -468,7 +468,9 @@ as outlined above: - npm run build - npm run test - [ ] Commit and tag the changes, pushing up to main and the tag - - For example - `git tag -a 1.4.2 -m "1.4.2"` + - For example + - `git tag -a 1.4.2 -m "1.4.2"` + - `git push origin tag 1.4.2` - [ ] Create the GitHub release - [ ] Run npm publish from an account with access (asking somebody with access the nodejs-foundation account is an option if you don't have access.