Update RELEASES.md
#11286
Update RELEASES.md
#11286
Conversation
jprochazk
added
📖 documentation
There was a problem hiding this comment.
Thanks! I think this version is easier to follow. :)
This might be out of scope for this PR, but what I miss the most is a summary at the beginning of how it all works: which steps create which artifacts, what docs-latest is, and especially how versioning works, that seems to be somewhat confusing for multiple people.
|
|
||
|  | ||
|
|
||
| ### 7. Wait for the workflow to finish |
There was a problem hiding this comment.
| ### 7. Wait for the workflow to finish | |
| ### 7. Wait for both the workflows to finish |
| Note: there are two separate workflows running -- the one building the release artifacts, and the one running the PR checks. | ||
| You will have to wait for the [former](https://github.com/rerun-io/rerun/actions/workflows/release.yml) in order to get a link to the artifacts. | ||
| You can mostly ignore the PR checks. You will have to wait for the [former](https://github.com/rerun-io/rerun/actions/workflows/release.yml) | ||
| in order to get a link to the artifacts. |
There was a problem hiding this comment.
Let's make this section even more explicit, something like:
The Release workflow will build artifacts and run PR checks.
Additionally, it will spawn a second workflow (WHEN?) that called GitHub Release.
This workflow is responsible for creating the GitHub release draft and to publish the artifacts to it.
Make sure this workflow also finishes!.
Only after it finishes successfully should you un-draft the GitHub release.
|
It turns out our |
|
(I am still planning to finish this, but Azure is a higher priority right now) |
The diff is a bit confusing, so prefer reviewing the rendered page directly.