[jonathansick]

Summary

Test PR, do not merge. Exercises the build-cache exclusion in lsst-sqre/docverse-upload#50 (branch tickets/DM-56907-scrub, commit 09bca60d) against the real documenteer docs build and the production Docverse.

• Pins the Upload to Docverse step to lsst-sqre/docverse-upload@09bca60d0377049349b604232d83ae6d6814967e.
• Adds a step before the upload that plants .doctrees/environment.pickle (1 MiB), sub/.doctrees/sub.doctree (64 KiB), sub/index.html (a real page beside the nested cache) and __pycache__/x.pyc in docs/_build/html/. Sphinx already writes .buildinfo there.

Validation steps

1. In the docs job log, the Inject fake build caches step lists the planted paths.
2. The Upload to Docverse step logs Excluded N build-cache/VCS path(s) from the upload (expected: .buildinfo, .doctrees, sub/.doctrees, __pycache__).
3. The build the action comments on this PR serves sub/index.html but returns 404 for .buildinfo, .doctrees/environment.pickle and sub/.doctrees/sub.doctree.
4. The build's object_count in the Docverse API matches the previous main build plus the one real sub/index.html page, with no cache objects.

References

• DM-56907: Exclude Sphinx build caches from the uploaded tarball docverse-upload#50
• DM-56907: Filter build cache paths (.doctrees, .buildinfo, …) from uploads and syncs, and scrub existing builds docverse#853 (PRD), DM-56907: Exclude cache paths at ingest and scrub them from builds docverse#861
• Jira: DM-56907

🤖 Generated with Claude Code

[github-actions]

Documentation preview

Edition	URL
DM-56907-docverse-upload-test	https://documenteer.lsst.io/v/DM-56907-docverse-upload-test/

Build 1xvq-p5d8-17vk-13 processed successfully.

[jonathansick]

Validation results

CI run 41709373809, docs job succeeded.

Inject step planted, alongside the .buildinfo Sphinx writes itself:

docs/_build/html/.buildinfo
docs/_build/html/.doctrees/environment.pickle
docs/_build/html/__pycache__/x.pyc
docs/_build/html/sub/.doctrees/sub.doctree

Upload step (action at 09bca60d, branch tickets/DM-56907-scrub):

Excluded 4 build-cache/VCS path(s) from the upload
Built tarball at /tmp/docverse-upload-hTJmVQ/build.tar.gz (3321001 bytes)
Created build 1xvq-p5d8-17vk-13

Server side (build 1xvq-p5d8-17vk-13, edition https://documenteer.lsst.io/v/DM-56907-docverse-upload-test/):

Path	Status
/	200
/sub/index.html (planted real page)	200
/.buildinfo	404
/.doctrees/environment.pickle	404
/sub/.doctrees/sub.doctree	404
/__pycache__/x.pyc	404

Object count is 278, the same as the previous main build (1xvd-y89d-cg9y-31). That build was uploaded by the old action and still serves a 231-byte /.buildinfo, so it is 277 real pages + .buildinfo; the test build is 277 real pages + the 17-byte sub/index.html. The byte totals differ by exactly 214 bytes (13,156,170 vs 13,155,956), which is 231 − 17. No cache object reached the build.

This PR stays a draft and should be closed, not merged, once lsst-sqre/docverse-upload#50 is merged and the pin can move to a release.

[jonathansick]

Closing without merging: validation of lsst-sqre/docverse-upload#50 is complete and the action shipped as v1.1.0. The CI pin moves to the v1 tag in a separate PR.