Update docs: Release management in Git/Github #5269
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ewilz
commented
Oct 5, 2020
| 1. A new release branch is created `release/celo-core-contracts/${N}` with the contracts to be audited. | ||
| 2. The latest commit on the release branch is tagged with `celo-core-contracts-v${N}.pre-audit`. | ||
| 3. On Github, a pre-release Github release should be created pointing at the latest tag on the release branch. | ||
| 4. On master branch, `.circleci/config.yml` should be edited so that the variable `RELEASE_TAG` points to the tag `celo-core-contracts-v${N}.pre-audit` so that all future changes to master are versioned against the new release. |
ewilz
commented
Oct 5, 2020
|
|
||
| After a completed release process: | ||
| 1. The release branch should be merged into `master` with a merge commit (instead of the usual squash merge strategy). | ||
| 2. On master branch, `.circleci/config.yml` should be edited so that the variable `RELEASE_TAG` points to the tag `celo-core-contracts-v${N}.mainnet` |
nambrot
approved these changes
Oct 5, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Update Release Process docs with git management for comparing versioned contracts
Other changes
change variable name to reflect new tag-oriented approach. slight reformat of entire section to be more checklist oriented.
Tested
N/A
Related issues
Backwards compatibility
yes