Introduce a release issue template #5826
Conversation
arajasek
force-pushed
the
asr/release-template
branch
from
0349707
to
a70fed1
Compare
| - [ ] Cut the release on Github. | ||
| - [ ] Final announcements | ||
| - [ ] Update network.filecoin.io | ||
| - [ ] TODO: What / where else? |
| - [ ] **Stage 3 - Community Prod Testing** | ||
| - [ ] Documentation | ||
| - [ ] Ensure that [CHANGELOG.md](https://github.com/filecoin-project/lotus/blob/master/CHANGELOG.md) is up to date | ||
| - [ ] TODO: Other docs checks? |
There was a problem hiding this comment.
@jennijuju any ideas for elaboration here?
There was a problem hiding this comment.
Would add config docs - https://docs.filecoin.io/get-started/lotus/configuration-and-advanced-usage/#configuration
There was a problem hiding this comment.
This is interesting. Is it possible that folks are adding new functionality but in the PR not adding the relevant doc updates? If so, is it a manual audit to go through commits looking for this? That seems rough.
There was a problem hiding this comment.
- new cli or change of cli
- new field added to the lotus or lotus miner config.toml or any change of behavior
- update the api docs (when we have a proper one)
There was a problem hiding this comment.
@BigLep So this is tricky. Several thoughts:
- Yes, PRs often land without necessary docs updates.
- Most documentation lives outside of the Lotus repo.
- We haven't really established a workflow for doc updates -- it's somewhat haphazard right now.
| - [ ] Subset of development full archival nodes | ||
| - [ ]Subset of bootstrappers (1 per region) | ||
| - Report on new block validation time | ||
| - TODO: What other stats would we care about? |
There was a problem hiding this comment.
@magik6k @Stebalien thoughts?
There was a problem hiding this comment.
Memory/CPU use are worth following
There was a problem hiding this comment.
Can we link to the dashoard we're going to look at?
There was a problem hiding this comment.
Number of goroutines. IPLD block read latency. Bandwidth usage (by protocol, ideally).
| @@ -0,0 +1,233 @@ | |||
| #!/bin/zsh | |||
There was a problem hiding this comment.
This is just a copy of the IPFS script, needs to be modified
There was a problem hiding this comment.
I assume this script is for pulling out the contributor list? Do we maybe put it in its own file?
There was a problem hiding this comment.
For pulling out the contributor list and auto-generating the changelog (I think it just sniffs for "Merge pull request" commits).
There was a problem hiding this comment.
Do you mean put the contributor list in its own file? I was thinking we'd include them in release notes and the Lotus CHANGELOG, but I'm easy. That's just what IPFS does.
|
|
||
| Would you like to contribute to Lotus and don't know how? Well, there are a few places you can get started: | ||
|
|
||
| - TODO |
There was a problem hiding this comment.
will write this and the next one when i'm not lazy...or merge as is and complete later
| - [ ] Inform MinerX / early testers | ||
| - [ ] Ask close ecosystem partners to test their projects with the upgrade | ||
| - [ ] Powergate | ||
| - TODO: List of partners |
There was a problem hiding this comment.
Have asked for suggestions, can be completed later
There was a problem hiding this comment.
Thanks a lot for putting this together @arajasek !
I like the opennes in GitHub. Potential things I don't think it captures though are:
- Who is the owner for a certain step.
- What are the expected dates for a certain operation.
- Binary checkboxes don't capture if something is in-progress or blocked.
- How easy will it be for posting in graphs or other comments while executing the release process?
I'm game for whatever, but a Notion public document is another option.
Other comments:
- It seems like this is focused on a new minor version. Where will we capture if there's a new major or patch version?
- I'm not saying it belongs in this document, but I assume we need to also capture our branching strategy and how Lotus versions relate to network versions.
| - [ ] **Stage 3 - Community Prod Testing** | ||
| - [ ] Documentation | ||
| - [ ] Ensure that [CHANGELOG.md](https://github.com/filecoin-project/lotus/blob/master/CHANGELOG.md) is up to date | ||
| - [ ] TODO: Other docs checks? |
There was a problem hiding this comment.
This is interesting. Is it possible that folks are adding new functionality but in the PR not adding the relevant doc updates? If so, is it a manual audit to go through commits looking for this? That seems rough.
|
|
||
| - [ ] **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. |
There was a problem hiding this comment.
I think we can prepopulate this URL as well.
| - [ ] 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 |
There was a problem hiding this comment.
Is the point of this section to pull out who contributed?
There was a problem hiding this comment.
Yup, example from IPFS
| @@ -0,0 +1,233 @@ | |||
| #!/bin/zsh | |||
There was a problem hiding this comment.
I assume this script is for pulling out the contributor list? Do we maybe put it in its own file?
| - [ ] **Stage 0 - Automated Testing** | ||
| - Automated Testing | ||
| - [ ] CI: Ensure that all tests are passing. | ||
| - [ ] Testground tests |
There was a problem hiding this comment.
They do. @coryschwartz what's the status on getting the testground test results back into lotus?
| - [ ] Subset of development full archival nodes | ||
| - [ ]Subset of bootstrappers (1 per region) | ||
| - Report on new block validation time | ||
| - TODO: What other stats would we care about? |
There was a problem hiding this comment.
Number of goroutines. IPLD block read latency. Bandwidth usage (by protocol, ideally).
| - [ ] (ideally) let a sector go faulty, and see it be recovered | ||
|
|
||
| - [ ] **Stage 2 - Community Dev Testing** | ||
| - [ ] Inform MinerX / early testers |
There was a problem hiding this comment.
| - [ ] Inform MinerX / early testers | |
| - early miner testers (@lotus-early-testers-miner in Filecoin Slack #fil-lotus) |
| - [ ] Ask close ecosystem partners to test their projects with the upgrade | ||
| - [ ] Powergate | ||
| - TODO: List of partners |
There was a problem hiding this comment.
| - [ ] Ask close ecosystem partners to test their projects with the upgrade | |
| - [ ] Powergate | |
| - TODO: List of partners | |
| - [ ] Ask close ecosystem partners to test their projects with the upgrade (@lotus-early-testers-eco-dev in Filecoin slack #fil-lotus) |
| - [ ] **Stage 3 - Community Prod Testing** | ||
| - [ ] Documentation | ||
| - [ ] Ensure that [CHANGELOG.md](https://github.com/filecoin-project/lotus/blob/master/CHANGELOG.md) is up to date | ||
| - [ ] TODO: Other docs checks? |
There was a problem hiding this comment.
- new cli or change of cli
- new field added to the lotus or lotus miner config.toml or any change of behavior
- update the api docs (when we have a proper one)
|
|
||
| ## ⁉️ Do you have questions? | ||
|
|
||
| TODO |
There was a problem hiding this comment.
Leave a comment [here](link to release discussion) if you have any questions.
Co-authored-by: Jennifer <42981373+jennijuju@users.noreply.github.com>
Co-authored-by: Jennifer <42981373+jennijuju@users.noreply.github.com>
arajasek
force-pushed
the
asr/release-template
branch
from
b73a6c4
to
b6949aa
Compare
|
Acknowledged most of the second wave of feedback, thanks @jennijuju, @Stebalien, and @BigLep! This time it was harder to immediately incorporate everything, though. I've added a next steps / unanswered questions write-up here, but I would like to land this PR and start using it sooner rather than later -- I don't want perfect to be the enemy of good here. I'm sure there's lots of tweaking that'll happen as we iterate. |
|
So one thing that's missing from this checklist is the point when all infra gets updated to the new release. @magik6k flags it'd be good to keep a subset of mainnet infra one release behind, but ideally those partitions (latest release, one release behind) will be well defined and easily understood. @ognots @travisperson @coryschwartz thoughts? |
|
@magik6k plz update the script to be for Lotus |
This patch supports branch-based v2 modules, but not directory-based (i.e., not vN modules with `vN/` directories).
|
Landing for now, further improvements welcome |
Lots of TODOs to flesh out.
resolves #5815