[docs] Update release policy: Release Candidate versions #897
Conversation
WalkthroughThe release documentation was updated to include a new introductory section that explains Cozystack's staged release process. This addition describes the three types of releases—Release Candidates, Regular Releases, and Patch Releases—clarifying the workflow and the relationship between these stages. The section on Regular Releases was also revised to specify that the release commit is taken from the latest Release Candidate or a subsequent minimal-change commit. Additionally, the GitHub Actions pre-commit workflow was modified by removing the Changes
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (6)
docs/release.md (6)
3-4: Refine document introduction phrasing
The current sentence is a bit wordy and passive. Consider replacing it with a more direct description of the process.- This document explains how Cozystack builds and releases are made. + This document describes Cozystack’s build and release process.
5-6: Use a full-word heading for clarity
“Intro” is informal—prefer “Introduction” to match common documentation conventions.- ## Intro + ## Introduction
7-8: Remove trailing spaces for Markdown consistency
Line 7 ends with two spaces to force a break. It’s better to use a blank line or a<br/>tag explicitly if a line break is needed, or simply rely on paragraph separation.- Cozystack uses a staged release process to ensure stability and flexibility during development. + Cozystack uses a staged release process to ensure stability and flexibility during development.
11-13: Unify pre-release version formatting
You show two different RC formats:v0.42.0-rc.1in the list butv0.42.0-rc1in the example. Choose one approach—e.g., SemVer–compliant-rc.1—and apply it consistently across the document.Also applies to: 23-23
28-28: Fix extra space inside code span
Remove the unintended space before the closing backtick to satisfy Markdown lint rule MD038.- Each RC contributes to a cumulative set of release notes that will be finalized when `vX.Y.0 `is released. + Each RC contributes to a cumulative set of release notes that will be finalized when `vX.Y.0` is released.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
28-28: Spaces inside code span elements
null(MD038, no-space-in-code)
34-34: Clarify Regular Releases sentence
The phrasing “take… and decide to make it a release” is a bit awkward. Consider tightening it for clarity.- When making regular releases, we take the latest release candidate version or a subsequent commit with minimal changes, and decide to make it a release `vX.Y.0`. + When making a regular release, we tag the latest RC or a subsequent minimal-change commit as `vX.Y.0`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/release.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/release.md
28-28: Spaces inside code span elements
null
(MD038, no-space-in-code)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build and Test
b87196d to
e9aca2d
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/release.md (3)
3-4: Refine introductory statement for clarity.
The current phrasing “how Cozystack builds and releases are made” reads a bit awkwardly. Consider rewording to something like:This document describes Cozystack’s build and release workflows.This is more direct and aligns with common documentation style.
5-6: Use a standard “Introduction” heading.
To maintain consistency with typical docs, rename the section title from:## Introto:
## Introduction
34-34: Rephrase the regular release sentence for conciseness.
The clause “and decide to make it a release” is verbose. You could rewrite this line as:When making regular releases, we use the latest release candidate or a subsequent minimal-change commit as the `vX.Y.0` tag.This version is shorter and clearer.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/release.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/release.md
28-28: Spaces inside code span elements
null
(MD038, no-space-in-code)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build and Test
aa78b88 to
77eb5b8
Compare
77eb5b8 to
7ab2652
Compare
Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
7ab2652 to
12c6df8
Compare
Pre-commit is now required to merge PRs, so let it run even on documentation updates. An alternative is to merge with administrator permissions, bypassing rules, which is not a good practice. Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
*Documentation** - Expanded the release documentation with a new section explaining Cozystack's staged release process, including details on Release Candidates, Regular Releases, and Patch Releases. - Clarified the workflow and purpose of Release Candidates and updated the explanation of how regular rele 8000 ases are created. Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com> (cherry picked from commit 062d728) Signed-off-by: Timofei Larkin <lllamnyp@gmail.com>
Summary by CodeRabbit