8000 docs: add info about pre-release and release versions by SoniaSandler · Pull Request #13441 · podman-desktop/podman-desktop · GitHub
[go: up one dir, main page]

Skip to content

Conversation

SoniaSandler
Copy link
Contributor

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

Screenshot 2025-07-30 at 4 53 07 PM

What issues does this PR fix or reference?

How to test this PR?

  • Tests are covering the bug fix or the new feature

Signed-off-by: Sonia Sandler <ssandler@redhat.com>
Signed-off-by: Sonia Sandler <ssandler@redhat.com>
@SoniaSandler SoniaSandler requested review from benoitf and a team as code owners July 30, 2025 20:54
@SoniaSandler SoniaSandler requested review from feloy and simonrey1 and removed request for a team July 30, 2025 20:54
Copy link
Contributor
coderabbitai bot commented Jul 30, 2025
📝 Walkthrough

Walkthrough

A 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

  • benoitf
  • cdrage

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.md

markdownlint-cli2 v0.17.2 (markdownlint v0.37.4)
Finding: RELEASE.md
Linting: 1 file(s)
Summary: 24 error(s)
AggregateError: Unable to import module 'markdownlint-cli2-formatter-summarize'.
at importModule (file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2.mjs:92:11)
at async Promise.all (index 0)
at async outputSummary (file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2.mjs:864:9)
at async main (file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2.mjs:1043:25)
at async file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2-bin.mjs:12:22 {
[errors]: [
Error: Cannot find module 'markdownlint-cli2-formatter-summarize'
Require stack:
- /usr/local/lib/node_modules/markdownlint-cli2/node_modules/markdownlint/lib/resolve-module.cjs
at Module._resolveFilename (node:internal/modules/cjs/loader:1369:15)
at resolve (node:internal/modules/helpers:145:19)
at resolveM

... [truncated 1126 characters] ...

4:11)
at moduleResolve (node:internal/modules/esm/resolve:859:10)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultReso 8000 lve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at onImport.tracePromise.proto (node:internal/modules/esm/loader:659:36)
at TracingChannel.tracePromise (node:diagnostics_channel:344:14)
at ModuleLoader.import (node:internal/modules/esm/loader:658:21) {
code: 'ERR_MODULE_NOT_FOUND',
url: 'file:///markdownlint-cli2-formatter-summarize'
}
]
}

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
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor
@sourcery-ai sourcery-ai bot left a 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!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Contributor
@coderabbitai coderabbitai bot left a 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 terminology

Small 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

📥 Commits

Reviewing files that changed from the base of the PR and between 2f05867 and 0ce8c12.

📒 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

Copy link
Contributor
@jeffmaury jeffmaury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor
@rujutashinde rujutashinde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor
@odockal odockal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

QE approves :)

@SoniaSandler SoniaSandler merged commit c6438fc into podman-desktop:main Jul 31, 2025
21 checks passed
@podman-desktop-bot podman-desktop-bot added this to the 1.21.0 milestone Jul 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants
0