chore(deps): pin Sphinx build dependencies to exact versions#62
Merged
Conversation
requirements.txt used loose lower-bound specifiers for antsibull-docs, sphinxcontrib-mermaid, and sphinx-sitemap, so two checkouts could resolve different versions. Pin all build dependencies to exact versions for reproducible builds. Renovate keeps them current via the pip manager from the org renovate-base preset. Signed-off-by: Simon Bärlocher <s.baerlocher@sbaerlocher.ch>
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Clean, low-risk hardening. The three direct build dependencies that previously used range/lower-bound specifiers (antsibull-docs, sphinxcontrib-mermaid, sphinx-sitemap) are now exact-pinned, consistent with the already-pinned ansible-pygments and sphinx-ansible-theme. Verified there's no duplication with versions.env (collection versions only) and that Renovate is configured via the org renovate-base preset to bump these pins.
One non-blocking nit left inline: pinning only direct deps leaves the transitive tree unpinned, so "reproducible builds" is partial — a constraints/lock file would close that gap if full reproducibility is the goal. Not a blocker.
Address review feedback: the comment claimed 'reproducible builds', but only the direct dependencies are pinned — transitive deps still float. Reword to scope the claim to direct deps and note a pip-compile constraints file as the follow-up if the floating tree causes drift. Signed-off-by: Simon Bärlocher <s.baerlocher@sbaerlocher.ch>
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
requirements.txtused loose lower-bound specifiers (antsibull-docs >=2.24.0,<3.0.0,sphinxcontrib-mermaid>=2.0.2,sphinx-sitemap>=2.9.0), so two checkouts could resolve to different versions.renovate-basepreset (already extended in.github/renovate.json).Test plan
Build Documentation(incl. linkcheck) green with the pinned versionsNotes
From the Notion "Repo Ideas" backlog for
guide. This closes the last actionable guide idea; the remaining backlog cards (facet search, incremental builds) were closed as low-ROI.