gitmodules: Disable update to prevent cloning on cargo checkout
#808
Conversation
This file contains 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
When using a `git` reference on this repo, `cargo` will unnecessarily clone the `Vulkan-Headers` submodule (which is only needed by maintainers together with the `generator`). By setting the update mode to `none` (https://git-scm.com/docs/gitmodules#Documentation/gitmodules.txt-submoduleltnamegtupdate) this is disabled, and `git submodule update` will now also no longer fetch/clone/update the repository unless `--checkout` is used (https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt-checkout). I.e. running `cargo update` on a repo with a `git` dependency on `ash`: Updating git repository `https://github.com/ash-rs/ash` Skipping git submodule `https://github.com/KhronosGroup/Vulkan-Headers` due to update strategy in .gitmodules
MarijnS95
force-pushed
the
submodule-disable-update
branch
from
2b6a33e
to
c358c52
Compare
MarijnS95
commented
Oct 30, 2023
Comment on lines
-36
to
+37
| submodules: true | ||
| - name: Checkout submodule | ||
| # Manually update submodules with --checkout because they are configured with update=none and will be skipped otherwise | ||
| run: git submodule update --recursive --init --force --checkout |
There was a problem hiding this comment.
JFYI, I tested whether setting submodules: checkout might be an undocumented feature where --checkout is added to the submodule update command, but no dice. It only seems to check for == "true".
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.
When using a
gitreference on this repo,cargowill unnecessarily clone theVulkan-Headerssubmodule (which is only needed by maintainers together with thegenerator). By setting the update mode tonone(https://git-scm.com/docs/gitmodules#Documentation/gitmodules.txt-submoduleltnamegtupdate) this is disabled, andgit submodule updatewill now also no longer fetch/clone/update the repository unless--checkoutis used (https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt-checkout).I.e. running
cargo updateon a repo with agitdependency onash: