Skip to content

Docs automation fixes#9090

Merged
amyblais merged 6 commits into
masterfrom
amyblais-docsautomation
Jul 13, 2026
Merged

Docs automation fixes#9090
amyblais merged 6 commits into
masterfrom
amyblais-docsautomation

Conversation

@amyblais

@amyblais amyblais commented Jul 10, 2026

Copy link
Copy Markdown
Member

@amyblais
amyblais marked this pull request as ready for review July 10, 2026 08:01
Copilot AI review requested due to automatic review settings July 10, 2026 08:01
@amyblais amyblais added the 1: Dev Review Requires review by a core commiter label Jul 10, 2026
@amyblais
amyblais requested a review from NARSimoes July 10, 2026 08:01
@github-actions

Copy link
Copy Markdown
Contributor

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 updates GitHub Actions workflows in the Mattermost docs repo to fix/align automation around (1) syncing labels back to the originating dev PR when a docs PR closes, and (2) creating the next version docs branch after a version branch is merged.

Changes:

  • Update actions/create-github-app-token usage to pass client-id (matching the other automation workflows in this repo).
  • Adjust milestone selection logic to run the JQ filter via standalone jq (enabling --arg usage), used to compute the next docs branch name.
  • Minor whitespace/blank-line normalization in workflow YAML.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
.github/workflows/docs-pr-sync.yml Aligns GitHub App token generation input to client-id; whitespace normalization.
.github/workflows/docs-branch-create.yml Aligns token generation input to client-id; changes milestone query to use standalone jq with --arg for version comparison.

Comment thread .github/workflows/docs-branch-create.yml
@github-actions

Copy link
Copy Markdown
Contributor

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

@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 740878dc-efc2-40ab-9c4a-38d61180a909

📥 Commits

Reviewing files that changed from the base of the PR and between e2c6975 and c5a38d3.

📒 Files selected for processing (2)
  • .github/workflows/docs-branch-create.yml
  • .github/workflows/docs-pr-sync.yml
💤 Files with no reviewable changes (2)
  • .github/workflows/docs-pr-sync.yml
  • .github/workflows/docs-branch-create.yml

📝 Walkthrough

Walkthrough

The pull request updates two documentation GitHub Actions workflows. It changes milestone lookup and branch creation in the branch workflow, updates GitHub App token input naming, and preserves docs PR parsing, label synchronization, and commenting behaviour.

Changes

Documentation workflow updates

Layer / File(s) Summary
Milestone lookup and workflow setup
.github/workflows/docs-branch-create.yml
Workflow formatting is adjusted, and milestone data is paginated through jq before deriving the documentation branch.
Documentation branch creation
.github/workflows/docs-branch-create.yml
Branch existence is checked explicitly; missing branches are created from the master commit SHA.
Docs PR synchronization
.github/workflows/docs-pr-sync.yml
The GitHub App input uses client-id; PR resolution, label updates, and status comments remain functionally equivalent.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and broadly matches the docs automation workflow changes.
Description check ✅ Passed The description references the related Mattermost PR and is not off-topic.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch amyblais-docsautomation

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

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

Inline comments:
In @.github/workflows/docs-branch-create.yml:
- Around line 134-163: Update the gh api milestones pipeline to use jq slurp
mode and flatten all paginated response arrays before applying JQ_FILTER,
ensuring milestone sorting and selection occur across every page. Keep
NEXT_TITLE as a single result so VERSION and DOCS_BRANCH derive from the
globally earliest matching milestone.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 35d19c29-4edb-4bd7-b503-42a5323a78d5

📥 Commits

Reviewing files that changed from the base of the PR and between 9743de3 and 3e99f84.

📒 Files selected for processing (2)
  • .github/workflows/docs-branch-create.yml
  • .github/workflows/docs-pr-sync.yml

Comment thread .github/workflows/docs-branch-create.yml
@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown
Contributor

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

@amyblais
amyblais merged commit 784e143 into master Jul 13, 2026
5 checks passed
@amyblais
amyblais deleted the amyblais-docsautomation branch July 13, 2026 07:31
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.

3 participants