[docs] Describe the Cozystack release workflow #817
Conversation
|
Warning Rate limit exceeded@NickVolynkin has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 39 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughA new "Release Workflow" section has been added to the documentation, detailing the procedures for both regular and patch releases of the Cozystack software. The section describes the steps for tagging, triggering CI workflows, building and publishing artifacts, managing release branches, and finalizing releases. It also explains the differences between regular and patch releases, including the use of cherry-picking for patches. Multiple mermaid diagrams are included to visually illustrate the branching and release processes. Changes
Sequence Diagram(s)sequenceDiagram
participant Maintainer
participant GitHub
participant CI
participant Release Branch
participant Draft Release Page
Maintainer->>GitHub: Tag commit on main (vX.Y.Z)
GitHub->>CI: Trigger release workflow
CI->>Draft Release Page: Create draft release
CI->>CI: Build and push container images
CI->>Release Branch: Commit updated digests (release-x.y.z)
CI->>GitHub: Open PR to main
CI->>Draft Release Page: Upload distributive artifacts
Maintainer->>GitHub: Review & merge PR
Maintainer->>Draft Release Page: Publish release
Maintainer->>GitHub: Force-move tag to merge commit
CI->>GitHub: Final CI check
Maintainer->>Community: Announce release
sequenceDiagram
participant Maintainer
participant GitHub
participant CI
participant Release Branch
participant Draft Release Page
Maintainer->>Release Branch: Cherry-pick patch commits
Maintainer->>GitHub: Tag release branch head (vX.Y.Z+1)
GitHub->>CI: Trigger patch release workflow
CI->>Draft Release Page: Create draft release
CI->>CI: Build and push container images
CI->>Release Branch: Commit updated digests (release-x.y.z+1)
CI->>GitHub: Open PR to release branch
CI->>Draft Release Page: Upload distributive artifacts
Maintainer->>GitHub: Review & merge PR
Maintainer->>Draft Release Page: Publish release
Maintainer->>GitHub: Force-move tag to merge commit
CI->>GitHub: Final CI check
Maintainer->>Community: Announce release
Assessment against linked issues
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/release.md (3)
8-8: Add a comma for clarity.Consider adding a comma after "explanation" for improved readability:
-In this explanation we'll use version `v0.42.0` as an example: +In this explanation, we'll use version `v0.42.0` as an example:🧰 Tools
🪛 LanguageTool
[typographical] ~8-~8: It appears that a comma is missing.
Context: ...e to make it a releasex.y.0. In this explanation we'll use versionv0.42.0as an examp...(DURING_THAT_TIME_COMMA)
138-138: Correct verb agreement.Change "CI workflows moves the tag" to "CI workflows move the tag" for proper subject-verb agreement:
-7. CI workflows moves the tag `v0.42.1` to the newly created merge commit. Moving is done by force-pushing to GitHub. +7. CI workflows move the tag `v0.42.1` to the newly created merge commit. Moving is done by force-pushing to GitHub.🧰 Tools
🪛 LanguageTool
[grammar] ~138-~138: It seems that the correct verb form here is “move”.
Context: ...e (draft→latest). 7. CI workflows moves the tagv0.42.1to the newly created ...(AGREEMENT_SENT_START_2)
139-139: Add a comma for clarity and fix unordered list style.Add a comma after "in draft" for clarity, and consider using an asterisk for the unordered list to match the rest of the document's style:
- - Another CI workflow triggers on the new tag push, checks that release is not in draft and stops. + * Another CI workflow triggers on the new tag push, checks that release is not in draft, and stops.🧰 Tools
🪛 LanguageTool
[uncategorized] ~139-~139: Possible missing comma found.
Context: ...tag push, checks that release is not in draft and stops. 8. Maintainer can now announ...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
139-139: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/release.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/release.md
[typographical] ~8-~8: It appears that a comma is missing.
Context: ...e to make it a release x.y.0. In this explanation we'll use version v0.42.0 as an examp...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~64-~64: The preposition ‘as’ seems more likely in this position.
Context: ...es: * A release branch is used instead of main * Patch commits are cherry-picke...
(AI_HYDRA_LEO_REPLACE_OF_AS)
[grammar] ~138-~138: It seems that the correct verb form here is “move”.
Context: ...e (draft → latest). 7. CI workflows moves the tag v0.42.1 to the newly created ...
(AGREEMENT_SENT_START_2)
[uncategorized] ~139-~139: Possible missing comma found.
Context: ...tag push, checks that release is not in draft and stops. 8. Maintainer can now announ...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
docs/release.md
139-139: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🔇 Additional comments (2)
docs/release.md (2)
64-64: Consider rephrasing for clarity.The phrase "used instead of
main" could be clearer as "used as an alternative tomain" or "used in place ofmain." However, the current wording is understandable and not incorrect for technical documentation.🧰 Tools
🪛 LanguageTool
[uncategorized] ~64-~64: The preposition ‘as’ seems more likely in this position.
Context: ...es: * A release branch is used instead ofmain* Patch commits are cherry-picke...(AI_HYDRA_LEO_REPLACE_OF_AS)
1-141: Excellent technical documentation!The release workflow is described in a clear, detailed, and structured manner. The use of mermaid diagrams is especially helpful for visualizing the process. The steps for both regular and patch releases are well explained and should be easy for maintainers to follow.
🧰 Tools
🪛 LanguageTool
[typographical] ~8-~8: It appears that a comma is missing.
Context: ...e to make it a releasex.y.0. In this explanation we'll use versionv0.42.0as an examp...(DURING_THAT_TIME_COMMA)
[uncategorized] ~64-~64: The preposition ‘as’ seems more likely in this position.
Context: ...es: * A release branch is used instead ofmain* Patch commits are cherry-picke...(AI_HYDRA_LEO_REPLACE_OF_AS)
[grammar] ~138-~138: It seems that the correct verb form here is “move”.
Context: ...e (draft→latest). 7. CI workflows moves the tagv0.42.1to the newly created ...(AGREEMENT_SENT_START_2)
[uncategorized] ~139-~139: Possible missing comma found.
Context: ...tag push, checks that release is not in draft and stops. 8. Maintainer can now announ...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
139-139: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
docs/release.md
Outdated
| 5. CI workflow triggers on merge: | ||
| 1. Publishes the release page (`draft` → `latest`). | ||
| 2. Moves the tag `v0.42.0` to the newly created merge commit by force-pushing a tag to GitHub. | ||
| 6. Another CI workflow triggers on the new tag push, checks that release is already published, and stops. |
There was a problem hiding this comment.
This is not happening because GitHub Actions ignores tags created not by a human, details: #816 (comment)
1750ede to
19ce2cf
Compare
19ce2cf to
8e6bfc5
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/release.md (5)
63-63: Minor language improvement: use "as" instead of "instead of".Consider rephrasing for clarity and correctness:
"* A release branch is used as
main"However, the intended meaning is likely "A release branch is used instead of
main". The current phrasing is correct, but if you want to improve readability, you could say:"* A release branch is used in place of
main"This is a minor nitpick and does not affect understanding.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~63-~63: The preposition ‘as’ seems more likely in this position.
Context: ...es: * A release branch is used instead ofmain* Patch commits are cherry-picke...(AI_HYDRA_LEO_REPLACE_OF_AS)
19-24: Clarify CI asset build step for accuracy.In step 2.4, clarify that the CI builds release assets from the "Prepare release v0.42.0" commit (not the originally tagged commit), as discussed in previous reviews. This avoids confusion about which commit is used for the distributive artifacts.
Suggested rewording:
"4. Builds Cozystack release assets from the 'Prepare release v0.42.0' commit, uploads them to the release draft page."
This matches the actual workflow and aligns with past reviewer suggestions.
43-44: Clarify tag movement and release publication steps.For steps 5.1 and 5.2, clarify that the tag is force-moved to the merge commit and the release page is published, as per previous reviewer suggestions. This helps avoid ambiguity about the sequence and mechanics.
Suggested rewording:
"1. Moves the tag
v0.42.0to the newly created merge commit by force-pushing a tag to GitHub."
"2. Publishes the release page (draft→latest)."This matches the actual workflow and aligns with past reviewer suggestions.
136-137: Clarify patch release tag movement and publication steps.For patch releases, clarify that the CI workflow moves the tag to the merge commit and publishes the release page, as per previous reviewer suggestions.
Suggested rewording:
"6. CI workflow moves the tag
v0.42.1to the newly created merge commit. Moving is done by force-pushing a tag to GitHub."
"7. CI workflow publishes the release page (draft→latest)."This ensures consistency and clarity with the regular release section.
24-24: Consistency: Use the same wording for asset build steps in both release types.For both regular and patch releases, ensure the description of the asset build/upload step is consistent and clear. Use the same phrasing as suggested above for both step 2.4 (regular) and step 3.4 (patch).
Example:
"Builds Cozystack release assets from this commit, uploads them to the release draft page."
This improves clarity and avoids confusion.
Also applies to: 112-112
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/release.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/release.md
[uncategorized] ~63-~63: The preposition ‘as’ seems more likely in this position.
Context: ...es: * A release branch is used instead of main * Patch commits are cherry-picke...
(AI_HYDRA_LEO_REPLACE_OF_AS)
🔇 Additional comments (1)
docs/release.md (1)
1-139: Overall: Excellent, clear, and thorough documentation of the release workflow.The document is well-structured, uses diagrams effectively, and provides a step-by-step guide for both regular and patch releases. The process is transparent and should be easy for maintainers to follow.
Minor improvements suggested above are optional and mostly stylistic.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~63-~63: The preposition ‘as’ seems more likely in this position.
Context: ...es: * A release branch is used instead ofmain* Patch commits are cherry-picke...(AI_HYDRA_LEO_REPLACE_OF_AS)
Resolves #127 Co-authored-by: Andrei Kvapil <kvapss@gmail.com> Signed-off-by: Nick Volynkin < 8000 nick.volynkin@gmail.com>
8e6bfc5 to
ffe6109
Compare
See preview in https://github.com/cozystack/cozystack/blob/127-document-release-workflow/docs/release.md
Resolves #127
Co-authored-by: Andrei Kvapil kvapss@gmail.com
Signed-off-by: Nick Volynkin nick.volynkin@gmail.com
Summary by CodeRabbit