branch: elpa/hyperdrive
commit 36cc7612fdecfb6ed7dfd542d8652f1fd4e496c8
Author: Adam Porter <a...@alphapapa.net>
Commit: Adam Porter <a...@alphapapa.net>
Docs: Update release checklists
---
CONTRIBUTING.org | 43 ++++++++++++++++++++++++++++++++++---------
1 file changed, 34 insertions(+), 9 deletions(-)
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
index d477ad1829..e4aa0317cf 100644
--- a/CONTRIBUTING.org
+++ b/CONTRIBUTING.org
@@ -25,25 +25,50 @@ As well, sometimes two keywords might be used together if
the lines between them
* Release checklist
-These steps should be followed when releasing a new version:
+These checklists should be followed when releasing new versions:
-1. Release new version.
+** Commit new pre-release
+:PROPERTIES:
+:ID: 5f7859bc-5f9b-4e35-806e-b727f492dade
+:END:
In ~master~ branch:
- 1. [ ] Update package main file header version (removing ~-pre~ suffix).
- 2. [ ] Update CHANGELOG (with release date and version).
- 3. [ ] Rebuild .texi manual.
+ 1. [ ] Update package main file header version (adding ~-pre~ suffix).
+ 2. [ ] Update CHANGELOG.
+ 3. [ ] Rebuild .texi manual (use ~pre-commit~ hook; see below).
4. [ ] Commit changes.
-2. Commit new pre-release.
+** Release new feature (or minor) version
In ~master~ branch:
- 1. [ ] Update package main file header version (adding ~-pre~ suffix).
- 2. [ ] Update CHANGELOG.
- 3. [ ] Rebuild .texi manual.
+ 1. [ ] Update package main file header version (removing ~-pre~ suffix).
+ 2. [ ] Update CHANGELOG (with release date and version).
+ 3. [ ] Rebuild .texi manual (use ~pre-commit~ hook; see below).
4. [ ] Commit changes.
+ 5. [ ] Merge ~master~ branch into ~stable~ branch.
+ 6. [ ] Make new git tag for new release (tagging the commit on ~stable~).
+ 7. [ ] Push ~master~ and ~stable~ branches to remote.
+ 8. [ ] Push git tags.
+ 9. [ ] [[id:5f7859bc-5f9b-4e35-806e-b727f492dade][Commit new pre-release]]
before adding more changes.
+
+** Release new bugfix version (when applying bug fixes to a stable release,
not to ~master~)
+
+ In ~stable~ branch:
+
+ 1. [ ] Update package main file header version (increment bugfix number
(i.e. the third number), adding ~-pre~ suffix).
+ 2. [ ] Commit fixes to code.
+ 3. [ ] Commit update to ~CHANGELOG~.
+ 4. [ ] Rebuild manual.
+ 5. [ ] Commit manual.
+ 6. [ ] Update package main file header version (removing ~-pre~ suffix).
+ 7. [ ] Commit changes.
+ 8. [ ] Make new git tag for new release.
+ 9. [ ] Push ~stable~ branch to remote.
+ 10. [ ] Merge ~stable~ branch back to ~master~.
+ 11. [ ] Push ~master~ branch to remote.
+ 12. [ ] Push git tags.
* Git hooks
