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

chore: update Cosmos Hub Upgrade Epic #2661

Merged
merged 2 commits into from
Jul 27, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 35 additions & 49 deletions .github/ISSUE_TEMPLATE/upgrade-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,69 +4,55 @@ about: Create a checklist for an upgrade
labels: epic, needs-triage
---

## Cosmos Hub Upgrade Epic
## Cosmos Hub Upgrade to Gaia <Version>

### <Upgrade Name>

**Create an issue for each item** and mark complete once it has been done.

<!-- TODO: add time estimates for comms -->
<!-- TODO: Replace <Version> by the actual Gaia version -->

```[tasklist]
### Communication (during entire lifecycle)
- [ ] Signaling proposal (before development starts)
- [ ] Testnet blog post - target validators on Cosmos Medium
- [ ] Tweet link to testnet upgrade blog - @ cosmohub
- [ ] Testnet upgrade info (discord only)
- [ ] Tweet updates on proposal status - @ cosmohub
- [ ] Mainnet blog post - target wider audience on Cosmos Medium
- [ ] Tweet link to mainnet upgrade blog - @ cosmos @ cosmoshub
- [ ] Link to mainnet upgrade instructions (all channels - Discord, Telegram, Slack)
- [ ] Tweet upgrade countdown during voting period - @ cosmos @ cosmoshub
- [ ] Tweet upgrade success story - @ cosmos @ cosmoshub
### After Cutting Release Candidate
- [ ] Coordinate with Hypha to test release candidate
- [ ] Create proposal text draft
- [ ] Post proposal text draft on forum
- [ ] Upgrade release and replicated security testnets (note: on Wednesdays)
- [ ] Review post-upgrade status of affected features if necessary
```

```[tasklist]
### Library dependencies
- [ ] Upgrade to SDK version <SDK VERSION>
- [ ] Upgrade to IBC version <IBC VERSION>
- [ ] Upgrade to ICS version <ICS VERSION>
- [ ] Upgrade to PFM version <PFM VERSION>
- [ ] Upgrade to Liquidity version <Liquidity VERSION>
- [ ] Integrate new modules ([checklist](https://github.com/cosmos/hub-eng/blob/main/module_qa/module_checklist.md))
### Before Proposal Submission (TODO sync on a call)
- [ ] Cut final release
- [ ] Predict block height for target date
- [ ] Update/proofread proposal text
- [ ] Transfer deposit amount (i.e., 250 ATOMs) to submitter wallet
- [ ] Create upgrade docs (with disclaimer upgrade prop still being voted on)
- [ ] Coordinate with marketing/comms to prep communication channels/posts
```

```[tasklist]
### Testnet
- [ ] Communication prep
- [ ] Docs:
- [ ] [testnets](https://github.com/cosmos/testnets) updated with most recent rc
- [ ] [join-testnet](https://github.com/cosmos/gaia/blob/main/docs/hub-tutorials/join-testnet.md)
- [ ] Release candidate
- [ ] Create testnet proposal
- [ ] Run testnet for one week
- [ ] Final Release
### Voting Period
- [ ] Estimate threshold of validators that are aware of proposal and have voted or confirmed their vote
- [ ] Coordinate with marketing/comms to update on voting progress (and any change in upgrade time)
```

```[tasklist]
### Docs
- On release branch
- [ ] Quickstart in `docs/getting-started/quickstart.md`
- [ ] Join mainnet in `docs/hub-tutorials/join-mainnet.md`
- [ ] Migration docs in `docs/migration/`
- [ ] Update `CHANGELOG.md`
- [ ] Breaking REST api changes
- [ ] Breaking CLI api changes
- Post Upgrade
- [ ] [chain-registry.json](https://github.com/cosmos/chain-registry/blob/master/cosmoshub/chain.json)
- [ ] Update [cosmos mainnet repo](https://github.com/cosmos/mainnet)
## Proposal Passed
- [ ] Determine "on-call" team: available on Discord in [#cosmos-hub-validators-verified](https://discord.com/channels/669268347736686612/798937713474142229) during upgrade
- [ ] Coordinate with marketing/comms on who will be available, increase regular upgrade time updates and validator outreach
- [ ] Prep Gaia docs: `docs/getting-started/quickstart.md`, `docs/hub-tutorials/join-mainnet.md`, `docs/migration/` (open PR)
- [ ] Prep chain-registry update: [cosmoshub/chain.json](https://github.com/toschdev/chain-registry/blob/master/cosmoshub/chain.json) (open PR)
- [ ] Prep [cosmos mainnet repo](https://github.com/cosmos/mainnet) update (open PR)
- [ ] Prep internal statesync node for upgrade (confirm cosmovisor configured)
- [ ] Reach out to main dependency teams -- Comet, IBC, SDK -- for assistance during the upgrade (#gaia-release-warroom on Slack)
```

```[tasklist]
### Mainnet Proposal
- [ ] Predict block height for target date
- [ ] Create forum post
- [ ] Submit on-chain proposal
## During Upgrade (note: on Wednesdays at 15:00 UTC)
- [ ] Available on Discord in [#cosmos-hub-validators-verified](https://discord.com/channels/669268347736686612/798937713474142229)
- [ ] Available on Twitter / Slack / Telegram
```


```[tasklist]
## Post Upgrade
- [ ] Merge PRs for Gaia docs & chain-registry update
- [ ] FAQ: collect issues on upgrade from discord
- [ ] Hold validator feedback session
```