Add updated Git/Github release management process for Celo Core Contracts #5212
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
nambrot
commented
Sep 28, 2020
|
|
||
| Changes to core smart contracts are made via on-chain Governance, approximately four times a year. When a release is made, **all** smart contracts from the release branch that differ from the deployed smart contracts are released, and included in the **same** governance proposal. | ||
| Every deployed Celo core contract has its current version number as a constant which is publicly accessible via the `getVersion()` function, which returns the storage, major, minor, and patch version. Version number is encoded in the Solidity source and updated as part of code changes. |
There was a problem hiding this comment.
I moved this paragraph back up since it seemed closer related to the versioning paragraph above
ewilz
reviewed
Sep 28, 2020
|
|
||
| ### Github tags | ||
| All release branches should be tagged as such, e.g. `celo-contracts-N`. Each should include a summary of the release contents. | ||
| When a release is getting proposed on a Baklava/Alfajores/Mainnet, the commit that was used (which should be the latest release candidate) should be tagged with `celo-core-contracts-v${N}.(baklava | alfajores | mainnet)`. |
There was a problem hiding this comment.
If we're deploying the same upgrade, why do we need a branch for each network? How will the code differ between these branches?
There was a problem hiding this comment.
So these wouldn't be branches, but tags. As you point out, they would likely point to the same commit. This would just be a way to people to look up which environment has which commit deployed.
ewilz
approved these changes
Sep 28, 2020
ewilz
pushed a commit
to ewilz/celo-monorepo
that referenced
this pull request
Sep 29, 2020
…acts (celo-org#5212) * Add updated Git/Github release management process * Minor
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
This PR contains an updated and more detailed process around Git branches/tags and Github releases