CI #1157: simplify versioned docs deployment#1175
Merged
Conversation
- Rewrite docs.yml: dev/ auto-deploys on every push to main; tagged releases deploy on manual workflow_dispatch only. Use peaceiris destination_dir (no force_orphan) so old version dirs persist without a zip download/rebuild cycle. - Add scripts/make_switcher.py: generates switcher.json from git tags with pruning (all patches for current major.minor, latest patch only for older minors). Run as part of release process. - Add .github/pages/index.html: redirect to dev/ (replaces the hand-maintained index.html table). - Delete .github/scripts/define_versions.sh: no longer needed. - Regenerate switcher.json from current git tags. Generated by OpenCode (argo/claudesonnet46)
- Include latest rc for a patch only when no final release exists. - Drop all rc tags for a patch once the final release is tagged. - Only the latest rc per base version is kept (not older rcs). - rc tags are never marked as (latest) in the switcher — only the highest final release gets that label. Generated by OpenCode (argo/claudesonnet46)
Generated by OpenCode (argo/claudesonnet46)
The feedstock clone lives outside the apstools repo directory (anywhere on the filesystem). Add one-time setup instructions and make Step 3 explicit that feedstock commands run in that separate local clone, not inside the apstools directory. Generated by OpenCode (argo/claudesonnet46)
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
1 participant
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
dev/auto-deploys on every push tomain— no manual trigger needed for development docs.workflow_dispatchwithdeploy: true) — publishes to<VERSION>/subdirectory; old versions persist automatically (no zip download/rebuild cycle).force_orphanremoved —peaceiris/actions-gh-pageswithdestination_dirandkeep_files: truenow handles incremental updates without rebuilding the entire gh-pages tree.define_versions.shdeleted — no longer needed.scripts/make_switcher.pyadded — generatesswitcher.jsonfrom git tags with pruning rule (all patches for currentmajor.minor, latest-patch-only for older minors). Run as part of the release process, commit result tomain.index.htmlsimplified to a redirect todev/(replaces the hand-maintained version table).Release process (replaces three hand-maintained files)
git tag 1.7.10 && git push origin 1.7.10python scripts/make_switcher.pygit add docs/source/_static/switcher.json && git commit -m "DOC: update switcher.json for 1.7.10" && git pushdeploy: true