feat(build): Add extra version information #418
Conversation
Simple build-time code generation for now. Plan to add git info from the environment if it exists. Fixes containers#361 Signed-off-by: Brad P. Crochet <brad@redhat.com>
|
|
||
| fn main() { | ||
| let out_dir = env::var_os("OUT_DIR").unwrap(); | ||
| let dest_path = Path::new(&out_dir).join("version.rs"); |
There was a problem hiding this comment.
Just so I understand better...is this build.rs effectively a workaround for the constant generated by the clap tooling in https://docs.rs/clap/latest/clap/macro.crate_version.html not having a docstring?
Or basically can you just add a comment with why we need this build.rs? Something like:
// Generate a source file with the crate version that includes a documentation string
// so that our #[deny(missing_docs)] works
or something like that?
(It seems like we could send a patch to clap to add a dummy docstring too?)
There was a problem hiding this comment.
Doing this in order to then be able to pull in other information from the environment. In this way, we could have the version string reflect that it's a dev build, or do something different at release. It doesn't do that now. If you want me to go even simpler now and include the build.rs later when I get an actual use-case, I'm fine with that too.
There was a problem hiding this comment.
I don't have a strong opinion, good with this as as is. Thanks for working on this!
Simple build-time code generation for now. Plan to add git info from the environment if it exists.
Fixes #361