Add flag --submodules to add git submodules in the project folder as available packages. #1780
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| Support for git submodules as packages | ||
|
|
||
| Dub now supports the flag `--submodules`, which will scan the root folder for git submodules and add them as | ||
| available packages. | ||
| The git tag on the repository defines the version of the package. |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // functionality to supply packages from git submodules | ||
| module dub.git; | ||
|
|
||
| import dub.dependency; | ||
| import dub.internal.vibecompat.core.file; | ||
| import dub.package_; | ||
| import dub.packagemanager; | ||
|
|
||
| import std.algorithm; | ||
| import std.ascii : newline; | ||
| import std.exception : enforce; | ||
| import std.range; | ||
| import std.string; | ||
|
|
||
| /** Adds the git submodules checked out in the root path as direct packages. | ||
| Package version is derived from the submodule's tag by `getOrLoadPackage`. | ||
|
|
||
| Params: | ||
| packageManager = Package manager to track the added packages. | ||
| rootPath = the root path of the git repository to check for submodules. | ||
| */ | ||
| public void addGitSubmodules(PackageManager packageManager, NativePath rootPath) { | ||
| import std.process : execute; | ||
|
|
||
| auto rootScmPath = rootPath ~ ".git"; | ||
| const submoduleInfo = execute([ | ||
| "git", | ||
| "-C", rootPath.toNativeString, | ||
| "--git-dir=" ~ (rootScmPath.relativeTo(rootPath)).toNativeString, | ||
| "submodule", "status"]); | ||
|
|
||
| enforce(submoduleInfo.status == 0, | ||
| format("git submodule status exited with error code %s: %s", submoduleInfo.status, submoduleInfo.output)); | ||
|
|
||
| foreach (line; submoduleInfo.output.lines) { | ||
| const parts = line.split(" ").map!strip.filter!(a => !a.empty).array; | ||
| const subPath = rootPath ~ parts[1]; | ||
|
There was a problem hiding this comment. Can't we do sth. less fragile? There was a problem hiding this comment. I'm also not enthused about it, but I'm not sure how to improve on it. There was a problem hiding this comment. Bash code to enumerate registered active submodules: git config -lz | \
while IFS=$'\n' read -r -d '' name value
do
if [[ "$name" =~ ^submodule\.(.*)\.url$ || ( "$name" =~ ^submodule\.(.*)\.active$ && "$value" == true ) ]]
then
printf '%s\0' "${BASH_REMATCH[1]}"
fi
done | \
sort -uz | \
mapfile -d '' -t listSee https://git-scm.com/docs/gitsubmodules#_active_submodules for reference. To get the submodule git dir (of an absorbed module): git rev-parse --git-path modules/"$m"where To get the submodule work dir: git -C "$md" rev-parse --show-toplevelwhere There was a problem hiding this comment. For this purpose probably we want to look at unregistered submodules too (i.e. submodule entries in the tree). In which case, the equivalent of: git ls-tree -r --full-tree HEAD -z | grep -z '^160000 ' | cut -z -d $'\t' -f 2 | xargs -0 printf '%s\n'would be more appropriate. Then, just check for a |
||
| const packageFile = Package.findPackageFile(subPath); | ||
|
|
||
| if (packageFile != NativePath.init) { | ||
| const scmPath = rootPath ~ NativePath(".git/modules/" ~ parts[1]); | ||
| packageManager.getOrLoadPackage(subPath, packageFile, false, scmPath); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private alias lines = text => text.split(newline).map!strip.filter!(a => !a.empty); | ||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| #!/usr/bin/env bash | ||
| set -e | ||
|
|
||
| . $(dirname "${BASH_SOURCE[0]}")/common.sh | ||
|
|
||
| LAST_DIR=$PWD | ||
| TEMP_DIR="submodule-test" | ||
|
|
||
| function cleanup { | ||
| cd "$LAST_DIR" | ||
| rm -rf "$TEMP_DIR" | ||
| } | ||
| trap cleanup EXIT | ||
|
|
||
| mkdir "$TEMP_DIR" | ||
| cd "$TEMP_DIR" | ||
|
|
||
| mkdir -p dependency/src | ||
|
|
||
| cat << EOF >> dependency/dub.sdl | ||
| name "dependency" | ||
| sourcePaths "src" | ||
| EOF | ||
|
|
||
| cat << EOF >> dependency/src/foo.d | ||
| module foo; | ||
| void foo() { } | ||
| EOF | ||
|
|
||
| function git_ { | ||
| git -C dependency -c "user.name=Name" -c "user.email=Email" "$@" | ||
| } | ||
| git_ init | ||
| git_ add dub.sdl | ||
| git_ add src/foo.d | ||
| git_ commit -m "first commit" | ||
| git_ tag v1.0.0 | ||
|
|
||
| mkdir project | ||
|
|
||
| cat << EOF >> project/dub.sdl | ||
| name "project" | ||
| mainSourceFile "project.d" | ||
| targetType "executable" | ||
| dependency "dependency" version="1.0.0" | ||
| EOF | ||
|
|
||
| cat << EOF >> project/project.d | ||
| module project; | ||
| import foo : foo; | ||
| void main() { foo(); } | ||
| EOF | ||
|
|
||
| function git_ { | ||
| git -C project -c "user.name=Name" -c "user.email=Email" "$@" | ||
| } | ||
| git_ init | ||
| git_ add dub.sdl | ||
| git_ add project.d | ||
| git_ submodule add ../dependency dependency | ||
| git_ commit -m "first commit" | ||
|
|
||
| # dub should now pick up the dependency | ||
| $DUB --root=project --submodules run | ||
|
|
||
| if ! grep -c -e "\"dependency\": \"1.0.0\"" project/dub.selections.json; then | ||
| die $LINENO "Dependency version was not identified correctly." | ||
| fi |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is
--git-dirnecessary here? It was necessary in conjunction with--work-treebefore-Cwas introduced.