Skip to content

Commit

Permalink
Update How To Release doc
Browse files Browse the repository at this point in the history
  • Loading branch information
dgaubert committed May 13, 2020
1 parent 3b71421 commit 6e1a735
Showing 1 changed file with 12 additions and 19 deletions.
31 changes: 12 additions & 19 deletions HOWTO_RELEASE
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
1. Test (make clean all check), fix if broken before proceeding
2. Ensure proper version in package.json
3. Ensure NEWS section exists for the new version, review it, add release date
4. Commit package.json, NEWS
5. git tag -a Major.Minor.Patch # use NEWS section as content
6. Announce on [email protected]
7. Stub NEWS/package for next version

Versions:

Bugfix releases increment Patch component of version.
Feature releases increment Minor and set Patch to zero.
If backward compatibility is broken, increment Major and
set to zero Minor and Patch.

Branches named 'b<Major>.<Minor>' are kept for any critical
fix that might need to be shipped before next feature release
is ready.

# How to release

1. Test (`npm test`), fix if broken before proceeding.
2. Merge patch, feature to master.
3. Ensure proper version in `package.json` and `package-lock.json`.
4. Ensure `NEWS.md` section exists for the new version, review it, add release date.
5. Commit `package.json`, `package-lock.json`, NEWS.
6. Run `git tag -a Major.Minor.Patch`. Use NEWS section as content.
7. `npm publish` to registry.
8. Stub NEWS/package for next version.

Versions should follow http://semver.org/spec/v2.0.0.html.

0 comments on commit 6e1a735

Please sign in to comment.