Moar release docs #9153
Moar release docs #9153
Conversation
There was a problem hiding this comment.
How does this relate to the work that was started in #9100 ? Should we merge that and then review this on top of it?
(Feel free to merge once you get someone else's review like @lidel or @guseggert. Basicall don't block on me while I'm out.)
| @@ -0,0 +1,33 @@ | |||
| # Expected git graph | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
A few concerns about this:
- Is the diagram itself clear for folks? I didn't take too long to stare at it, but I expect others who have done releases can give comments.
- I don't like having rendered artifacts without also linking to the raw material. Basically, if someone want to make a change here they have to regenerate it from scratch. The tips in https://filecoinproject.slack.com/archives/C03FFEVK30F/p1658375403567479 are relevant.
There was a problem hiding this comment.
I stared at it for a bit and it made sense as I worked through it, seems okay as supplemental material.
Also agree re: diagram source. We need to maintain these over time, they should be easy to change/update. GitHub supports rendering Mermaid diagrams natively now, would be nice to use that for diagramming: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams . There's even git graph support https://mermaid-js.github.io/mermaid/#/gitgraph
| ## Creating this graph: | ||
|
|
||
| 1. Making the RC. From the ref you want to make release do: | ||
| 1. `git checkout -b release-vX.Y.Z` (create the branch this release is gonna be worked on) |
There was a problem hiding this comment.
Look at the doc in rendered form. It isn't indented. I assume you need to add an extra space.
| - *release* this branch list all the release commits | ||
| It's important that `git show release~$X` shows version releases first. | ||
|
|
||
| ## Creating this graph: |
There was a problem hiding this comment.
What's the relationship of this document to docs/RELEASE_ISSUE_TEMPLATE.md ? I don't see any crosslinking.
Why isn't this info inlined into the release issue template?
I think it would be helpful to state what the purpose of this document is with a "Purpose" section.
There was a problem hiding this comment.
I haven't compared in detail but at least some of the steps here are also in #9024
| - [ ] to [github](https://github.com/ipfs/go-ipfs/releases) ***manual action to do*** | ||
| - [ ] Publish a new github release, target the tag made previously. Include changelog highlights, just lookup previous major releases for inspiration. | ||
| - [ ] Run the [synchronisation workflow](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) (it also runs once a day on a cron job) | ||
| - [ ] Send a message to notify the gateway team. |
There was a problem hiding this comment.
| - [ ] Send a message to notify the gateway team. | |
| - [ ] Send a message to notify #bifrost |
| - [ ] Publish a new github release, target the tag made previously. Include changelog highlights, just lookup previous major releases for inspiration. | ||
| - [ ] Run the [synchronisation workflow](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) (it also runs once a day on a cron job) | ||
| - [ ] Send a message to notify the gateway team. | ||
| - [ ] Send a message to notify the GUI team (need to do a new IPFS-desktop release). |
There was a problem hiding this comment.
| - [ ] Send a message to notify the GUI team (need to do a new IPFS-desktop release). | |
| - [ ] Send a message to notify #ipfs-gui-dev (since they need to do a new IPFS-desktop release). |
|
Please also account for #9024 Lets make sure @guseggert is reviewing here. |
|
@Jorropo is this still relevant? (I dunno why appears that I closed the PR, maybe because the branch was automatically deleted when merging the other PR?) |
No description provided.