Skip to content

ci(docs): previews on request, cleaned up when the PR is closed - #361

Open
ocots wants to merge 1 commit into
mainfrom
ci/docs-preview-label
Open

ocots wants to merge 1 commit into
mainfrom
ci/docs-preview-label

Conversation

@ocots

@ocots ocots commented Oct 15, 2026

Copy link
Copy Markdown
Member

Summary

Aligns the documentation workflow with the other packages (CTBase, CTModels, CTDirect, CTFlows, CTSolvers) and with SITE13 (control-toolbox/ct-conventions#36):

  • On a PR, run documentation is the only trigger. documentation push preview is a modifier that also deploys the preview. docs/make.jl reads push_preview from DOCUMENTER_PUSH_PREVIEW, which CTActions sets from that label, instead of deploying every PR build.
  • deploydocs had no push_preview, so the preview label would have had no effect.
  • New DocPreviewCleanup.yml: when a PR is closed, removes from gh-pages the previews of every closed PR, which also clears the existing backlog. It can also be run by hand. Needs Remove documentation previews of closed PRs; docs concurrency and probes in WORKFLOWS.md CTActions#94 merged first.

Test plan

  • run documentation on this PR: builds, no preview deployed
  • After CTActions#94: run Documentation preview cleanup by hand

🤖 Generated with Claude Code

… up on close

- 'run documentation' is the only trigger; 'documentation push preview'
  also deploys the PR preview (DOCUMENTER_PUSH_PREVIEW read in make.jl).
- DocPreviewCleanup.yml removes previews of closed PRs from gh-pages
  (control-toolbox/CTActions#94).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ocots

ocots commented Oct 15, 2026

Copy link
Copy Markdown
Member Author

cc @jbcaillau

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants