{{ message }}
Repository navigation
docs: Update min requirements - #49496
Draft
joestringer wants to merge 8 commits into
Draft
joestringer wants to merge 8 commits into
joestringer wants to merge 8 commits into
Conversation
The docs-builder image build workflows have created some pain during maintenance due to the way that the files have been managed, including: * docs-builder image tag was calculated from all Documentation/ content. This means that _any_ change to Documentation files would cause the builder to need to be rebuilt. * Documentation/Makefile contains the docs-builder image tag, meaning that any time we update the docs-builder tag, it updates the input used to calculate the docs-builder tag. As soon as you make one change to any docs file dependency, the docs-builder update GitHub workflows would always trigger the deployment to rebuild the docs-builder image, even if all changes to the docs-builder have been accounted for. * Due to these discrepancies, there has been no way to detect whether the docs-builder needs updating, so the regular Documentation build did not depend on building a docs-builder image with the latest dependencies. This lead to cases where we would review and merge docs dependency updates without actually building the docs using the new dependencies. Move all of the build infrastructure for creating the docs-builder images under the images/ directory. By reducing the set of input files for calculating the builder sha to only the minimal dependencies under images/docs-builder directory, we can update the docs-builder only when the dependencies update, rather than any time there is any change in the documentation. Co-authored-by: André Martins <andre@cilium.io> Signed-off-by: Joe Stringer <joestringernz@gmail.com>
Mount the original host copy of the git repository into the docker containers when generating the requirements.txt so that a full build can be performed from a git worktree. Signed-off-by: Joe Stringer <joe@cilium.io>
This new make target will check the docker tag for the docs-builder image based on dependencies in the images/docs-builder/ directory, and update the tag in all relevant locations if the tag would differ. This target is only intended to create the diff so that there is a hard dependency on the new builder image tag value, but it will not update the $DOCS_BUILDER_IMG variable to the new fully specified image. Add this new target to the 'builder-image' target so that any time the builder image is updated, the files in the tree are also updated. This should help to signal when the docs-builder references need to be updated. Signed-off-by: Joe Stringer <joe@cilium.io>
To ensure that the documentation directory is built against the latest copy of the docs-builder dependencies, add a check which updates the docs-builder image tag based on the docs-builder dependencies in the git tree, and then fail out with a message requiring the user to update the docs-builder image if the local tree is out of sync. This should ensure that renovate docs-builder updates are tested before we merge the changes, by virtue of being run from the standard GitHub workflow for documentation checks. Signed-off-by: Joe Stringer <joe@cilium.io>
Bump these to versions that have been released relatively recently. Readthedocs lists Python 3.14 as a supported build dependency, so pick that over more recent releases that are not yet listed on their site. Signed-off-by: Joe Stringer <joe@cilium.io>
Signed-off-by: Joe Stringer <joe@cilium.io>
Signed-off-by: Joe Stringer <joe@cilium.io>
maintainer-s-little-helper
Bot
added
the
dont-merge/needs-release-note-label
joestringer
added
release-note/misc
maintainer-s-little-helper
Bot
removed
the
dont-merge/needs-release-note-label
Update the documentation dependencies: $ pur -r Documentation/requirements-min/requirements.txt ... $ make -C Documentation update-requirements ... Signed-off-by: Joe Stringer <joe@cilium.io>
joestringer
force-pushed
the
pr/joe/docs-dependencies+test
branch
from
October 20, 2026 16:32
5ae4fbc to
bb72be3
Compare
This branch has not been deployed
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
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.
Apply 'pur -r Documentation/requirements-min/requirements.txt' to update
the docs dependencies.
This PR also helps to test the changes proposed in #49482.