Add a Release Process for SDK #1803

jackzampolin · 2018-07-24T01:33:13Z

During a discussion with @jaekwon, @cwgoes, @ValarDragon, @jlandrews today we came up with a possible release checklist to start using when cutting SDK releases. I've added the process we agreed to in a document at docs/RELEASE_CHECKLIST.md. I think we should use this process (except the fuzz testing) for the v0.23 release as a test run.

This would mean we need to spend tomorrow using the Plain English test "script" to ensure the functionality of the release before cutting it. We would also need buy in on the CHANGELOG.md updates proposed in the release process.

Tagging @zmanian and @ebuchman for comment and feedback.

codecov · 2018-07-24T01:41:06Z

Codecov Report

Merging #1803 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1803   +/-   ##
========================================
  Coverage    63.46%   63.46%           
========================================
  Files          117      117           
  Lines         6927     6927           
========================================
  Hits          4396     4396           
  Misses        2276     2276           
  Partials       255      255

cwgoes · 2018-07-24T04:06:21Z

docs/RELEASE_PROCESS.md

+
+- [ ] 1. Decide on release designation (are we doing a patch, or minor version bump) and start a P.R. for the release
+- [ ] 2. Add commits/PRs that are desired for this release **that haven’t already been added to develop**
+- [ ] 3. Ensure that `CHANGELOG.md` contains links to issues/PRs for each item


This should be in the PR checklist, not the release checklist (the PR should reference the issues in the changelog entries to begin with)

I think this should be in the PR checklist as well, but we need to do a CHANGELOG.md check and clean during the release process as well. Maybe I combine #3 and #4?

Also PENDING.md needs to be moved to CHANGELOG.md - combining 3/4 sounds good.

PENDING.md?

We now use PENDING.md for the pending changelog entries to avoid confusion for older PRs.

cwgoes · 2018-07-24T04:06:55Z

docs/RELEASE_PROCESS.md

+### `cosmos/cosmos-sdk` Release Process
+
+- [ ] 1. Decide on release designation (are we doing a patch, or minor version bump) and start a P.R. for the release
+- [ ] 2. Add commits/PRs that are desired for this release **that haven’t already been added to develop**


What might these be? Do you mean updating version/version.go?

I don't know. This addition was at the request of @jaekwon

Hmm OK, let's clarify.

@jaekwon can you clarify the above? ☝️

I think we want to keep this as optional for stuff like version/version.go or CHANGELOG.md that might need fixing in the release branch?

I'm thinking that we merge PRs into develop during our normal develop process, then when it comes time to release, we create a release meta-PR forked off of develop that further merges remaining PRs. Maybe this isn't what we should be doing?

I guess I just don't understand what the "remaining PRs" would be - why would we merge a PR to a release branch if we hadn't already merged and tested it on develop? Did you have an example in mind?

cwgoes · 2018-07-24T04:07:18Z

docs/RELEASE_PROCESS.md

+- [ ] 1. Decide on release designation (are we doing a patch, or minor version bump) and start a P.R. for the release
+- [ ] 2. Add commits/PRs that are desired for this release **that haven’t already been added to develop**
+- [ ] 3. Ensure that `CHANGELOG.md` contains links to issues/PRs for each item
+- [ ] 4. Summarize breaking API changes section under “Breaking Changes” section to the `CHANGELOG.md` to bring attention to any breaking API changes that affect RPC consumers


Can we come up with a format for this in coordination with Voyager to make sure we're communicating clearly?

Brainstorming:

### Breaking Changes #### API - Validator struct changed. Renamed `slashes` to `punishments` - Affected endpoints: - /validatorsets - /stake/candidates #### CLI - Renamed delegation cmd `gaiacli stake delegation -> gaiacli stake bond`

Like this!!

cwgoes · 2018-07-24T04:08:53Z

docs/RELEASE_PROCESS.md

@@ -0,0 +1,11 @@
+### `cosmos/cosmos-sdk` Release Process
+
+- [ ] 1. Decide on release designation (are we doing a patch, or minor version bump) and start a P.R. for the release


I think we might need a different procedure for hotfixes (namely, we might want to backport a fix to an older release)

Yeah I think hotfix is a usecase we didn't solve for with this process.

I think we should have a hotfix procedure which may be (I hope 🤞) be out of scope for this PR.

I think a hotfix release should in scope cause we need to differentiate what parts of the checklist we keep.

Hotfixes should have less testing before they go out.

We don't need to several days of internal testnets.

We do need to fire a testnet and run some transactions

We're about to do a hotfix tomorrow (as per @cwgoes comment about cherry-picking 2 commits for 0.23) so lets figure it out tomorrow.

alexanderbez · 2018-07-24T12:00:18Z

docs/RELEASE_PROCESS.md

+- [ ] 4. Summarize breaking API changes section under “Breaking Changes” section to the `CHANGELOG.md` to bring attention to any breaking API changes that affect RPC consumers
+- [ ] 5. Tag the commit `{{ .Release.Name }}-rcN`
+- [ ] 6. Kick off 1 day of automated fuzz testing
+- [ ] 7. Release Lead assigns 2 people to perform buddy testing script


Should we elaborate more on what this actual testing entails? (6 and 7)

I would like to get the buddy testing script in a place where we can merge it in here and link directly to it.

Once we have that finalized, can we put that in the repo somewhere? It'd be nice for everything to be in one place I think.

jackzampolin · 2018-07-24T23:28:09Z

I've gone ahead and addressed the PR comments. I also made a change in .github/PULL_REQUEST_TEMPLATE.md to prompt PR authors to add links in the PENDING.md file. The only thing that would be blocking here is final agreement on the manual testing script. I would then add that in here under docs/MANUAL_SCRIPT.md with links to the proper documentation.

If that is not desired, then we can go ahead and merge this as is.

Would love reviews @ebuchman !

ebuchman

Dope!

Add docs/RELEASE_PROCESS.md

5ea0aad

jackzampolin requested review from jbibla and zramsay as code owners July 24, 2018 01:33

jackzampolin mentioned this pull request Jul 24, 2018

Release v0.23.0 #1769

Merged

8 tasks

cwgoes reviewed Jul 24, 2018

View reviewed changes

cwgoes added the ready-for-review label Jul 24, 2018

alexanderbez reviewed Jul 24, 2018

View reviewed changes

Address PR comments

ffa6755

jackzampolin requested review from ebuchman and rigelrozanski as code owners July 24, 2018 23:11

ebuchman approved these changes Jul 26, 2018

View reviewed changes

ebuchman merged commit 12ef51d into cosmos:develop Jul 26, 2018

jackzampolin deleted the jack/release-process branch July 26, 2018 21:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a Release Process for SDK #1803

Add a Release Process for SDK #1803

jackzampolin commented Jul 24, 2018

codecov bot commented Jul 24, 2018 •

edited

Loading

cwgoes Jul 24, 2018

jackzampolin Jul 24, 2018

cwgoes Jul 24, 2018

jackzampolin Jul 24, 2018

cwgoes Jul 24, 2018

jackzampolin Jul 24, 2018

cwgoes Jul 24, 2018

jackzampolin Jul 24, 2018

cwgoes Jul 24, 2018

jackzampolin Jul 24, 2018

jackzampolin Jul 24, 2018

jaekwon Jul 25, 2018

cwgoes Jul 25, 2018 •

edited

Loading

cwgoes Jul 24, 2018

faboweb Jul 24, 2018

jackzampolin Jul 24, 2018

cwgoes Jul 24, 2018

jackzampolin Jul 24, 2018

jackzampolin Jul 24, 2018 •

edited

Loading

zmanian Jul 24, 2018

jaekwon Jul 25, 2018

alexanderbez Jul 24, 2018

jackzampolin Jul 24, 2018

ValarDragon Jul 24, 2018

jackzampolin commented Jul 24, 2018 •

edited

Loading

ebuchman left a comment

		@@ -0,0 +1,11 @@
		### `cosmos/cosmos-sdk` Release Process

		- [ ] 1. Decide on release designation (are we doing a patch, or minor version bump) and start a P.R. for the release

Add a Release Process for SDK #1803

Add a Release Process for SDK #1803

Conversation

jackzampolin commented Jul 24, 2018

codecov bot commented Jul 24, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwgoes Jul 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jackzampolin Jul 24, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jackzampolin commented Jul 24, 2018 • edited Loading

ebuchman left a comment

Choose a reason for hiding this comment

codecov bot commented Jul 24, 2018 •

edited

Loading

cwgoes Jul 25, 2018 •

edited

Loading

jackzampolin Jul 24, 2018 •

edited

Loading

jackzampolin commented Jul 24, 2018 •

edited

Loading