Skip to content

Fix changelog automation workflow#8937

Open
amyblais wants to merge 1 commit intomasterfrom
amyblais-changelogfix
Open

Fix changelog automation workflow#8937
amyblais wants to merge 1 commit intomasterfrom
amyblais-changelogfix

Conversation

@amyblais
Copy link
Copy Markdown
Member

@amyblais amyblais commented May 6, 2026

Quick fix for the changelog automation workflow based on the failure at https://github.com/mattermost/docs/actions/runs/25428124725.

@amyblais amyblais requested review from NARSimoes and Copilot May 6, 2026 10:06
@amyblais amyblais added the 1: Dev Review Requires review by a core commiter label May 6, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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-id instead of app-id for both the read-token and write-token GitHub Apps.

Comment thread .github/workflows/generate-changelog.yml
Comment thread .github/workflows/generate-changelog.yml
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2026

📝 Walkthrough

Walkthrough

The GitHub Actions workflow for changelog generation is updated to pass client-id instead of app-id to the GitHub App token creation action in two steps (read token and write token).

Changes

Workflow Configuration Update

Layer / File(s) Summary
GitHub App Token Parameters
.github/workflows/generate-changelog.yml
Two calls to create-github-app-token action replace the input parameter from app-id to client-id on lines 41 and 54.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • mattermost/docs#8824: Updates the same generate-changelog workflow to pass client-id instead of app-id to the GitHub App token action.
  • mattermost/docs#8916: Modifies the same workflow's changelog automation token generation for both read and write GitHub App tokens.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Fix changelog automation workflow' directly relates to the changeset, which updates the GitHub Actions workflow file to fix a failure in the changelog automation process.
Description check ✅ Passed The description references a specific workflow failure and indicates this is a quick fix to address it, which is directly related to the changeset modifying the workflow file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch amyblais-changelogfix

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
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.

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 win

Hardcoded CHANGELOG_PATH will silently write future changelogs into the wrong file.

source/product-overview/mattermost-v11-changelog.md is fixed regardless of the version input. 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.md

Note: this assumes the changelog filename encodes the minor version only (e.g. 10.6mattermost-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

📥 Commits

Reviewing files that changed from the base of the PR and between a1052c0 and d8218f0.

📒 Files selected for processing (1)
  • .github/workflows/generate-changelog.yml

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

Newest code from mattermost has been published to preview environment for Git SHA d8218f0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1: Dev Review Requires review by a core commiter

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants