From a88c0852788eaea080672d69b6358e3af4ad9846 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Garc=C3=ADa=20Aubert?= Date: Sun, 1 Dec 2019 19:03:47 +0100 Subject: [PATCH] Update 'how to release' document --- HOW_TO_RELEASE.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 HOW_TO_RELEASE.md diff --git a/HOW_TO_RELEASE.md b/HOW_TO_RELEASE.md new file mode 100644 index 00000000..df017f17 --- /dev/null +++ b/HOW_TO_RELEASE.md @@ -0,0 +1,16 @@ +How to release: + +1. Test (npm test), fix if broken before proceeding. +2. Ensure proper version in `package.json` and `package-lock.json`. +3. Ensure NEWS section exists for the new version, review it, add release date. +4. If there are modified dependencies in `package.json`, update them with `npm upgrade {{package_name}}@{{version}}`. +5. Commit `package.json`, `package-lock.json`, NEWS. +6. Run `git tag -a Major.Minor.Patch`. Use NEWS section as content. +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.' are kept for any critical fix that might need to be shipped before next feature release is ready.