Shepherd Core Contracts 8 Release

[arthurgousset]

Github issue to keep track checklist in Core Contracts release process.

T:

• @0xarthurxyz: Create a Github issue tracking all these checklist items as an audit log
  • This is it: Shepherd Core Contracts 8 Release #9711
• @0xarthurxyz: Implement the git management steps for when a new release branch is cut.

  • Release branch:

  • A new release branch is created release/core-contracts/${N} with the contracts to be audited.

  • there already exists a release/core-contracts/8 branch, but it's deprecated - can be deleted and a new one of the same name be created at your release branch. [~Source: @m-chrzan]

  • Commands used (for review):

    git push origin --delete release/core-contracts/8 # delete existing release/core-contracts/8 branch (advised by Martin)
    git checkout origin/ASv2 # moves to development branch
    git branch release/core-contracts/8 # creates release branch
    git checkout release/core-contracts/8 # moves to release branch
    git log # checks last commit on release branch is as expected
    git push origin release/core-contracts/8 # publishes release branch

    • this is the release branch: release/core-contracts/8 (cut from our development branch ASv2, last commit c1bd0574)

  • Tag commit:

  • The latest commit on the release branch is tagged with core-contracts.v${N}.pre-audit.

  • Commands used (for review):

    git log # check commits on release branch
    git show core-contracts.v8.pre-audit # checks if tag already exists (it does, Eela already tagged it)

    • this is the tag: core-contracts.v8.pre-audit for commit c1bd0574

  • Update config.yml:

  • 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. ~ Source: Git release management

  • On the release branch, it should remain core-contracts.v7. [~Source: @m-chrzan]

  • Commands used (for review):

    # currently on master branch in monorepo
    git branch 0xarthurxyz/modify-circleci-configyml-for-CoreContracts8Release # makes branch for my 1 line change
    git checkout 0xarthurxyz/modify-circleci-configyml-for-CoreContracts8Release # moves to my branch
    # made 1 line change
    # committed to my branch (in VS Code UI)
    # pushed my branch to remote (in VS Code UI)
    # created PR in Github UI

    • this is the PR: Mini PR: Sets RELEASE_TAG to core-contracts.v8.pre-audit in celo-monorepo/circleci/config.yml #9734

  • Pre-release notes:

  • On Github, a pre-release Github release should be created pointing at the latest tag on the release branch. ~ Source: Git release management

  • Followed official Github instructions here: Managing releases in a repository

    • this is the pre-release: Core Contracts Release 8
• @eelanagaraj: Submit release branch to a reputable third party auditor for review.
  • Completed with Hacken.io
• Begin drafting release notes.
  • Draft Core-Contracts 8 release notes. #9724

T+1w:

• Receive report from auditors.
• @0xarthurxyz: Add audit summary to final draft of the release notes.
• If all issues in the audit report have straightforward fixes:
  • CGP:
  • @0xarthurxyz: Submit a governance proposal draft
    • Started the CGP draft on this branch: 0xarthurxyz/cgp-61-core-contracts-8
    • Added: cgp-0061.md (following example of Core Contract 7 release: cgp-0055.md)
    • Added: cgp-0061.json (following example of Core Contract 7 release: cgp-0055.json)
  • .json file for CGP:
  • @alecps: Add any initialization data to the CGP that should be included as part of the proposal
  • Forum post:
  • @0xarthurxyz: Announce forthcoming smart contract release on: https://forum.celo.org/c/governance
    • Created draft forum post: Core Contracts Release 8 [DRAFT]
  • Present "Core Contract Release 8" at Celo Governance Call
    • Celo Governance Call #21 | August 25th, 2022 governance#164
• @eelanagaraj: Commit audit fixes to the release branch
  • This is the release branch: https://github.com/celo-org/celo-monorepo/tree/ASv2/packages/protocol/contracts/identity
• Submit audit fixes to auditors for review.
  • Completed with: [ASv2] Address ASv2 audit feedback #9678
• @alecps: Tag the first release candidate commit according to the git release management instructions.
• @0xarthurxyz: Let the community know about the upcoming release proposal by posting details to the Governance category on https://forum.celo.org and cross post in the Discord #governance channel.See the 'Communication guidelines' section below for information on what your post should contain.

T+2w

• @alecps: On Tuesday: Run the smart contract release script in order to to deploy the contracts to Baklava as well as submit a governance proposal.
  • @0xarthurxyz: Transition proposal through Baklava governance process.
  • @0xarthurxyz: Update your forum post with the Baklava PROPOSAL_ID, updated timings (if any changes), and notify the community in the Discord #governance channel.

T+3w

• @alecps: Confirm all contracts working as intended on Baklava.
• @alecps: Run the smart contract release script in order to to deploy the contracts to Alfajores as well as submit a governance proposal.
• @0xarthurxyz: Update your forum post with the Alfajores PROPOSAL_ID, updated timings (if any changes), and notify the community in the Discord #governance channel.

T+4w

• @alecps: Confirm all contracts working as intended on Alfajores.
• @0xarthurxyz: Confirm audit is complete and make the release notes and forum post contain a link to it.
• @alecps: On Tuesday: Run the smart contract release script in order to to deploy the contracts to Mainnet as well as submit a governance proposal.
• Update the corresponding governance proposal with the updated on-chain PROPOSAL_ID and mark CGP status as "PROPOSED".
• @0xarthurxyz: Update your forum post with the Mainnet PROPOSAL_ID, updated timings (if any changes), and notify the community in the Discord #governance channel.
• At this point all stakeholders are encouraged to verify the proposed contracts deployed match the contracts from the release branch.
• @0xarthurxyz: Monitor the progress of the proposal through the governance process.
  • Currently the governance process should take approximately 1 week: 24 hours for the dequeue process, 24 hours for the approval process, and 5 days for the referendum process. After which, the proposal is either declined or is ready to be executed within 3 days.
  • For updated timeframes, use the celocli: celocli network:parameters

T+5w

• If the proposal passed:
  • @alecps: Confirm all contracts working as intended on Mainnet.
  • @0xarthurxyz: Update your forum post with the Mainnet governance outcome (Passed or Rejected) and notify the community in the Discord #governance channel.
  • @0xarthurxyz: Change corresponding CGP status to EXCECUTED.
  • @alecps: Merge the release branch into master with a merge commit
• If the proposal failed:
  • Change corresponding CGP status to EXPIRED.