You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/RELEASE_ISSUE_TEMPLATE.md
+25-28
Original file line number
Diff line number
Diff line change
@@ -34,45 +34,42 @@ As usual, this release includes important fixes, some of which may be critical f
34
34
35
35
## ✅ Release Checklist
36
36
37
-
For each RC published in each stage:
38
-
39
-
- version string in `version.go` has been updated (in the `release-vX.Y.Z` branch).
40
-
- new commits should be added to the `release-vX.Y.Z` branch from `master` using `git cherry-pick -x ...`
41
-
- Note: `release-` branches are protected. You can do all needed updates on a separated branch and when everything is settled push to `release-vX.Y.Z`
42
-
- tag commit with `vX.Y.Z-rcN`
43
-
- add artifacts to https://dist.ipfs.tech
44
-
1. Make a PR against [ipfs/distributions](https://github.com/ipfs/distributions) with local changes produced by `add-version` (see [usage](https://github.com/ipfs/distributions#usage))
45
-
2. Wait for PR to build artifacts and generate diff (~30min)
46
-
3. Inspect results, merge if CI is green and the diff looks ok
47
-
4. Wait for `master` branch to build and update DNSLink at https://dist.ipfs.tech (~30min)
48
-
- cut a pre-release on [github](https://github.com/ipfs/kubo/releases) and reuse signed artifacts from https://dist.ipfs.tech/kubo (upload the result of the ipfs/distributions build in the previous step).
49
-
- Announce the RC:
50
-
-[ ] Create a new post on [IPFS Discourse](https://discuss.ipfs.tech)
51
-
- This will automatically post to IPFS Discord #ipfs-chatter
52
-
- Examples from the past: [0.14.0](https://discuss.ipfs.io/t/kubo-formerly-go-ipfs-v0-14-0-release-is-out/14794)
53
-
-[ ] Pin the topic. You need to be part of the [admin group](https://discuss.ipfs.tech/g/admins) for that.
54
-
-[ ] To the _early testers_ listed in [docs/EARLY_TESTERS.md](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md). Do this by copy/pasting their GitHub usernames and checkboxes as a comment so they get a GitHub notification. ([example](https://github.com/ipfs/go-ipfs/issues/8176#issuecomment-909356394))
55
-
56
37
Checklist:
57
38
58
-
-[ ]**Stage -1 - Prerequisites**
39
+
-[ ]**Stage 0 - Prerequisites**
59
40
-[ ] Ensure that the `What's left for release` section has all the checkboxes checked. If that's not the case, discuss the open items with Kubo maintainers and update the release schedule accordingly.
60
-
-[ ]**Stage 0 - Automated Testing**
41
+
-[ ]**Stage 1 - Initial Preparations**
61
42
-[ ] Upgrade to the latest patch release of Go that CircleCI has published (currently used version: `1.19.1`)
62
43
-[ ] See the list here: https://hub.docker.com/r/cimg/go/tags
-[ ] Fork a new branch (`release-vX.Y.Z`) from `master` and make any further release related changes to this branch. If any "non-trivial" changes (see the footnotes of [docs/releases.md](https://github.com/ipfs/go-ipfs/tree/master/docs/releases.md) for a definition) get added to the release, uncheck all the checkboxes and return to this stage.
66
-
-[ ] Follow the RC release process to cut the first RC.
67
-
-[ ] Bump the version in `version.go` in the `master` branch to `vX.(Y+1).0-dev`.
46
+
-[ ] Fork a new branch (`release-vX.Y.Z`) from `master`.
47
+
-[ ] Bump the version in `version.go` in the `master` branch to `vX.(Y+1).0-dev`.
48
+
-[ ]**Stage 2 - Release Candidate** - _if any [non-trivial](docs/releases.md#footnotes) changes need to be included in the release, return to this stage_
49
+
-[ ] Bump the version in `version.go` in the `release-vX.Y.Z` branch to `vX.Y.Z-rcN`.
50
+
-[ ] If applicable, add new commits to the `release-vX.Y.Z` branch from `master` using `git cherry-pick -x ...`
51
+
- Note: `release-*` branches are protected. You can do all needed updates on a separated branch (e.g. `wip-release-vX.Y.Z`) and when everything is settled push to `release-vX.Y.Z`
52
+
-[ ] Tag HEAD `release-vX.Y.Z` commit with `vX.Y.Z-rcN` (`git tag -s vX.Y.Z-rcN"`)
53
+
-[ ] Push the `release-vX.Y.Z` branch to GitHub (`git push origin release-vX.Y.Z`).
54
+
-[ ] Push the `vX.Y.Z-rcN` tag to GitHub (`git push origin vX.Y.Z-rcN`; DO NOT USE `git push --tags` because it pushes all your local tags).
55
+
-[ ] Add artifacts to https://dist.ipfs.tech by making a PR against [ipfs/distributions](https://github.com/ipfs/distributions) with local changes produced by `add-version` (see [usage](https://github.com/ipfs/distributions#usage))
56
+
-[ ] Wait for PR to build artifacts and generate diff (~30min)
57
+
-[ ] Inspect results, merge if CI is green and the diff looks ok
58
+
-[ ] Wait for `master` branch to build and update DNSLink at https://dist.ipfs.tech (~30min)
59
+
-[ ] Cut a pre-release on [GitHub](https://github.com/ipfs/kubo/releases) and reuse signed artifacts from https://dist.ipfs.tech/kubo (upload the result of the `ipfs/distributions` build from the previous step).
60
+
-[ ] Announce the RC
61
+
-[ ] Create a new post on [IPFS Discourse](https://discuss.ipfs.tech). This will automatically post to IPFS Discord #ipfs-chatter. Examples from the past: [0.14.0](https://discuss.ipfs.io/t/kubo-formerly-go-ipfs-v0-14-0-release-is-out/14794)
62
+
-[ ] Pin the topic. You need to be part of the [admin group](https://discuss.ipfs.tech/g/admins) for that.
63
+
-[ ] To the _early testers_ listed in [docs/EARLY_TESTERS.md](https://github.com/ipfs/go-ipfs/tree/master/docs/EARLY_TESTERS.md). Do this by copy/pasting their GitHub usernames and checkboxes as a comment to the release issue so they get a GitHub notification. ([example](https://github.com/ipfs/go-ipfs/issues/8176#issuecomment-909356394))
64
+
-[ ]**Stage 3 - Automated Testing**
68
65
-[ ] Automated Testing (already tested in CI) - Ensure that all tests are passing, this includes:
69
66
-[ ] unit, sharness, cross-build, etc (`make test`)
Copy file name to clipboardexpand all lines: docs/releases.md
+3
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@
16
16
-[Security Fix Policy](#security-fix-policy)
17
17
-[Performing a Release](#performing-a-release)
18
18
-[Release Version Numbers (aka semver)](#release-version-numbers-aka-semver)
19
+
-[_Footnotes_](#footnotes)
19
20
20
21
## Release Philosophy
21
22
@@ -112,5 +113,7 @@ We do not yet retroactively apply fixes to older releases (no Long Term Support
112
113
113
114
----------------------------
114
115
116
+
## _Footnotes_
117
+
115
118
- <sup>**[1]**</sup> - _early testers_ is an IPFS programme in which members of the community can self-volunteer to help test `kubo` Release Candidates. You find more info about it at [EARLY_TESTERS.md](./EARLY_TESTERS.md)
116
119
- <sup>**[2]**</sup> - A non-trivial change is any change that could potentially introduce an issue not trivially caught by automated testing. This is up to the discretion of the Lead Maintainer but the assumption is that every change is non-trivial unless proven otherwise.
0 commit comments