Skip to content

Commit 1c7fe8b

Browse files
authored
Merge pull request #109 from nodejs/mhdawson-patch-1
Add instructions for creating a release to the readme.
2 parents 3c141f8 + 83e6868 commit 1c7fe8b

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,25 @@ If you need to build lib/lexer.wat (optional) you must first install
456456
[wabt](https://github.com/WebAssembly/wabt) as a sibling folder to this
457457
project. The wat file is then build by running `make lib/lexer.wat`
458458

459+
### Creating a Release
460+
These are the steps to create and publish a release. You will need docker
461+
installed as well as having installed [wabt](https://github.com/WebAssembly/wabt)
462+
as outlined above:
463+
464+
- [ ] Figure out if the release should be semver patch, minor or major based on the changes since
465+
the last release and determine the new version.
466+
- [ ] Update the package.json version, and run a full build and test
467+
- npm install
468+
- npm run build
469+
- npm run test
470+
- [ ] Commit and tag the changes, pushing up to main and the tag
471+
- For example
472+
- `git tag -a 1.4.2 -m "1.4.2"`
473+
- `git push origin tag 1.4.2`
474+
- [ ] Create the GitHub release
475+
- [ ] Run npm publish from an account with access (asking somebody with access
476+
the nodejs-foundation account is an option if you don't have access.
477+
459478
### License
460479

461480
MIT

0 commit comments

Comments
 (0)