Currently, the dsc --version command is only able to emit the cargo package version of the CLI, without any other useful information. However, especially prior to the 3.0.0 release (neither alpha nor preview), people may often be building from source, and it would in general be useful to have the extended information available from clap and the build, like the branch, commit hash, rust version, etc.
We could then have users paste this output in their bug reports.
Alternatively, it would be useful to be able to record this information (and possibly other info?) with a separate command, like dsc info - both so the output could use the normal command data formatting and users could upload YAML for the reporting, and we could keep the short version information that people likely want to see without the distracting/confusing (to them) build information. We could extend an info command to include other information as needed, like the meta configuration state.
I found a blog post using shadow-rs that demonstrates adding build information to a CLI built with clap in rust. I think following those steps and either extending the version command or creating a new command would be useful for bug reporting and ensuring that we're discussing the same code.
Summary of the new feature / enhancement
Currently, the
dsc --versioncommand is only able to emit the cargo package version of the CLI, without any other useful information. However, especially prior to the3.0.0release (neither alpha nor preview), people may often be building from source, and it would in general be useful to have the extended information available from clap and the build, like the branch, commit hash, rust version, etc.For example, it could emit something like:
We could then have users paste this output in their bug reports.
Alternatively, it would be useful to be able to record this information (and possibly other info?) with a separate command, like
dsc info- both so the output could use the normal command data formatting and users could upload YAML for the reporting, and we could keep the short version information that people likely want to see without the distracting/confusing (to them) build information. We could extend aninfocommand to include other information as needed, like the meta configuration state.Proposed technical implementation details (optional)
I found a blog post using shadow-rs that demonstrates adding build information to a CLI built with clap in rust. I think following those steps and either extending the version command or creating a new command would be useful for bug reporting and ensuring that we're discussing the same code.