doc/test: Consolidate julia package utility dependencies #58574
Merged
Conversation
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
Our docsystem has the ability to install a local working copy of documenter, complete with manifest/project and local depot to keep things isolated from user packages. I recently made all of this work out of tree, and in #58559 added the same mechanism for the installation of revise in test-revise-*. However, then I realized that the docsystem also has the ability to install a copy of Reivse. Clearly a third copy of all of this is excessive. Instead, unify all the manifests into `deps/jlutilities`, so that the same Revise project/manifest is used for both doc and test. Similarly, only use one depot at `buildroot/deps/jlutilities/depot` that both systems share.
There was a problem hiding this comment.
Pull Request Overview
This PR centralizes the out-of-tree utility installs for Documenter and Revise into a single deps/jlutilities directory, removing redundant local copies in both the doc build and test workflows.
- Use a shared
deps/jlutilities/depotinstead of separatetest/depsordoc/deps - Point
Pkg.activatein tests and docs to the unifiedjlutilities/reviseandjlutilities/documenterprojects - Update the Makefile and Manifest to reference the new doc project path and bump dependency versions
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/runtests.jl | Updated DEPOT_PATH and Pkg.activate calls to use the shared jlutilities Revise setup |
| doc/make.jl | Switched documentation build to the shared jlutilities depot and project manifests |
| doc/Makefile | Adjusted the update-documenter target to use the new jlutilities/documenter project |
| deps/jlutilities/documenter/Manifest.toml | Added Zlib_jll to LibSSH2_jll deps and bumped MozillaCACerts_jll version |
Comments suppressed due to low confidence (3)
test/runtests.jl:30
- The comment about swizzling Revise to the end no longer matches the code (there’s no push or pop after loading). Consider removing or updating this comment to reflect the new workflow.
# Once it's loaded, we swizzle it to the end, to avoid confusing any tests.
doc/make.jl:27
- This uses
buildrootwhereas the original doc build usedbuildrootdoc. Confirm that mixing the two variables is intentional, or switch back tobuildrootdocto isolate the docs depot.
push!(DEPOT_PATH, joinpath(buildroot, "deps", "jlutilities", "depot"))
doc/make.jl:317
- After instantiating the Revise project you should
using Revise(or explicitly import it) before relying on its functionality in the doc build.
Pkg.instantiate()
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.
Our docsystem has the ability to install a local working copy of documenter, complete with manifest/project and local depot to keep things isolated from user packages. I recently made all of this work out of tree, and in #58559 added the same mechanism for the installation of revise in test-revise-*. However, then I realized that the docsystem also has the ability to install a copy of Reivse. Clearly a third copy of all of this is excessive. Instead, unify all the manifests into
deps/jlutilities, so that the same Revise project/manifest is used for both doc and test. Similarly, only use one depot atbuildroot/deps/jlutilities/depotthat both systems share.