Consistency between the documentation and the outputs

[jreniel]

When I do: println!("git describe: {}", env!("VERGEN_GIT_DESCRIBE")); I just get: git describe: 45e8eb8

But I actually wanted to "git_describe": "0.0.0-7-gc96c096", Which is how it is described in the docs. That is, I was expecting it to prepend the semantic version to the hash. How can I achieve this? Also, I definitely upvote https://github.com/rustyhorde/vergen/issues/237 so that we would get something more similar to: 0.0.0-7-gc96c096-dirty

[CraZySacX]

What git feature do you have configured (gitcl, gitoxide or git2)? gitcl runs git describe --always (here) git2 runs the code here gitoxide run the code here

They all support the dirty flag via the git_describe configuration function

[CraZySacX]

Closing as this particular dirty output is currently supported. Will also be adding a VERGEN_GIT_DIRTY variable as requested in #237 . Feel free to re-open if these don't satisfy your request.

[jreniel]

Thanks, @CraZySacX, I was about to reply, as I'm just starting my day. I don't need to reopen, but I'm not exactly clear how to configure through the EmitBuilder. It would be nice to have some updated examples. All in all I want to thank you for your hard work with this crate and for keeping it accessible for the community.

[CraZySacX]

Here is how it's configured (the first argument turns on dirty, the second looks for latest tag, and the third allows an optional pattern match on tag names). Sample output below as well:

use anyhow::Result;
use vergen::EmitBuilder;

pub fn main() -> Result<()> {
    EmitBuilder::builder()
        .all_git()
        .git_describe(true, true, None)
        .emit()
}

Describe (    git): 0.1.0-1-gcfece0a

[jreniel]

Thanks for your help! =) =) =)