fix(changelog): Fix broken workflow that never successfully created a PR - #18874
Open
sfanahata wants to merge 1 commit into
Open
fix(changelog): Fix broken workflow that never successfully created a PR#18874sfanahata wants to merge 1 commit into
sfanahata wants to merge 1 commit into
Conversation
Two bugs prevented the changelog automation from ever working (all 118 runs since April 2026 have failed): 1. --label 'Type: Maintenance' referenced a label that doesn't exist in the repo, causing gh pr create to exit with code 1. 2. gh pr merge was called without a PR reference, so it couldn't determine which PR to merge. Also adds set -euxo pipefail for better diagnostics on future failures, and deletes 118 orphaned bot/update-docs-changelog-* branches.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
Update Docs Changelogworkflow has been failing on every single run since it was introduced (April 3, 2026 -- 118 consecutive failures). The changelog page has been stuck showing March 2026 content.Root Cause
Two bugs in the "Create PR with changes" step of
.github/workflows/update-docs-changelog.yml:--label 'Type: Maintenance'references a label that doesn't exist in this repo.gh pr createexits with code 1 when given a nonexistent label, killing the step immediately.gh pr mergewas called without a PR reference, so it couldn't determine which PR to merge (even if bug JavaScript docs don't reference the right version #1 were fixed).Fix
--label 'Type: Maintenance'flag"$branch"togh pr mergeso it knows which PR to mergeset -euxo pipefailfor better diagnostics on any future failuresCleanup
Deleted all 118 orphaned
bot/update-docs-changelog-*branches that accumulated from the daily failing runs.Verification
node scripts/update-docs-changelog.mjslocally -- script generates 20 changelog entries successfullygh pr mergeaccepts a branch name argument (gh pr merge [<number> | <url> | <branch>])Next Steps
After merging, trigger the workflow manually via the Actions tab (
workflow_dispatch) to verify the full end-to-end flow works in CI.