@cryptotaxi247 / kubo / commits / c656952d7

Apply suggestions from the code review

galargh committed Oct 19, 2022 at 14:38 UTC c656952d789a24de8e1d87279430d8e39b90013a
1 file changed +16 -17
docs/RELEASE_ISSUE_TEMPLATE.md
+16 -17
@@ -41,6 +41,9 @@ As usual, this release includes important fixes, some of which may be critical f
41 Checklist:
42
43 - [ ] **Stage 0 - Prerequisites**
44 + - [ ] Open an issue against [bifrost-infra](https://github.com/protocol/bifrost-infra) ahead of the release ([example](https://github.com/protocol/bifrost-infra/issues/2109)).
45 + - [ ] Spell out all that we want updated - gateways, the bootstraper and the cluster/preload nodes
46 + - [ ] Mention @protocol/bifrost-team in the issue and let them know the expected date of the release
47 - [ ] 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.
48 - [ ] Create `docs-release-vX.Y.Z` branch, open a draft PR and keep updating `docs/RELEASE_ISSUE_TEMPLATE.md` on that branch as you go.
49 - [ ] Ensure you have a [GPG key generated](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key) and [added to your GitHub account](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account). This will enable you to created signed tags.
@@ -69,9 +72,11 @@ Checklist:
72 - 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`
73 - [ ] Push the `release-vX.Y.Z` branch to GitHub (`git push origin release-vX.Y.Z`) and create a draft PR targetting `release` branch if it doesn't exist yet ([example](https://github.com/ipfs/kubo/pull/9306)).
74 - [ ] Wait for CI to run and complete PR checks. All checks should pass.
72 - - [ ] Tag HEAD `release-vX.Y.Z` commit with `vX.Y.Z-rcN` (`git tag -s vX.Y.Z-rcN -m 'Pre-release X.Y.Z-rcn'`)
73 - - [ ] Run `git show vX.Y.Z-rcN` to ensure the tag is correct.
74 - - [ ] 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).
75 + - [ ] Create a signed tag for the release candidate.
76 + - [ ] This is a dangerous operation, as it is difficult to reverse due to Go modules and automated Docker image publishing. Remember to verify the commands you intend to run for items marked with ⚠️ with the release reviewer.
77 + - [ ] ⚠️ Tag HEAD `release-vX.Y.Z` commit with `vX.Y.Z-rcN` (`git tag -s vX.Y.Z-rcN -m 'Pre-release X.Y.Z-rcn'`)
78 + - [ ] Run `git show vX.Y.Z` to ensure the tag is correct.
79 + - [ ] ⚠️ Push the `vX.Y.Z` tag to GitHub (`git push origin vX.Y.Z`; DO NOT USE `git push --tags` because it pushes all your local tags).
80 - [ ] Add artifacts to https://dist.ipfs.tech by making a PR against [ipfs/distributions](https://github.com/ipfs/distributions)
81 - [ ] Clone the `ipfs/distributions` repo locally.
82 - [ ] Create a new branch (`kubo-release-vX.Y.Z-rcn`) from `master`.
@@ -124,13 +129,12 @@ Checklist:
129 - [ ] Run [CI workflow](https://github.com/ipfs/ipfs-webui/actions/workflows/ci.yml) with `vX.Y.Z-rcN` for the `kubo-version` input.
130 - [ ] Ensure that CI is green.
131 - [ ] Infrastructure Testing.
127 - - [ ] Open an issue against [bifrost-infra](https://github.com/protocol/bifrost-infra) ([example](https://github.com/protocol/bifrost-infra/issues/2109)).
128 - - [ ] Spell out all that we want updated - gateways, the bootstraper and the cluster/preload nodes
129 - - [ ] Mention @protocol/bifrost-team in the issue if you opened it prior to the release
132 + - [ ] Update the issue against [bifrost-infra](https://github.com/protocol/bifrost-infra) ([example](https://github.com/protocol/bifrost-infra/issues/2109)).
133 + - [ ] Mention @protocol/bifrost-team in the issue to let them know the release is ready
134 - [ ] [Optional] Reply under a message about the issue in the #bifrost channel on FIL Slack once the RC is out. Send the message to the channel.
131 - - [ ] Check [metrics](https://protocollabs.grafana.net/d/8zlhkKTZk/gateway-slis-precomputed?orgId=1) every day.
132 - - Compare the metrics trends week over week.
133 - - If there is an unexpected variation in the trend, message the #bifrost channel on FIL Slack and ask for help investigation the cause.
135 + - [ ] Check [metrics](https://protocollabs.grafana.net/d/8zlhkKTZk/gateway-slis-precomputed?orgId=1) every day.
136 + - Compare the metrics trends week over week.
137 + - If there is an unexpected variation in the trend, message the #bifrost channel on FIL Slack and ask for help investigation the cause.
138 - [ ] IPFS Application Testing.
139 - [ ] [IPFS Desktop](https://github.com/ipfs-shipyard/ipfs-desktop)
140 - [ ] Upgrade to the RC in [ipfs-desktop](https://github.com/ipfs-shipyard/ipfs-desktop)
@@ -162,11 +166,10 @@ Checklist:
166 - [ ] Checkout the `release` branch locally.
167 - Remember to pull the latest changes.
168 - [ ] Create a signed tag for the release.
165 - - [ ] Have release reviewer review the subsequent tagging commits you intend to run.
166 - - This is a dangerous operation, as it is difficult to reverse due to Go modules and automated Docker image publishing
167 - - [ ] Tag HEAD `release` commit with `vX.Y.Z` (`git tag -s vX.Y.Z -m 'Release X.Y.Z'`)
169 + - [ ] This is a dangerous operation, as it is difficult to reverse due to Go modules and automated Docker image publishing. Remember to verify the commands you intend to run for items marked with ⚠️ with the release reviewer.
170 + - [ ] ⚠️ Tag HEAD `release` commit with `vX.Y.Z` (`git tag -s vX.Y.Z -m 'Release X.Y.Z'`)
171 - [ ] Run `git show vX.Y.Z` to ensure the tag is correct.
169 - - [ ] Push the `vX.Y.Z` tag to GitHub (`git push origin vX.Y.Z`; DO NOT USE `git push --tags` because it pushes all your local tags).
172 + - [ ] ⚠️ Push the `vX.Y.Z` tag to GitHub (`git push origin vX.Y.Z`; DO NOT USE `git push --tags` because it pushes all your local tags).
173 - [ ] Publish the release.
174 - [ ] Wait for [Publish docker image](https://github.com/ipfs/kubo/actions/workflows/docker-image.yml) workflow run initiated by the tag push to finish.
175 - [ ] Add artifacts to https://dist.ipfs.tech by making a PR against [ipfs/distributions](https://github.com/ipfs/distributions)
@@ -218,10 +221,6 @@ Checklist:
221 - [ ] Create an issue using this release issue template for the _next_ release.
222 - [ ] Close this release issue.
223
221 -## ⁉️ Do you have questions?
222 -
223 -The best place to ask your questions about IPFS, how it works and what you can do with it is at [discuss.ipfs.io](http://discuss.ipfs.io). We are also available at the `#ipfs` channel on Freenode, which is also [accessible through our Matrix bridge](https://riot.im/app/#/room/#freenode_#ipfs:matrix.org).
224 -
224 ## How to contribute?
225
226 Would you like to contribute to the IPFS project and don't know how? Well, there are a few places you can get started: