extract utils into subcrate

Author: syphar

Cargo.lock

@@ -22,23 +22,27 @@ exclude = [
 
 [workspace.dependencies]
 anyhow = { version = "1.0.42", features = ["backtrace"]}
+chrono = { version = "0.4.11", default-features = false, features = ["clock", "serde"] }
 derive_more = { version = "2.0.0", features = ["display", "deref", "from", "into", "from_str"] }
 opentelemetry = "0.31.0"
 opentelemetry-otlp = { version = "0.31.0", features = ["grpc-tonic",  "metrics"] }
 opentelemetry-resource-detectors = "0.10.0"
 opentelemetry_sdk = { version = "0.31.0", features = ["rt-tokio"] }
+regex = "1"
+tokio = { version = "1.0", features = ["rt-multi-thread", "signal", "macros", "process", "sync"] }
 tracing = "0.1.37"
 url = { version = "2.1.1", features = ["serde"] }
 
 [dependencies]
 docs_rs_env_vars = { path = "crates/lib/docs_rs_env_vars" }
 docs_rs_opentelemetry = { path = "crates/lib/docs_rs_opentelemetry" }
+docs_rs_utils = { path = "crates/lib/docs_rs_utils" }
 sentry = { version = "0.46.0", features = ["panic", "tracing", "tower-http", "anyhow", "backtrace"] }
 log = "0.4"
 tracing = { workspace = true }
 tracing-subscriber = { version = "0.3.20", default-features = false, features = ["ansi", "fmt", "json", "env-filter", "tracing-log"] }
 tracing-log = "0.2.0"
-regex = "1"
+regex = { workspace = true }
 clap = { version = "4.0.22", features = [ "derive" ] }
 crates-index = { version = "3.0.0", default-features = false, features = ["git", "git-https", "git-performance", "parallel"] }
 rayon = "1.6.1"
@@ -79,7 +83,7 @@ derive_builder = "0.20.2"
 
 # Async
 async-compression = { version = "0.4.32", features = ["tokio", "bzip2", "zstd", "gzip"] }
-tokio = { version = "1.0", features = ["rt-multi-thread", "signal", "macros", "process", "sync"] }
+tokio = { workspace = true }
 tokio-util = { version = "0.7.15", default-features = false, features = ["io"] }
 tracing-futures= { version = "0.2.5", features = ["std-future", "futures-03"] }
 futures-util = "0.3.5"
@@ -113,7 +117,7 @@ walkdir = "2"
 phf = "0.13.1"
 
 # Date and Time utilities
-chrono = { version = "0.4.11", default-features = false, features = ["clock", "serde"] }
+chrono = { workspace = true }
 
 # Transitive dependencies we don't use directly but need to have specific versions of
 constant_time_eq = "0.4.2"

Cargo.toml

@@ -73,7 +73,6 @@ type ETagMap<'a> = phf_codegen::Map<'a, String>;
 fn main() -> Result<()> {
     let out_dir = env::var("OUT_DIR").context("missing OUT_DIR")?;
     let out_dir = Path::new(&out_dir);
-    read_git_version()?;
 
     let mut etag_map: ETagMap = ETagMap::new();
 
@@ -94,54 +93,6 @@ fn main() -> Result<()> {
     Ok(())
 }
 
-fn read_git_version() -> Result<()> {
-    if let Ok(v) = env::var("GIT_SHA") {
-        // first try to read an externally provided git SAH, e.g., from CI
-        println!("cargo:rustc-env=GIT_SHA={v}");
-    } else {
-        // then try to read the git repo.
-        let maybe_hash = get_git_hash()?;
-        let git_hash = maybe_hash.as_deref().unwrap_or("???????");
-        println!("cargo:rustc-env=GIT_SHA={git_hash}");
-    }
-
-    println!(
-        "cargo:rustc-env=BUILD_DATE={}",
-        time::OffsetDateTime::now_utc().date(),
-    );
-
-    Ok(())
-}
-
-fn get_git_hash() -> Result<Option<String>> {
-    use std::process::Command;
-
-    let output = Command::new("git")
-        .args(["rev-parse", "--short", "HEAD"])
-        .output();
-
-    match output {
-        Ok(output) if output.status.success() => {
-            let hash = String::from_utf8(output.stdout)?.trim().to_string();
-
-            // TODO: are these right?
-            tracked::track(".git/HEAD")?;
-            tracked::track(".git/index")?;
-
-            Ok(Some(hash))
-        }
-        Ok(output) => {
-            let err = String::from_utf8_lossy(&output.stderr);
-            eprintln!("failed to get git repo: {}", err.trim());
-            Ok(None)
-        }
-        Err(err) => {
-            eprintln!("failed to execute git: {err}");
-            Ok(None)
-        }
-    }
-}
-
 fn etag_from_path(path: impl AsRef<Path>) -> Result<String> {
     Ok(etag_from_content(std::fs::read(&path)?))
 }

build.rs

@@ -0,0 +1,18 @@
+[package]
+name = "docs_rs_utils"
+version = "0.1.0"
+edition = "2024"
+build = "build.rs"
+
+[dependencies]
+anyhow = { workspace = true }
+chrono = { workspace = true }
+regex = { workspace = true }
+tokio = { workspace = true }
+tracing = { workspace = true }
+
+[build-dependencies]
+anyhow = { workspace = true }
+chrono = { workspace = true }
+time = "0.3"
+tokio = { workspace = true }

crates/lib/docs_rs_utils/Cargo.toml

@@ -0,0 +1,51 @@
+use anyhow::Result;
+use std::env;
+
+fn main() -> Result<()> {
+    read_git_version()?;
+    Ok(())
+}
+
+fn read_git_version() -> Result<()> {
+    if let Ok(v) = env::var("GIT_SHA") {
+        // first try to read an externally provided git SAH, e.g., from CI
+        println!("cargo:rustc-env=GIT_SHA={v}");
+    } else {
+        // then try to read the git repo.
+        let maybe_hash = get_git_hash()?;
+        let git_hash = maybe_hash.as_deref().unwrap_or("???????");
+        println!("cargo:rustc-env=GIT_SHA={git_hash}");
+    }
+
+    println!(
+        "cargo:rustc-env=BUILD_DATE={}",
+        time::OffsetDateTime::now_utc().date(),
+    );
+
+    Ok(())
+}
+
+fn get_git_hash() -> Result<Option<String>> {
+    use std::process::Command;
+
+    let output = Command::new("git")
+        .args(["rev-parse", "--short", "HEAD"])
+        .output();
+
+    match output {
+        Ok(output) if output.status.success() => {
+            let hash = String::from_utf8(output.stdout)?.trim().to_string();
+
+            Ok(Some(hash))
+        }
+        Ok(output) => {
+            let err = String::from_utf8_lossy(&output.stderr);
+            eprintln!("failed to get git repo: {}", err.trim());
+            Ok(None)
+        }
+        Err(err) => {
+            eprintln!("failed to execute git: {err}");
+            Ok(None)
+        }
+    }
+}