Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update release procedure #773

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update release procedure #773

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ Below are links of related/adjacent work that has informed some of the decisions
- [ ] Verify your [GPG signature](https://docs.github.com/en/authentication/managing-commit-signature-verification) is configured in local git and GitHub
- [ ] Ensure Boxo and Kubo are checked out on your system
- [ ] Create a release branch called `release-vX.Y.Z` and push it
* Use `master` as base if `Z == 0`
* Use `release` as base if `Z > 0`
* Use `main` as base if `Z == 0`
* Use `release-X.Y.Z-1` as base if `Z > 0`
- [ ] Tidy the changelog and push any changelog changes to `release-vX.Y.Z`
- [ ] Create a draft PR merging `release-vX.Y.Z` into `release`
- [ ] Create a draft PR merging `release-vX.Y.Z` into `main`
- [ ] Name it "Release vX.Y.Z"
- [ ] Reference this release issue
- [ ] If `Z > 0`, then cherry-pick the necessary commits from `master` into `release-vX.Y.Z` using `git cherry-pick -x <commit>`
Expand All @@ -82,14 +82,10 @@ Below are links of related/adjacent work that has informed some of the decisions
- [ ] Add a "release" label to the Boxo PR
- [ ] After the release checker creates a draft release, copy-paste the changelog into the draft
- [ ] Wait for approval from another Boxo maintainer
- [ ] Merge the PR into `release`, _using "Create a Merge Commit"_, and do not delete the `release-vX.Y.X` branch
- [ ] Merge the PR into `main`, _using "Create a Merge Commit"_, and do not delete the `release-vX.Y.X` branch
- [ ] Verify the tag is created
- [ ] Announce the release
- [ ] Click [this link](https://discuss.ipfs.tech/new-topic?title=Boxo%20vX.Y.Z%20is%20out%21&tags=boxo&category=News&body=%23%23%20Boxo%20vX.Y.Z%20is%20out%21%0A%0ASee%3A%0A-%20Code%3A%20https%3A%2F%2Fgithub.com%2Fipfs%2Fboxo%2Freleases%2Ftag%2FvX.Y.Z%0A-%20Release%20Notes%3A%20https%3A%2F%2Fgithub.com%2Fipfs%2Fboxo%2Fblob%2FvX.Y.Z%2FCHANGELOG.md) to start a new Discourse topic <!--docs: https://meta.discourse.org/t/create-a-link-to-start-a-new-topic-with-pre-filled-information/28074 -->
- [ ] Update `vX.Y.Z` in the title and body
- [ ] Create the topic
- [ ] Create a PR merging `release` into `main`
- [ ] Name it "Merge release vX.Y.Z"
- [ ] Wait for approval
- [ ] Merge it _using "Create a Merge Commit"_, and do not delete the `release` branch
- [ ] Update the Kubo PR to use the newly released version, mark it as "Ready for Review", get approval, and merge into Kubo
Loading