SoftwareVersion: Add git hash suffix with git-version crate

.github/workflows/ci.yml

@@ -102,6 +102,12 @@ jobs:
           use-cross: ${{ matrix.job.use-cross }}
           command: run
           args: --target ${{ matrix.job.target }} --example=simple -- "'test value' on command line" "two" "three"
+      - uses: actions-rs/cargo@v1
+        name: "example 'simple' without git_hash feature"
+        with:
+          use-cross: ${{ matrix.job.use-cross }}
+          command: run
+          args: --target ${{ matrix.job.target }} --example=simple --no-default-features --features collector_operating_system,format_markdown
       - uses: actions-rs/cargo@v1
         name: "example 'custom_collector'"
         with:

Cargo.toml

@@ -17,13 +17,16 @@ edition = "2018"
 version = "0.3.0"
 
 [features]
-default = ["collector_operating_system", "format_markdown"]
+default = ["collector_operating_system", "git_hash", "format_markdown"]
 
 collector_operating_system = ["sys-info"]
 
+git_hash = ["git-version"]
+
 format_markdown = []
 format_plaintext = []
 
 [dependencies]
 sys-info = { version = "0.7", optional = true }
+git-version = { version = "0.3", optional = true }
 snailquote = "0.3"

README.md

@@ -31,7 +31,7 @@ generates bug report information that [looks like this](example-report.md).
 
 ## Collectors
 
-- [x] Crate information (name and version)
+- [x] Crate information (name, version, git hash)
 - [x] Operating system (type, name, version)
 - [x] Command line (including all arguments)
 - [x] Environment variables (e.g. `SHELL`, `PATH`, …)

example-report.md

@@ -1,6 +1,6 @@
 #### Software version
 
-bugreport 0.3.0
+bugreport 0.3.0 (a984113)
 
 #### Operating system
 

src/collector.rs

@@ -58,10 +58,16 @@ impl Collector for SoftwareVersion {
     }
 
     fn collect(&mut self, crate_info: &CrateInfo) -> Result<ReportEntry> {
+        let git_hash_suffix = match crate_info.git_hash {
+            Some(git_hash) => format!(" ({})", git_hash),
+            None => format!(""),
+        };
+
         Ok(ReportEntry::Text(format!(
-            "{} {}",
+            "{} {}{}",
             crate_info.pkg_name,
-            self.version.as_deref().unwrap_or(&crate_info.pkg_version)
+            self.version.as_deref().unwrap_or(&crate_info.pkg_version),
+            git_hash_suffix,
         )))
     }
 }

src/lib.rs

@@ -33,6 +33,7 @@ pub(crate) type Result<T> = result::Result<T, CollectionError>;
 pub struct CrateInfo<'a> {
     pkg_name: &'a str,
     pkg_version: &'a str,
+    git_hash: Option<&'a str>,
 }
 
 /// The main struct for collecting bug report information.
@@ -50,11 +51,17 @@ impl<'a> BugReport<'a> {
             info: CrateInfo {
                 pkg_name,
                 pkg_version,
+                git_hash: None,
             },
             collectors: vec![],
         }
     }
 
+    #[doc(hidden)]
+    pub fn set_git_hash(&mut self, git_hash: Option<&'a str>) {
+        self.info.git_hash = git_hash;
+    }
+
     /// Add a [`Collector`] to the bug report.
     pub fn info<C: Collector + 'static>(mut self, collector: C) -> Self {
         self.collectors.push(Box::new(collector));
@@ -89,15 +96,37 @@ impl<'a> BugReport<'a> {
     }
 }
 
+/// Re-export so dependent project does not have to manually depend on git-version crate
+#[cfg(feature = "git_hash")]
+pub use git_version::git_version;
+
+#[cfg(feature = "git_hash")]
+#[doc(hidden)]
+#[macro_export]
+macro_rules! bugreport_set_git_hash {
+    ($br:ident) => {
+        $br.set_git_hash(Some(bugreport::git_version!(fallback = "<no git>")));
+    };
+}
+
+#[cfg(not(feature = "git_hash"))]
+#[doc(hidden)]
+#[macro_export]
+macro_rules! bugreport_set_git_hash {
+    ($br:ident) => {};
+}
+
 /// Generate a new [`BugReport`] object.
 #[macro_export]
 macro_rules! bugreport {
-    () => {
-        bugreport::BugReport::from_name_and_version(
+    () => {{
+        let mut br = bugreport::BugReport::from_name_and_version(
             env!("CARGO_PKG_NAME"),
             env!("CARGO_PKG_VERSION"),
-        )
-    };
+        );
+        bugreport::bugreport_set_git_hash!(br);
+        br
+    }};
 }
 
 #[cfg(test)]