-
Notifications
You must be signed in to change notification settings - Fork 451
docs: add info about pre-release and release versions #13441
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add info about pre-release and release versions #13441
Conversation
Signed-off-by: Sonia Sandler <ssandler@redhat.com>
Signed-off-by: Sonia Sandler <ssandler@redhat.com>
📝 WalkthroughWalkthroughA clarification note was added to the "Change from pre-release to release" section in the RELEASE.md file. The note specifies that only the patch-level version (.z) approved by QE should be updated from pre-release to release status on GitHub, while any previously blocked versions must remain as pre-release. An example is included to illustrate the correct marking of versions in cases where a respin is approved after bugs are found in an earlier version. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 markdownlint-cli2 (0.17.2)RELEASE.mdmarkdownlint-cli2 v0.17.2 (markdownlint v0.37.4) ... [truncated 1126 characters] ... 4:11) Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @SoniaSandler - I've reviewed your changes and they look great!
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
RELEASE.md (1)
91-92
: Clarify wording & tighten SemVer terminologySmall copy-edit to explicitly call this the “patch-level” version and improve readability.
-**IMPORTANT NOTE:** Only the .z version that was approved by QE should be changed from pre-release to release. Any previous blocked versions need to stay as pre-release. For example, if the respin version `1.3.1` was approved by QE after finding bugs in `1.3.0`, only `1.3.1` should be moved from pre-release to release. +**IMPORTANT NOTE:** Only the patch-level version (the *.z* component) that has been approved by QE should be promoted from *pre-release* to *release*. Any earlier versions that were blocked must remain in *pre-release* state. +For example, if the respin `1.3.1` is approved after bugs are found in `1.3.0`, promote **only** `1.3.1` and leave `1.3.0` marked as a pre-release.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
RELEASE.md
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
- GitHub Check: unit tests / macos-15
- GitHub Check: unit tests / windows-2025
- GitHub Check: typecheck
- GitHub Check: build website
- GitHub Check: unit tests / ubuntu-24.04
- GitHub Check: linter, formatters
- GitHub Check: smoke e2e tests (development)
- GitHub Check: macOS
- GitHub Check: smoke e2e tests (production)
- GitHub Check: Linux
- GitHub Check: Windows
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
QE approves :)
Signed-off-by: Sonia Sandler ssandler@redhat.com
What does this PR do?
Adds information about which release version should be moved from pre-release to release
Screenshot / video of UI
What issues does this PR fix or reference?
How to test this PR?