coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-03-02 14:58:03 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs: enrich release issue template with initial set of mage commands

Browse Source
This commit is contained in:
Piotr Galar 2022-12-13 10:58:37 +01:00 committed by GitHub
parent 71b098e25f
commit 1ca3ea4a53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/RELEASE_ISSUE_TEMPLATE.md
View File

@ -46,6 +46,7 @@ Checklist:
- [ ] Mention @protocol/bifrost-team in the issue and let them know the expected date of the release
- Issue link:
- [ ] 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.
- `go run main.go kubo:issue:checkOutstandingTasks v0.18.0`
- [ ] 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.
- [ ] Link it in the "Meta" section above.
- [ ] 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,13 +70,18 @@ Checklist:
- [ ] [ipfs/kubo](https://github.com/ipfs/kubo): [example PR](https://github.com/ipfs/kubo/pull/8599)
- [ ] [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
- [ ] Fork a new branch (`release-vX.Y.Z`) from `master`.
- `go run main.go kubo:release:cutReleaseBranch v0.18.0`
- [ ] 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)).
- `go run main.go kubo:main:updateVersion v0.18.0`
- [ ] **Stage 2 - Release Candidate** - _if any [non-trivial](docs/releases.md#footnotes) changes need to be included in the release, return to this stage_
- [ ] If it's not a first RC, add new commits to the `release-vX.Y.Z` branch from `master` using `git cherry-pick -x ...`
- 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`
- [ ] Bump the version in `version.go` in the `release-vX.Y.Z` branch to `vX.Y.Z-rcN`.
- `go run main.go kubo:release:updateReleaseVersion v0.18.0-rc1`
- [ ] 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)).
- `go run main.go kubo:release:createReleasePR v0.18.0`
- [ ] Wait for CI to run and complete PR checks. All checks should pass.
- `go run main.go kubo:release:checkCI v0.18.0`
- [ ] Create a signed tag for the release candidate.
- [ ] 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.
- [ ] ⚠️ 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'`)