@cryptotaxi247 / kubo / commits / fe542db06

docs: add more automation commands to the release template

Piotr Galar committed Dec 13, 2022 at 16:55 UTC fe542db0617d5b20cca63bdee4cc70c1d30dac63
1 file changed +11 -8
docs/RELEASE_ISSUE_TEMPLATE.md
+11 -8
@@ -46,9 +46,9 @@ Checklist:
46 - [ ] Mention @protocol/bifrost-team in the issue and let them know the expected date of the release
47 - Issue link:
48 - [ ] 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.
49 - - `go run main.go kubo:issue:checkOutstandingTasks v0.18.0`
49 + - `go run main.go kubo:issue:checkOutstandingTasks v0.18.0`
50 - [ ] 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.
51 - - [ ] Link it in the "Meta" section above.
51 + - [ ] Link it in the "Meta" section above.
52 - [ ] 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.
53 - [ ] Ensure you have [admin access](https://discuss.ipfs.tech/g/admins) to [IPFS Discourse](https://discuss.ipfs.tech/). Admin access is required to globally pin posts and create banners. @2color might be able to assist you.
54 - [ ] Access to [#bifrost](https://filecoinproject.slack.com/archives/C03MMMF606T) channel in FIL Slack might come in handy. Ask the release reviewer to invite you over.
@@ -70,24 +70,26 @@ Checklist:
70 - [ ] [ipfs/kubo](https://github.com/ipfs/kubo): [example PR](https://github.com/ipfs/kubo/pull/8599)
71 - [ ] [ipfs/ipfs-docs](https://github.com/ipfs/ipfs-docs): [example PR](https://github.com/ipfs/ipfs-docs/pull/1298) - only if the major version changed
72 - [ ] Fork a new branch (`release-vX.Y.Z`) from `master`.
73 - - `go run main.go kubo:release:cutReleaseBranch v0.18.0`
73 + - `go run main.go kubo:release:cutReleaseBranch v0.18.0`
74 - [ ] Bump the version in `version.go` in the `master` branch to `vX.(Y+1).0-dev` via a PR ([example](https://github.com/ipfs/kubo/pull/9305)).
75 - - `go run main.go kubo:main:updateVersion v0.18.0`
75 + - `go run main.go kubo:main:updateVersion v0.18.0`
76 - [ ] **Stage 2 - Release Candidate** - _if any [non-trivial](docs/releases.md#footnotes) changes need to be included in the release, return to this stage_
77 - [ ] If it's not a first RC, add new commits to the `release-vX.Y.Z` branch from `master` using `git cherry-pick -x ...`
78 - - 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`
78 + - 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`
79 - [ ] Bump the version in `version.go` in the `release-vX.Y.Z` branch to `vX.Y.Z-rcN`.
80 - - `go run main.go kubo:release:updateReleaseVersion v0.18.0-rc1`
80 + - `go run main.go kubo:release:updateReleaseVersion v0.18.0-rc1`
81 - [ ] If it's a first RC, create a draft PR targetting `release` branch if it doesn't exist yet ([example](https://github.com/ipfs/kubo/pull/9306)).
82 - `go run main.go kubo:release:createReleasePR v0.18.0`
83 - [ ] Wait for CI to run and complete PR checks. All checks should pass.
84 - - `go run main.go kubo:release:checkCI v0.18.0`
84 + - `go run main.go kubo:release:checkReleaseCI v0.18.0`
85 - [ ] Create a signed tag for the release candidate.
86 - - [ ] 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.
86 + - `go run main.go kubo:release:createReleaseTag v0.18.0-rc1`
87 + - 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.
88 - [ ] ⚠️ 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'`)
89 - [ ] Run `git show vX.Y.Z-rcN` to ensure the tag is correct.
90 - [ ] ⚠️ 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).
91 - [ ] Add artifacts to https://dist.ipfs.tech by making a PR against [ipfs/distributions](https://github.com/ipfs/distributions)
92 + - `go run main.go dist:dist:createDistPR v0.18.0-rc1`
93 - [ ] Clone the `ipfs/distributions` repo locally.
94 - [ ] Create a new branch (`kubo-release-vX.Y.Z-rcn`) from `master`.
95 - [ ] Run `./dist.sh add-version kubo vX.Y.Z-rcN` to add the new version to the `versions` file ([instructions](https://github.com/ipfs/distributions#usage)).
@@ -99,6 +101,7 @@ Checklist:
101 - PR will be merged automatically once the diff is approved
102 - `master` build will publish the artifacts to https://dist.ipfs.io in around 30 minutes
103 - [ ] Ensure that the artifacts are available at https://dist.ipfs.io
104 + - `go run main.go dist:dist:checkIPFSTech v0.18.0-rc1`
105 - [ ] Publish the RC to [the NPM package](https://www.npmjs.com/package/go-ipfs?activeTab=versions) by running https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml (it happens automatically but it is safe to speed up the process and kick of a run manually)
106 - [ ] Cut a pre-release on [GitHub](https://github.com/ipfs/kubo/releases) ([instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release), [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0-rc1))
107 - Use `vX.Y.Z-rcN` as the tag.