Skip to content

fix: isolate documentation PRs by build target and preserve new sources - #56

Merged
KazuCocoa merged 2 commits into
masterfrom
fix/docs-timestamp-filter
Oct 27, 2026
Merged

KazuCocoa merged 2 commits into
masterfrom
fix/docs-timestamp-filter

Conversation

@KazuCocoa

@KazuCocoa KazuCocoa commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Follow-up to #55.

All documentation builds previously used the default create-pull-request/patch branch. A scheduled master build or a manual build for another release could replace changes in a pending documentation PR. Set the PR branch to create-pull-request/docs-${{ inputs.ref || 'master' }} so each build ref maintains its own PR. Scheduled runs and manual master builds share docs-master, while release builds use branches such as docs-v6.0.1.

Also fix timestamp cleanup aborting publication when a build introduces an untracked _sources/index.rst.txt in an existing tracked directory. Restrict cleanup to tracked, modified documentation index sources and read null-delimited paths.

Add five fixture-based regression tests and a dedicated CI workflow covering new sources, timestamp-only changes, substantive changes, release-only updates, and preservation of previous versions.

Validation:

  • Parsed the workflow YAML and verified that default/master builds share a branch while two release tags and a slash-containing branch use distinct valid Git branch names.
  • Reproduced the new-source failure before the fix; all five tests pass on Python 3.12 and 3.14.
  • bash -n scripts/update_docs.sh and git diff --check pass.

Full upstream Sphinx and end-to-end Actions execution were not run locally.

@KazuCocoa KazuCocoa changed the title fix: preserve new documentation sources during timestamp filtering fix: isolate documentation PRs by build target and preserve new sources Oct 27, 2026
@KazuCocoa
KazuCocoa merged commit d13ad03 into master Oct 27, 2026
2 checks passed
@KazuCocoa
KazuCocoa deleted the fix/docs-timestamp-filter branch October 27, 2026 02:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant