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.

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

Document release process #583

Closed
7 tasks
shahankhatch opened this issue Jan 27, 2021 · 1 comment · Fixed by #588
Closed
7 tasks

Document release process #583

shahankhatch opened this issue Jan 27, 2021 · 1 comment · Fixed by #588

Comments

@shahankhatch
Copy link
Contributor

shahankhatch commented Jan 27, 2021

  • Update CONTRIBUTING.md
  • Move relevant pieces from CONTRIBUTING.md to a new RELEASING.md
  • Prepare checklist of tasks
  • Prepare release notes template
  • Include details of release/branch naming in order to trigger invariant checks
  • Add reproducible build sha256 hashes to release notes
  • Add reproducible build artifacts to release (build_report, and binaries)

Include following notes:

Commits go into main.

Check the replace line in go.mod file of the cosmos-sdk for something like:
https://github.com/cosmos/cosmos-sdk/blob/master/go.mod

replace github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.3-alpha.regen.1

And ensure that the latest version is also being used in Gaia.

Cherry-pick commits from main into the long-lived release/vn.n.x branch, e.g., release/v3.0.x. It’s also okay to create a long-lived branch from main if the last commit is the release commit.

Ensure you have checked out the commit you wish to tag.

git tag -a v3.0.1 -m 'Release v3.0.1'
-- optional, add the -s tag to create a signed commit using your PGP key (which should also be added to github)

Maybe do this before tagging:
git pull --tags --dry-run
git pull --tags

git push --tags --dry-run
git push --tags

Go to gaia repo and create a release from the newly minted tag.
Title: v3.0.1
Description: Release notes using the following template (see at the end of the doc for additional notes on potential changes to changelog management):

Gaia v.3.0.1 Release Notes
This release includes bug fixes from the Cosmos SDK and Tendermint.
This release also introduces important security patches.
No breaking changes are introduced, but users are encouraged to use this release when upgrading their networks to Gaia v3.
See the Cosmos SDK v0.40.1 Release for details.

make build-reproducable
@shahankhatch shahankhatch linked a pull request Jan 28, 2021 that will close this issue
11 tasks
@shahankhatch
Copy link
Contributor Author

Perhaps add some notes on the ability to skip checks?
https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-status-checks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant