Add Support for Submodule Versioning #23

baxterjo · 2023-11-05T23:52:44Z

Added new git_version_modules macro that uses a combination of git submodule foreach and git describe to format a block of text that accomplishes what git_version does for the root repository.

Use

Given the file structure of this PR:

.
├── COPYING
├── Cargo.lock
├── Cargo.toml
├── README.md
├── git-version-macro
│   ├── COPYING -> ../COPYING
│   ├── Cargo.toml
│   └── src
│       ├── describe_submodules.rs
│       ├── lib.rs
│       └── utils.rs
├── rustfmt.toml
├── src
│   └── lib.rs
├── test-child-repo
│   ├── README.md
│   └── test-grandchild-repo
│       └── README.md
├── test_outer_directory
│   └── test-child-repo
│       ├── README.md
│       └── test-grandchild-repo
│           └── README.md
└── tests
    └── version.rs

use git_version::git_version_submodule;

let module_versions = git_version_modules!(
		prefix = "pre-",
		suffix = "-suff",
		describe_args = ["--always", "--dirty=-modified", "--tags"]
	);

Example output:

[
	["test-child-repo", "pre-da418ba-suff"],
	["test-child-repo/test-grandchild-repo", "pre-12551c3-suff"],
	["test_outer_directory/test-child-repo ", "pre-da418ba-suff"],
	["test_outer_directory/test-child-repo/test-grandchild-repo", "pre-12551c3-suff"],
]

de-vri-es · 2023-11-15T17:36:03Z

Thanks! It could certainly be interesting to support information for submodules too.

But I think the macro should expand to an array of submodule entries, giving the path and version information of each. Now it just expands to one string literal?

baxterjo · 2023-11-19T20:25:16Z

@de-vri-es This is ready for re-review.

de-vri-es · 2023-11-21T08:41:10Z

Output looks good. The only thing I'm contemplating is if we should use a different type for the submodule entries. A tuple seems more logical than a [&str; 2], but maybe we should even use a struct with named fields? Something like SubmoduleVersion { path: ..., version: ... } maybe. What do you think?

(Didn't look at the implementation yet.)

de-vri-es · 2023-11-21T08:50:29Z

git-version-macro/src/describe_submodules.rs

+			for line in newline_split {
+				let line = line.to_string();
+				let line_split: Vec<&str> = line.split(':').collect();
+				assert!(


The proc macro should never panic. This should be a compile error instead. But I also think the check should probably be removed. If people use colons in their tags, it should still just work.

But maybe we shouldn't use git submodule foreach, but just get a list of submodules and do the foreach ourselves. Then we avoid the need to parse output at all (what if the submodule path also has a colon?).

Fixed, and removed foreach args. Also renamed describe_args back to args to be more inline with the git_version macro.

baxterjo · 2023-11-23T03:12:01Z

Output looks good. The only thing I'm contemplating is if we should use a different type for the submodule entries. A tuple seems more logical than a [&str; 2], but maybe we should even use a struct with named fields? Something like SubmoduleVersion { path: ..., version: ... } maybe. What do you think?

(Didn't look at the implementation yet.)

@de-vri-es I think I want to avoid using custom structs because I personally like using the git_version macro to define a const at the top of the file. And since consts cannot have their type inferred, you have to declare the type in the array and then that creates a circular dependency with the macro crate.

I think an output of [(&str,&str), N] is good. Although it would force users to change the number N whenever a submodule is added, I wouldn't expect users to be changing that number often over the course of their projects.

de-vri-es · 2023-11-23T23:14:25Z

@de-vri-es I think I want to avoid using custom structs because I personally like using the git_version macro to define a const at the top of the file. And since consts cannot have their type inferred, you have to declare the type in the array and then that creates a circular dependency with the macro crate.

It wouldn't be a technical problem, but I agree, it's nice to limit the number of types/functions you need. So fair, lets not go for a custom struct.

I was also thinking maybe the submodule path should still be &Path instead of &str. But I think in most cases &str is actually easier to work with. So lets also stick with &str for the path.

I think an output of [(&str,&str), N] is good. Although it would force users to change the number N whenever a submodule is added, I wouldn't expect users to be changing that number often over the course of their projects.

Yeah, an array is good. If people want, they can easily turn it into a slice by taking a reference:

const SUBMODULE_VERSIONS: &[(&str, &str)] = &git_version_modules!();

By expanding to an array, we do give people the option to use N at compile time.

One more bikeshed point: I think git_submodule_versions!() is probably a better name for the macro.

de-vri-es · 2023-11-23T23:17:04Z

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "test-child-repo"]


I think it would be nice to set up a custom testing repo for this instead of adding submodules. But I will take care of this part, since I also think they should be in the same organization :)

Removed submodules and added more effective test. Also fixed some issues that popped up when this macro is ran in a project with no submodules.

baxterjo · 2023-11-28T05:45:28Z

One more bikeshed point: I think git_submodule_versions!() is probably a better name for the macro.

@de-vri-es Renamed the macro, also updated docs for usage.

baxterjo · 2023-12-06T17:39:13Z

@de-vri-es ping

git-version-macro/src/describe_submodules.rs

de-vri-es · 2023-12-07T22:32:51Z

git-version-macro/src/describe_submodules.rs

+	let mut args: Vec<String> = "submodule foreach --quiet --recursive"
+		.to_string()
+		.split(' ')
+		.map(|x| x.to_string())
+		.collect();
+
+	args.push("echo $displaypath".to_string());
+
+	let result = run_git("git submodule", Command::new("git").args(args))?;


Suggested change

let mut args: Vec<String> = "submodule foreach --quiet --recursive"

.to_string()

.split(' ')

.map(|x| x.to_string())

.collect();

args.push("echo $displaypath".to_string());

let result = run_git("git submodule", Command::new("git").args(args))?;

let result = run_git(

"git submodule",

Command::new("git")

.arg("submodule")

.arg("foreach")

.arg("--quiet")

.arg("--recursive")

.arg("echo $displaypath"),

)?;

Does echo $displaypath work on windows though? Maybe we should parse the .gitmodules file instead relying on git submodule foreach.

Lemme check real quick.

Edit: Yep! It works. The shell that executes the command must be implemented by git. Tested on Powershell and Command Prompt

de-vri-es · 2023-12-07T22:38:13Z

git-version-macro/src/describe_submodules.rs

+
+			}))
+		}
+		Err(_) if args.fallback.is_some() => Ok(quote!([("fallback", args.fallback)])),


I'm not sure this makes sense here. For git_version!(), the fallback means: if "git describe fails, give this as version instead".

I think the fallback should have the same meaning for submodules: each submodule entry should apply the fallback independently if git describe fails.

At the very least, it will mean that the submodule paths are always real paths. With the current interpretation of the fallback argument, you can't distinguish between the fallback being used or a submodule at path "fallback".

I thought it felt clunky. I will implement this tomorrow.

@de-vri-es Fixed up to work as you described. Will conditionally add a fallback on a per-submodule basis if a fallback is provided, and throw a compiler error otherwise, just like git_version!().

Co-authored-by: Maarten de Vries <[email protected]>

de-vri-es · 2023-12-13T18:22:40Z

Released as v0.3.9 🚀

Thanks for the PR!

Jordan Baxter added 3 commits November 2, 2023 20:08

Started messing around with submodule outputs.

c7197c1

Added submodule macro and fixed clippy lints.

761a583

Added docs.

e7247ec

de-vri-es force-pushed the master branch from 5969f9f to c7836c9 Compare November 15, 2023 19:34

Jordan Baxter added 6 commits November 19, 2023 10:44

Started messing around with submodule outputs.

b1d0520

Added submodule macro and fixed clippy lints.

f7ad9e4

Added docs.

ea2884f

Trying to tokenize a tuple of &str.

da3a7b4

Finished array creation.

043f387

merge

7f9d730

de-vri-es reviewed Nov 21, 2023

View reviewed changes

Jordan Baxter added 2 commits November 22, 2023 12:14

Working on final quote block./

0d4e1ef

Added submodule version struct to output.

4fdaa93

Jordan Baxter added 2 commits November 22, 2023 19:14

Removed submodule version struct.

30d74d2

Updated docs.

fd0925d

de-vri-es reviewed Nov 23, 2023

View reviewed changes

Jordan Baxter added 4 commits November 27, 2023 21:08

Renamed macro and added more effective test.

0dd1bb5

Removed submodules.

111b54e

Removed submodule.

f5ba079

Fixed up for projects without submodules.

0e92ea6

de-vri-es reviewed Dec 7, 2023

View reviewed changes

baxterjo and others added 2 commits December 7, 2023 17:49

Update git-version-macro/src/describe_submodules.rs

dc059b8

Co-authored-by: Maarten de Vries <[email protected]>

Update git-version-macro/src/describe_submodules.rs

b79c25b

Co-authored-by: Maarten de Vries <[email protected]>

Jordan Baxter added 2 commits December 8, 2023 09:34

Removed ignore.

c6f8ba9

Added fallback on a per-submodule basis.

386a08e

de-vri-es self-assigned this Dec 9, 2023

Corrected description of "fallback" in docs.

59f6c35

de-vri-es merged commit 14f3942 into fusion-engineering:master Dec 11, 2023
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Support for Submodule Versioning #23

Add Support for Submodule Versioning #23

baxterjo commented Nov 5, 2023 •

edited

Loading

de-vri-es commented Nov 15, 2023 •

edited

Loading

baxterjo commented Nov 19, 2023

de-vri-es commented Nov 21, 2023

de-vri-es Nov 21, 2023 •

edited

Loading

baxterjo Nov 23, 2023

baxterjo commented Nov 23, 2023 •

edited

Loading

de-vri-es commented Nov 23, 2023 •

edited

Loading

de-vri-es Nov 23, 2023

baxterjo Nov 28, 2023

baxterjo commented Nov 28, 2023 •

edited

Loading

baxterjo commented Dec 6, 2023

de-vri-es Dec 7, 2023

de-vri-es Dec 7, 2023 •

edited

Loading

baxterjo Dec 8, 2023 •

edited

Loading

de-vri-es Dec 11, 2023

de-vri-es Dec 7, 2023

baxterjo Dec 8, 2023

baxterjo Dec 8, 2023 •

edited

Loading

de-vri-es commented Dec 13, 2023

Add Support for Submodule Versioning #23

Add Support for Submodule Versioning #23

Conversation

baxterjo commented Nov 5, 2023 • edited Loading

Use

Example output:

de-vri-es commented Nov 15, 2023 • edited Loading

baxterjo commented Nov 19, 2023

de-vri-es commented Nov 21, 2023

de-vri-es Nov 21, 2023 • edited Loading

Choose a reason for hiding this comment

baxterjo Nov 23, 2023

Choose a reason for hiding this comment

baxterjo commented Nov 23, 2023 • edited Loading

de-vri-es commented Nov 23, 2023 • edited Loading

de-vri-es Nov 23, 2023

Choose a reason for hiding this comment

baxterjo Nov 28, 2023

Choose a reason for hiding this comment

baxterjo commented Nov 28, 2023 • edited Loading

baxterjo commented Dec 6, 2023

de-vri-es Dec 7, 2023

Choose a reason for hiding this comment

de-vri-es Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

baxterjo Dec 8, 2023 • edited Loading

Choose a reason for hiding this comment

de-vri-es Dec 11, 2023

Choose a reason for hiding this comment

de-vri-es Dec 7, 2023

Choose a reason for hiding this comment

baxterjo Dec 8, 2023

Choose a reason for hiding this comment

baxterjo Dec 8, 2023 • edited Loading

Choose a reason for hiding this comment

de-vri-es commented Dec 13, 2023

baxterjo commented Nov 5, 2023 •

edited

Loading

de-vri-es commented Nov 15, 2023 •

edited

Loading

de-vri-es Nov 21, 2023 •

edited

Loading

baxterjo commented Nov 23, 2023 •

edited

Loading

de-vri-es commented Nov 23, 2023 •

edited

Loading

baxterjo commented Nov 28, 2023 •

edited

Loading

de-vri-es Dec 7, 2023 •

edited

Loading

baxterjo Dec 8, 2023 •

edited

Loading

baxterjo Dec 8, 2023 •

edited

Loading