Update generate_changelog.py#9099
Conversation
📝 WalkthroughWalkthroughThe changelog generator now asks AI-polished output to use ChangesChangelog blog link handling
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.github/scripts/generate_changelog.py (1)
75-75: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueImprove the grammar in the generated sentence.
The phrase "on the highlights" in the system prompt isn't very idiomatic. Consider changing it to "for the highlights" to make the resulting changelog read more naturally.
♻️ Proposed fix
- - `### Improvements` — for new features and enhancements only. Do NOT place items beginning with "Fixed..." here — those belong in Bug Fixes. Begin this section with the line `See BLOG_POST_LINK on the highlights in our latest release.` (use the exact placeholder `BLOG_POST_LINK` — it will be replaced automatically with a Markdown link), followed by a blank line before the first `####` subsection heading. Then add subsections as applicable: + - `### Improvements` — for new features and enhancements only. Do NOT place items beginning with "Fixed..." here — those belong in Bug Fixes. Begin this section with the line `See BLOG_POST_LINK for the highlights in our latest release.` (use the exact placeholder `BLOG_POST_LINK` — it will be replaced automatically with a Markdown link), followed by a blank line before the first `####` subsection heading. Then add subsections as applicable:🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/scripts/generate_changelog.py at line 75, Update the Improvements section instruction in the changelog generation prompt to use “for the highlights” instead of “on the highlights,” while preserving the exact BLOG_POST_LINK placeholder and surrounding formatting requirements.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In @.github/scripts/generate_changelog.py:
- Line 75: Update the Improvements section instruction in the changelog
generation prompt to use “for the highlights” instead of “on the highlights,”
while preserving the exact BLOG_POST_LINK placeholder and surrounding formatting
requirements.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 3d9a17f0-9ab9-44d9-8060-f24418405abf
📒 Files selected for processing (1)
.github/scripts/generate_changelog.py
There was a problem hiding this comment.
Pull request overview
Updates the changelog generation script used in the Mattermost docs automation to change how the “Improvements” section references the release highlights blog post, including switching from a raw URL placeholder to a Markdown-link placeholder.
Changes:
- Updates the AI/system prompt to use a
BLOG_POST_LINKplaceholder in the Improvements intro line. - Updates blog URL construction logic to remove a trailing
-0from the version slug and inject a Markdown-formatted link into the generated changelog text.
|
Newest code from mattermost has been published to preview environment for Git SHA b8dd8f2 |
|
Newest code from mattermost has been published to preview environment for Git SHA bed36f1 |
* Enhance SAML configuration instructions for Mattermost Updated instructions for configuring SAML attributes and claims in Entra for Mattermost integration, including detailed explanations of required and additional claims. * Update sso-saml-entraid.rst * Update sso-saml-entraid.rst * Update sso-saml-entraid.rst * Add image for Tenant ID location in Entra Added an image reference for the Tenant ID location in Entra. * Add files via upload * Fix formatting of image attributes in SSO SAML guide * Update source/administration-guide/onboard/sso-saml-entraid.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update source/administration-guide/onboard/sso-saml-entraid.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update source/administration-guide/onboard/sso-saml-entraid.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update source/administration-guide/onboard/sso-saml-entraid.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update source/administration-guide/onboard/sso-saml-entraid.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add files via upload * Update source/administration-guide/onboard/sso-saml-entraid.rst Make assigning users/groups the default path in step 8; move the "Assignment required? = No" option into a warning directive that notes it grants access to all tenant users and prompts the reader to evaluate fit for their environment. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Update source/administration-guide/onboard/sso-saml-entraid.rst Clarify Sign Request step to distinguish Mattermost signing outbound AuthnRequests from Entra signing responses/assertions; specify that Entra requires RSA-SHA256 for signed requests; add missing Entra-side step to upload the SP public certificate under Verification certificates. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Combs7th <147677911+Combs7th@users.noreply.github.com>
|
Newest code from mattermost has been published to preview environment for Git SHA a033b8b |
* Bump v10.11 download link to v10.11.22 * Add v10.11.22 dot release changelog entry * Add v10.11.22 to version archive * Bump v11.7 download link to v11.7.7 * Add v11.7.7 dot release changelog entry * Add v11.7.7 to version archive * Bump current ESR to v11.7.7 * Bump current ESR to v11.7.7 * Add v11.8.4 placeholder changelog entry * Update deploy-rhel.rst * Update deploy-tar.rst * Update mattermost-server-releases.md * Update version-archive.rst * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update source/product-overview/version-archive.rst Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v10-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-v11-changelog.md * Update mattermost-mobile-releases.md * Update generate_changelog.py (#9099) * Update mattermost-v11-changelog.md (#9098) * Update generate_changelog.py * Update generate_changelog.py * Enhance SAML configuration instructions for Mattermost (#8914) * Enhance SAML configuration instructions for Mattermost Updated instructions for configuring SAML attributes and claims in Entra for Mattermost integration, including detailed explanations of required and additional claims. * Update sso-saml-entraid.rst * Update sso-saml-entraid.rst * Update sso-saml-entraid.rst * Add image for Tenant ID location in Entra Added an image reference for the Tenant ID location in Entra. * Add files via upload * Fix formatting of image attributes in SSO SAML guide * Update source/administration-guide/onboard/sso-saml-entraid.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update source/administration-guide/onboard/sso-saml-entraid.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update source/administration-guide/onboard/sso-saml-entraid.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update source/administration-guide/onboard/sso-saml-entraid.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update source/administration-guide/onboard/sso-saml-entraid.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add files via upload * Update source/administration-guide/onboard/sso-saml-entraid.rst Make assigning users/groups the default path in step 8; move the "Assignment required? = No" option into a warning directive that notes it grants access to all tenant users and prompts the reader to evaluate fit for their environment. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Update source/administration-guide/onboard/sso-saml-entraid.rst Clarify Sign Request step to distinguish Mattermost signing outbound AuthnRequests from Entra signing responses/assertions; specify that Entra requires RSA-SHA256 for signed requests; add missing Entra-side step to upload the SP public certificate under Verification certificates. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Combs7th <147677911+Combs7th@users.noreply.github.com> --------- Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> Co-authored-by: Sven Hüster <sven@mattermost.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Combs7th <147677911+Combs7th@users.noreply.github.com> * Update mobile-app-changelog.md * Update mattermost-v10-changelog.md * Update mattermost-v11-changelog.md * Update version-archive.rst --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> Co-authored-by: Sven Hüster <sven@mattermost.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Combs7th <147677911+Combs7th@users.noreply.github.com>
A quick fix for changelog automation to update the blog post link.