Skip to content

fix(site): respect protected version sync branch #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
foobarto merged 1 commit into from
Aug 13, 2026
Merged

fix(site): respect protected version sync branch #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions .github/workflows/sync-site-version.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ on:
- cron: "17 5 * * 1"
workflow_dispatch:

# The workflow commits a one-line website change, then explicitly requests a
# Pages build. GITHUB_TOKEN commits do not trigger a GitHub Pages build.
# The workflow creates a protected-branch-compliant version-sync PR, squash
# merges it, then explicitly requests a Pages build. GITHUB_TOKEN merges do
# not trigger a GitHub Pages build.
permissions:
contents: write
pages: write
pull-requests: write

concurrency:
group: sync-site-version
Expand Down Expand Up @@ -47,19 +49,33 @@ jobs:
printf 'changed=true\n' >> "$GITHUB_OUTPUT"
fi

- name: Commit the current Devbox version
- name: Create and merge the version-sync pull request
if: steps.update.outputs.changed == 'true'
id: merge
env:
GH_TOKEN: ${{ github.token }}
VERSION: ${{ steps.version.outputs.version }}
run: |
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"
Comment on lines +59 to +63
exit 0
fi

git switch -c "$branch"
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add docs/index.html
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\`.")"
gh pr merge "$pr_url" --squash --delete-branch
printf 'merged=true\n' >> "$GITHUB_OUTPUT"

- name: Request a GitHub Pages build
if: steps.update.outputs.changed == 'true'
if: steps.merge.outputs.merged == 'true'
env:
GH_TOKEN: ${{ github.token }}
run: gh api --method POST "repos/${GITHUB_REPOSITORY}/pages/builds"
4 changes: 3 additions & 1 deletion test/site_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,11 @@ def test_version_sync_workflow_updates_and_deploys_only_when_needed(self):
self.assertIn("scripts/update-site-version.py", workflow)
self.assertIn("contents: write", workflow)
self.assertIn("pages: write", workflow)
self.assertIn("pull-requests: write", workflow)
self.assertIn("ref: main", workflow)
self.assertIn("git diff --quiet -- docs/index.html", workflow)
self.assertIn("git push origin HEAD:main", workflow)
self.assertIn("gh pr create --base main", workflow)
self.assertIn("gh pr merge \"$pr_url\" --squash --delete-branch", workflow)
self.assertIn('gh api --method POST "repos/${GITHUB_REPOSITORY}/pages/builds"', workflow)


Expand Down