115 lines
4.6 KiB
Markdown
115 lines
4.6 KiB
Markdown
> Release Issue Template
|
|
|
|
# Lotus X.Y.Z Release
|
|
|
|
We're happy to announce Lotus X.Y.Z...
|
|
|
|
## 🗺 Must-dos for the release
|
|
|
|
## 🌟 Nice-to-haves for the release
|
|
|
|
<List of items with PRs and/or Issues to be considered for this release>
|
|
|
|
## 🚢 Estimated shipping date
|
|
|
|
<Date this release will ship on if everything goes to plan (week beginning...)>
|
|
|
|
## 🔦 Highlights
|
|
|
|
< top highlights for this release notes >
|
|
|
|
## ✅ Release Checklist
|
|
|
|
First steps:
|
|
|
|
- [ ] Fork a new branch (`release/vX.Y.Z`) from `master` and make any further release related changes to this branch. If any "non-trivial" changes get added to the release, uncheck all the checkboxes and return to this stage.
|
|
- [ ] Prep the changelog using `scripts/mkreleaselog`, and add it to `CHANGELOG.md`
|
|
- [ ] Bump the version in `version.go` in the `master` branch to `vX.(Y+1).0-dev`.
|
|
|
|
Prepping an RC:
|
|
|
|
- [ ] version string in `build/version.go` has been updated (in the `release/vX.Y.Z` branch).
|
|
- [ ] tag commit with `vX.Y.Z-rcN`
|
|
- [ ] cut a pre-release [here](https://github.com/filecoin-project/lotus/releases/new?prerelease=true)
|
|
|
|
Testing an RC:
|
|
|
|
- [ ] **Stage 0 - Automated Testing**
|
|
- Automated Testing
|
|
- [ ] CI: Ensure that all tests are passing.
|
|
- [ ] Testground tests
|
|
|
|
- [ ] **Stage 1 - Internal Testing**
|
|
- Upgrade our testnet infra
|
|
- [ ] 1 bootstrap node
|
|
- [ ] 1 miner
|
|
- [ ] Scratch nodes
|
|
- [ ] Wait 24 hours, confirm nodes stay in sync
|
|
- [ ] Remaining testnet infra
|
|
- Upgrade our mainnet infra
|
|
- [ ] Subset of development full archival nodes
|
|
- [ ] Subset of bootstrappers (1 per region)
|
|
- [ ] Confirm nodes stay in sync
|
|
- Metrics report
|
|
- Block validation time
|
|
- Memory / CPU usage
|
|
- Number of goroutines
|
|
- IPLD block read latency
|
|
- Bandwidth usage
|
|
- [ ] If anything has worsened significantly, investigate + fix
|
|
- Confirm the following work (some combination of Testground / Calibnet / Mainnet / beta users)
|
|
- [ ] Seal a sector
|
|
- [ ] make a deal
|
|
- [ ] Submit a PoSt
|
|
- [ ] (optional) let a sector go faulty, and see it be recovered
|
|
|
|
- [ ] **Stage 2 - Community Dev Testing**
|
|
- [ ] Inform beta miners (@lotus-early-testers-miner in Filecoin Slack #fil-lotus)
|
|
- [ ] Ask close ecosystem partners to test their projects (@lotus-early-testers-eco-dev in Filecoin slack #fil-lotus)
|
|
- [ ] Powergate
|
|
- [ ] Glif
|
|
- [ ] Zondax
|
|
- [ ] Stats dashboard
|
|
- [ ] Community dashboards
|
|
- [ ] Infura
|
|
- [ ] Sentinel
|
|
- [ ] Protofire
|
|
- [ ] Fleek
|
|
|
|
- [ ] **Stage 3 - Community Prod Testing**
|
|
- [ ] Documentation
|
|
- [ ] Ensure that [CHANGELOG.md](https://github.com/filecoin-project/lotus/blob/master/CHANGELOG.md) is up to date
|
|
- [ ] Check if any [config](https://docs.filecoin.io/get-started/lotus/configuration-and-advanced-usage/#configuration) updates are needed
|
|
- [ ] Invite the wider community through (link to the release issue):
|
|
- [ ] Create a lotus disucssion, example [here](https://github.com/filecoin-project/lotus/discussions/5595)
|
|
- [ ] Link the disucssion in #fil-lotus on Filecoin slack
|
|
|
|
- [ ] **Stage 4 - Release**
|
|
- [ ] Final preparation
|
|
- [ ] Verify that version string in [`version.go`](https://github.com/ipfs/go-ipfs/tree/master/version.go) has been updated.
|
|
- [ ] Ensure that [CHANGELOG.md](https://github.com/filecoin-project/lotus/blob/master/CHANGELOG.md) is up to date
|
|
- [ ] Ensure that [README.md](https://github.com/filecoin-project/lotus/blob/master/README.md) is up to date
|
|
- [ ] Merge `release-vX.Y.Z` into the `releases` branch.
|
|
- [ ] Tag this merge commit (on the `releases` branch) with `vX.Y.Z`.
|
|
- [ ] Cut the release [here](https://github.com/filecoin-project/lotus/releases/new?prerelease=true&target=releases).
|
|
- [ ] Final announcements
|
|
- [ ] Update network.filecoin.io for mainnet, calib and nerpa.
|
|
- [ ] Add a comment when the final release is tagged, example [here](https://github.com/filecoin-project/lotus/discussions/5905#discussioncomment-571752)
|
|
- [ ] repost in #fil-lotus in filecoin slack
|
|
|
|
- [ ] **Post-Release**
|
|
- [ ] Merge the `releases` branch back into `master`, ignoring the changes to `version.go` (keep the `-dev` version from master).
|
|
- [ ] Create an issue using this release issue template for the _next_ release.
|
|
|
|
## ❤️ Contributors
|
|
|
|
< list generated by scripts/mkreleaselog >
|
|
|
|
Would you like to contribute to Lotus and don't know how? Well, there are a few places you can get started:
|
|
|
|
- TODO
|
|
|
|
## ⁉️ Do you have questions?
|
|
|
|
Leave a comment [here](<link to release discussion>) if you have any questions.
|