Skip to content

ci(docs): gate preview pushes behind label #643

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
ocots merged 1 commit into from
Oct 15, 2026
Merged

ci(docs): gate preview pushes behind label #643

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
8 changes: 6 additions & 2 deletions .github/workflows/Documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,14 @@ jobs:
# re-run this job on every subsequent label add. Only react to 'labeled' when it's
# this specific label; for other trigger types (synchronize/reopened), fall back to
# checking the current label set as before.
# On a PR, `run documentation` is the only trigger. `documentation push preview` is a
# modifier: with `run documentation` present, the build also deploys its preview.
if: >
github.event_name != 'pull_request' ||
(github.event.action == 'labeled' && github.event.label.name == 'run documentation') ||
(github.event.action != 'labeled' && contains(github.event.pull_request.labels.*.name, 'run documentation'))
(contains(github.event.pull_request.labels.*.name, 'run documentation') &&
(github.event.action != 'labeled' ||
github.event.label.name == 'run documentation' ||
github.event.label.name == 'documentation push preview'))
uses: control-toolbox/CTActions/.github/workflows/documentation.yml@main
with:
use_ct_registry: true
Expand Down
8 changes: 7 additions & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,10 @@ with_api_reference(src_dir, ext_dir) do api_pages
end

# ═══════════════════════════════════════════════════════════════════════════════
deploydocs(; repo=repo_url * ".git", devbranch="main")
# PR previews are opt-in: CTActions sets DOCUMENTER_PUSH_PREVIEW to "true" only on a
# PR carrying the `documentation push preview` label.
deploydocs(;
repo=repo_url * ".git",
devbranch="main",
push_preview=get(ENV, "DOCUMENTER_PUSH_PREVIEW", "false") == "true",
)
Loading