Skip to content

docs: fix gh-pages races and fix manual dispatch for docs publish workflow #2420

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

Open
sespiros wants to merge 2 commits into
base: main
Choose a base branch
from
+7 −2
Open

docs: fix gh-pages races and fix manual dispatch for docs publish workflow #2420

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
469a7cd
ci: serialize docs deploys to avoid gh-pages races
sespiros May 27, 2026
d2cfd53
ci: allow manual dispatch of docs publish workflow
sespiros May 27, 2026
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
9 changes: 7 additions & 2 deletions .github/workflows/docs_publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,21 @@ permissions:
contents: write
pull-requests: write

concurrency:
group: docs-deploy-${{ github.event_name == 'pull_request' && format('pr-{0}', github.event.number) || 'production' }}
cancel-in-progress: true

jobs:
deploy:
name: Publish docs to GitHub Pages
runs-on: ubuntu-24.04
# Prevent the job from running on forked PRs, for security reasons.
if: |
(github.event_name == 'push' && github.ref_name == 'main') ||
(github.repository_owner == github.event.pull_request.head.repo.owner.login)
github.event_name == 'workflow_dispatch' ||
(github.event_name == 'pull_request' && github.repository_owner == github.event.pull_request.head.repo.owner.login)
env:
PREVIEW: ${{ !(github.event_name == 'push' && github.ref_name == 'main') }}
PREVIEW: ${{ github.event_name == 'pull_request' }}
Copy link
Copy Markdown
Collaborator

@charludo charludo May 28, 2026

Choose a reason for hiding this comment

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

Does this not mean a manual dispatch does a real publication? IMO that should not be possible unless we merge into main. What's the motivation behind the condition change?

Copy link
Copy Markdown
Collaborator Author

@sespiros sespiros May 28, 2026

Choose a reason for hiding this comment

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

Yes. Yesterday I merged the update release PR and another docs change PR (to update the debugshell page). These triggered 2 gh-pages publish jobs which they raced and as a result the release to main docs got published but my changes to the debugshell docs didn't (you can visit the docs->next and check the debugshell page). The docs will be updated when some other update to main touches the docs but I don't see why couldn't we dispatch the workflow ourselves.

SET: base
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
Expand Down
Loading