chore(docs): updated release.md file with new release notes tool options #13468
Conversation
Signed-off-by: Evzen Gasta <evzen.ml@seznam.cz>
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. 📝 WalkthroughWalkthroughReplaces draft-based release notes workflow with milestone-linked release notes generation. Updates RELEASE.md and documentation to generate notes locally from PRs associated with a specified milestone (includes GH CLI example using milestone 1.9.0). Adds an alternative path using an example template to create a blog PR, instructions to add release images to website/img/podman-desktop-release-0.13, and guidance to ping docs maintainers. Includes minor textual edits and a NOTE that PRs not in the milestone will be omitted. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Assessment against linked issues
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) Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Hey @gastoner - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `RELEASE.md:144` </location>
<code_context>
-You can generate "draft" release notes by using the [release notes workflow](https://github.com/containers/podman-desktop/actions/workflows/release-notes.yaml). This will go through each PR and look for the `// release-notes` comment, in order to automatically generate release notes. Note: If no one has added release note comments, the script will result in a blank file.
+You can generate release notes by using the [release notes tool](https://github.com/podman-desktop/tool-release-notes). This will go through each PR that is linked with the given milestone and automatically generate release notes.
+
+> **_NOTE:_** If the issue is not in given milestone it will not be in release notes. The release notes are generated locally on your machine, you just need to add the images with editing the highlited PRs (since those can be generated by AI model). And copy the release notes to right folder in podman-desktop reposotory.
+
+OR
</code_context>
<issue_to_address>
Correct typos: 'highlited' should be 'highlighted', and 'reposotory' should be 'repository'.
Please update 'highlited' to 'highlighted' and 'reposotory' to 'repository' in this line.
</issue_to_address>
<suggested_fix>
<<<<<<< SEARCH
> **_NOTE:_** If the issue is not in given milestone it will not be in release notes. The release notes are generated locally on your machine, you just need to add the images with editing the highlited PRs (since those can be generated by AI model). And copy the release notes to right folder in podman-desktop reposotory.
=======
> **_NOTE:_** If the issue is not in given milestone it will not be in release notes. The release notes are generated locally on your machine, you just need to add the images with editing the highlighted PRs (since those can be generated by AI model). And copy the release notes to right folder in podman-desktop repository.
>>>>>>> REPLACE
</suggested_fix>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.
Actionable comments posted: 0
🧹 Nitpick comments (4)
RELEASE.md (4)
142-143: Good shift to milestone-driven release notes; add a quick-start usage snippetThe change aligns with the new workflow. To reduce back-and-forth, consider adding a minimal “How to run” example (invocation + required flags) and a link to the tool’s README section that documents the new options. This helps first-time users succeed without guessing.
If you share the exact CLI flags you want users to adopt, I can draft the snippet and insert it here.
144-145: Fix typos and tighten wording in the NOTEThere are a few typos (“highlited”, “reposotory”) and awkward phrasing. Suggesting a concise rewrite.
- > **_NOTE:_** If the issue is not in given milestone it will not be in release notes. The release notes are generated locally on your machine, you just need to add the images with editing the highlited PRs (since those can be generated by AI model). And copy the release notes to right folder in podman-desktop reposotory. + > **NOTE:** If a PR or issue is not assigned to the specified milestone, it will not appear in the release notes. Release notes are generated locally on your machine. You can add images for highlighted PRs (optionally generated by an AI model) before copying the notes to the appropriate folder in the podman-desktop repository.
146-146: Replace “OR” with clearer instructional text“OR” alone is easy to miss and not very descriptive.
-OR +Alternatively, use the manual process below:
148-153: Normalize version placeholders and improve readability of the gh example
- Use consistent placeholders (e.g., X.Y or X.Y.Z) to avoid mixing 0.12.0 / 0.13 / 1.9.0.
- Put the gh command in a fenced block for copy-paste.
- Clarify the images directory with the same placeholder.
-1. Create a PR to the blog folder of the website using the file format: `website/blog/2023-07-12-release-0.13.md` -1. Example of request when using `gh` cli tool for 1.9.0 milestone: `gh pr list --limit 300 --repo "containers/podman-desktop" --search "state:closed milestone:1.9.0" --json title,number,url --template '{{range .}}- {{.title}} [#{{.number}}]({{.url}}){{"\n"}}{{end}}'` -1. Add any images to the `website/img/podman-desktop-release-0.13` folder. +1. Create a PR to the blog folder of the website using the file format: `website/blog/YYYY-MM-DD-release-X.Y.md` +1. Example `gh` CLI command to list closed PRs for milestone `X.Y.Z`: + ``` + gh pr list --limit 300 \ + --repo "containers/podman-desktop" \ + --search "state:closed milestone:X.Y.Z" \ + --json title,number,url \ + --template '{{range .}}- {{.title}} [#{{.number}}]({{.url}}){{"\n"}}{{end}}' + ``` +1. Add any images to the `website/img/podman-desktop-release-X.Y` folder. 1. Ping the respective docs maintainers for a review before merging.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
RELEASE.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
RELEASE.md
[grammar] ~144-~144: Ensure spelling is correct
Context: ...need to add the images with editing the highlited PRs (since those can be generated by AI...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ 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). (12)
- GitHub Check: smoke e2e tests (development)
- GitHub Check: smoke e2e tests (production)
- GitHub Check: linter, formatters
- GitHub Check: typecheck
- GitHub Check: unit tests / ubuntu-24.04
- GitHub Check: unit tests / macos-15
- GitHub Check: unit tests / windows-2025
- GitHub Check: build website
- GitHub Check: macOS
- GitHub Check: Linux
- GitHub Check: Windows
- GitHub Check: WIP
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Signed-off-by: Evzen Gasta <evzen.ml@seznam.cz>
54abe36 to
85b3933
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
RELEASE.md (2)
144-145: Fix grammar and clarify “issue” vs “PR” in NOTEUse “PR” consistently (the tool operates on PRs), and tighten grammar for readability.
Apply this diff:
-> **_NOTE:_** If the issue is not in given milestone it will not be in release notes. The release notes are generated locally on your machine, you just need to add the images with editing the highlighted PRs (since those can be generated by AI model). And copy the release notes to right folder in podman-desktop repository. +> **_NOTE:_** Only PRs in the specified milestone will appear in the generated release notes. The notes are generated locally on your machine. You can add images by editing the highlighted PRs (these can be generated by an AI model). Finally, copy the release notes to the correct folder in the podman-desktop repository.
146-147: Replace bare “OR” with a clearer transitionA simple textual transition improves readability in docs.
Apply this diff:
-OR +Alternatively,
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
RELEASE.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
RELEASE.md
[grammar] ~144-~144: There might be a mistake here.
Context: ...tes. > NOTE: If the issue is not in given milestone it will not be in relea...
(QB_NEW_EN)
[grammar] ~144-~144: There might be a mistake here.
Context: ...s not in given milestone it will not be in release notes. The release notes are ge...
(QB_NEW_EN)
[grammar] ~144-~144: There might be a mistake here.
Context: ...ghted PRs (since those can be generated by AI model). And copy the release notes t...
(QB_NEW_EN)
[grammar] ~144-~144: There might be a mistake here.
Context: ...y AI model). And copy the release notes to right folder in podman-desktop reposito...
(QB_NEW_EN)
[grammar] ~144-~144: There might be a mistake here.
Context: ... copy the release notes to right folder in podman-desktop repository. OR 1. Use ...
(QB_NEW_EN)
⏰ 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 / windows-2025
- GitHub Check: smoke e2e tests (production)
- GitHub Check: unit tests / macos-15
- GitHub Check: unit tests / ubuntu-24.04
- GitHub Check: smoke e2e tests (development)
- GitHub Check: typecheck
- GitHub Check: Windows
- GitHub Check: build website
- GitHub Check: linter, formatters
- GitHub Check: macOS
- GitHub Check: Linux
🔇 Additional comments (1)
RELEASE.md (1)
142-143: Good addition: clear pointer to the milestone-based release-notes toolLinking directly to the tool and stating it works off PRs in a given milestone is clear and actionable.
What does this PR do?
Updates
release.mdfile with new options for release notes tool generatingScreenshot / video of UI
What issues does this PR fix or reference?
Closes #13433
How to test this PR?
Read the release.md
You can try the tool :D