Skip to content

fix(changelog): Merge bot PR with --admin so updates actually land - #19490

Merged
coolguyzone merged 3 commits into
masterfrom
coolguyzone/fix/changelog-auto-merge
Sep 18, 2026
Merged

coolguyzone merged 3 commits into
masterfrom
coolguyzone/fix/changelog-auto-merge

Conversation

@coolguyzone

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

The public changelog at docs.sentry.io/changelog stopped updating after Aug 12, 2026. Root cause: the weekly Update Docs Changelog workflow still regenerates the file and opens a bot PR correctly, but it merged with gh pr merge --auto. Branch protection on master requires an approving review that the bot PR never receives, so --auto sits BLOCKED forever. Five bot PRs have piled up unmerged since Aug 17 (#19071, #19087, #19186, #19285, #19389).

This switches the merge to --admin --delete-branch, matching the proven pattern in bump-api-schema-sha.yml (whose bot PRs merge fine).

  • Use --admin to bypass the required review and required checks (including lint-404, which flags not-yet-deployed doc links in freshly generated changelog content)
  • Add --delete-branch to avoid stale bot branches
  • The generated file is fully bot-authored, so admin merge is safe

The 5 stale bot PRs are being closed separately; a fresh workflow_dispatch run after this merges will land the backlog.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

The weekly changelog workflow regenerates includes/docs-changelog.mdx and
opens a bot PR, but merged it with `gh pr merge --auto`. Branch protection on
master requires an approving review, which the bot PR never receives, so every
run since Aug 17 piled up an unmerged PR and the public changelog stopped
updating (last landed Aug 12).

Switch to `--admin --delete-branch`, matching bump-api-schema-sha.yml, to
bypass the review requirement and required checks (including lint-404, which
flags not-yet-deployed links in freshly generated changelog content). The file
is fully bot-generated, so admin merge is safe.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
develop-docs Ready Ready Preview Sep 18, 2026 10:38pm UTC
sentry-docs Ready Ready Preview Sep 18, 2026 10:38pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Sep 17, 2026
Comment thread .github/workflows/update-docs-changelog.yml
Regenerates includes/docs-changelog.mdx so the Vercel preview shows the
up-to-date changelog and merging this PR immediately publishes the ~5 weeks of
entries that never landed while the bot PRs were stuck.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Versioned files like configuration/index__v7.x.mdx resolve to
<path>__v7.x/, not <path>/index__v7.x/, so the changelog's path-to-URL
mapping emitted a broken link that the lint-404 check flags. Skip files
containing the __v version indicator; the current version of the page is
almost always edited in the same PR and linked separately.

Regenerates includes/docs-changelog.mdx accordingly.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coolguyzone
coolguyzone merged commit 79d0d4f into master Sep 18, 2026
22 checks passed
@coolguyzone
coolguyzone deleted the coolguyzone/fix/changelog-auto-merge branch September 18, 2026 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants