Conversation
There was a problem hiding this comment.
Pull request overview
This PR aims to fix the changelog generation GitHub Actions workflow by adjusting the inputs passed to the actions/create-github-app-token steps so the automation can successfully obtain GitHub App tokens and create/update changelog PRs.
Changes:
- Updates the token-generation steps to pass
client-idinstead ofapp-idfor both the read-token and write-token GitHub Apps.
📝 WalkthroughWalkthroughThe GitHub Actions workflow for changelog generation is updated to pass ChangesWorkflow Configuration Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/workflows/generate-changelog.yml (1)
79-79:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winHardcoded
CHANGELOG_PATHwill silently write future changelogs into the wrong file.
source/product-overview/mattermost-v11-changelog.mdis fixed regardless of theversioninput. Running the workflow for v12+ will append content to the v11 file instead of the appropriate one.🛠️ Suggested fix — derive the path from the `version` input
- CHANGELOG_PATH: source/product-overview/mattermost-v11-changelog.md + CHANGELOG_PATH: source/product-overview/mattermost-v${{ inputs.version }}-changelog.mdNote: this assumes the changelog filename encodes the minor version only (e.g.
10.6→mattermost-v10.6-changelog.md). Adjust the expression if the major-version grouping (v11) is intentional and a separate mapping is needed.🤖 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/workflows/generate-changelog.yml at line 79, The hardcoded CHANGELOG_PATH will always point to source/product-overview/mattermost-v11-changelog.md; update the workflow to compute CHANGELOG_PATH from the workflow input (the version input) instead of a fixed string — read the version input (e.g., inputs.version or github.event.inputs.version) and build the filename using the expected pattern (e.g., mattermost-v{minor-major?}-changelog.md or mattermost-v{version}-changelog.md depending on your naming convention), then set CHANGELOG_PATH to that constructed value so running the workflow for v12+ writes to the correct file.
🤖 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.
Outside diff comments:
In @.github/workflows/generate-changelog.yml:
- Line 79: The hardcoded CHANGELOG_PATH will always point to
source/product-overview/mattermost-v11-changelog.md; update the workflow to
compute CHANGELOG_PATH from the workflow input (the version input) instead of a
fixed string — read the version input (e.g., inputs.version or
github.event.inputs.version) and build the filename using the expected pattern
(e.g., mattermost-v{minor-major?}-changelog.md or
mattermost-v{version}-changelog.md depending on your naming convention), then
set CHANGELOG_PATH to that constructed value so running the workflow for v12+
writes to the correct file.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 388db96a-f75a-4f65-b56b-60de8c7313ed
📒 Files selected for processing (1)
.github/workflows/generate-changelog.yml
|
Newest code from mattermost has been published to preview environment for Git SHA d8218f0 |
|
Newest code from mattermost has been published to preview environment for Git SHA 8d33775 |
|
Newest code from mattermost has been published to preview environment for Git SHA 16ed2e1 |
|
Newest code from mattermost has been published to preview environment for Git SHA 3d8cad2 |
|
Newest code from mattermost has been published to preview environment for Git SHA c911c96 |
|
Re-requesting a review as I added a few other minor fixes. |
|
Newest code from mattermost has been published to preview environment for Git SHA c703e1d |
|
Newest code from mattermost has been published to preview environment for Git SHA 6fd3820 |
Quick fix for the changelog automation workflow based on the failure at https://github.com/mattermost/docs/actions/runs/25428124725.
Added a few additional minor fixes.