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

Docs: adding release process to README.md #2726

Merged
merged 11 commits into from
Jul 6, 2021
Merged

Conversation

kantai
Copy link
Member

@kantai kantai commented Jun 21, 2021

This adds a description of the release process to README.md for non-consensus-breaking releases.

Tagging @gregorycoppola, @jcnelson, @pavitthrap, @lgalabru, @reedrosenbluth, @CharlieC3, @wileyj for input -- if you'd like to make changes, please feel free to push commits to this branch!

@@ -71,15 +71,15 @@ The SIPs are now located in the [stacksgov/sips](https://github.com/stacksgov/si

- [x] **Helium** is a developer local setup, mono-node, assembling SIP 001, SIP 002, SIP 004 and SIP 005. With this version, developers can not only run Stacks 2.0 on their development machines, but also write, execute, and test smart contracts. See the instructions below for more details.

- [X] **Neon** is the first version of our public testnet, which shipped in Q2 2020. This testnet added SIP 003, and will be an open-membership public network, where participants will be able to validate and participate in mining testnet blocks.
- [x] **Neon** is the first version of our public testnet, which shipped in Q2 2020. This testnet added SIP 003, and will be an open-membership public network, where participants will be able to validate and participate in mining testnet blocks.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is part of this change.. but are all of these networks up still? Is this for historical reference? I wasn't sure when reading it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Old docs like this definitely needs to be scrubbed, but for the sake of getting this merged sooner it should probably be part of another PR. Maybe @pgray-hiro is able to help here?

These changes in particular were just from Prettier in my IDE.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree this change is out of scope for this PR - I can help update these in a separate one.

README.md Show resolved Hide resolved
1. Once all `2.1.x.y.z-blocker` PRs have been merged to `develop`, the release
manager will open a `develop -> master` PR.
1. Immediately following this, the release manager will then create a new tag
by manually triggering the [`stacks-blockchain` Github Actions workflow](https://github.com/blockstack/stacks-blockchain/actions/workflows/stacks-blockchain.yml)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this by clicking "Run Workflow"? Maybe you can add some text or even optionally a picture.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added more specificity in 2279149


1. Once the final release candidate has rolled out successfully without issue on the
above staging infrastructure, the release manager tags 2 additional `stacks-blockchain`
team members to review the `develop -> master` PR.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From experience, I find useful to draft that PR early on (one of the very first steps). It helps the release manager getting a good understanding of the deltas for the incoming release, and target testing on specific areas. WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think that's a good idea, will add.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@gregorycoppola gregorycoppola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for doing this.

I put a note about saying how to pick the version number but can be in a follow up, or in this one.

@kantai kantai requested a review from jcnelson July 1, 2021 22:56
Copy link
Member

@jcnelson jcnelson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Member

@CharlieC3 CharlieC3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@kantai kantai merged commit 7b6d3ee into develop Jul 6, 2021
@kantai kantai deleted the feat/doc-release-process branch July 6, 2021 21:53
@blockstack-devops
Copy link
Contributor

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@stacks-network stacks-network locked as resolved and limited conversation to collaborators Nov 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants