-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
12 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |