fix(site): respect protected version sync branch - #3
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the scheduled website version sync workflow to avoid pushing directly to protected main by instead creating an automation pull request, squash-merging it, and then explicitly triggering a GitHub Pages build.
Changes:
- Add
pull-requests: writepermission and switch the workflow from directgit push ...:maintogh pr create+gh pr merge. - Add idempotency logic to detect an already-open version-sync PR and skip creating a duplicate.
- Gate the Pages build request on whether the automation PR was actually merged.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| test/site_test.py | Updates workflow-content assertions to match the new PR-based sync approach and required permissions. |
| .github/workflows/sync-site-version.yml | Reworks the version sync job to create/merge an automation PR and then request a Pages build, compatible with protected branches. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+59
to
+63
| branch="automation/sync-site-version-${VERSION}" | ||
| existing_pr="$(gh pr list --base main --head "$branch" --state open --json number --jq '.[0].number')" | ||
| if [[ -n "$existing_pr" ]]; then | ||
| printf 'merged=false\n' >> "$GITHUB_OUTPUT" | ||
| printf 'An open version-sync PR already exists: #%s\n' "$existing_pr" |
| git commit -m "docs(site): sync version to ${VERSION}" | ||
| git push origin HEAD:main | ||
| git push --set-upstream origin "$branch" | ||
| pr_url="$(gh pr create --base main --head "$branch" --title "docs(site): sync version to ${VERSION}" --body "Automated website version update from \`VERSION\`.")" |
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
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.
Summary\n- update the weekly version sync to use a dedicated automation PR instead of pushing directly to protected
main\n- squash-merge that PR, then explicitly request the Pages build\n- retain idempotency when an automation PR is already open\n\n## Verification\n-make test\n-make lint\n-node --check docs/assets/site.js\n- YAML parse and staged Gitleaks scan