Update PATCH_RELEASE_TEMPLATE.md
Gus Eggert committed
Mar 16, 2022 at 17:50 UTC
bc33ed4c3503be721e1ae44f2744accfeddc1bf2
1 file changed
+7
-4
docs/PATCH_RELEASE_TEMPLATE.md
+7
-4
@@ -2,12 +2,15 @@
2
3
This process handles patch releases from version `vX.Y.Z` to `vX.Y.Z+1` assuming that `vX.Y.Z` is the latest released version of go-ipfs.
4
5
+- [ ] Get temporary permissions to force-push to `release-*` branches
6
- [ ] Fork a new branch (`release-vX.Y.Z`) from `release` and cherry-pick the relevant commits from master (or custom fixes) onto this branch
6
-- [ ] Make a minimal changelog update tracking the relevant fixes to CHANGELOG.
7
-- [ ] version string in `version.go` has been updated (in the `release-vX.Y.Z+1` branch).
7
+ - [ ] Use `git cherry-pick -x` so that the commit message says `(cherry picked from commit ...)`
8
+- [ ] Make a minimal changelog update tracking the relevant fixes to CHANGELOG, as its own commit e.g. `docs: update changelog vX.Y.Z+1`
9
+- [ ] version string in `version.go` has been updated (in the `release-vX.Y.Z+1` branch), as its own commit.
10
- [ ] Make a PR merging `release-vX.Y.Z+1` into the release branch
9
-- [ ] tag the merge commit in the `release` branch with `vX.Y.Z+1`
10
-- [ ] upload to dist.ipfs.io
11
+ - This may be unnecessary, e.g. for backports
12
+- [ ] Tag the merge commit in the `release` branch with `vX.Y.Z+1` (ensure the tag is signed)
13
+- [ ] Upload to dist.ipfs.io
14
1. Build: https://github.com/ipfs/distributions#usage.
15
2. Pin the resulting release.
16
3. Make a PR against ipfs/distributions with the updated versions, including the new hash in the PR comment.