-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement dynamic build-version variable
- Loading branch information
Showing
2 changed files
with
53 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
use std::{env, process::Command}; | ||
|
||
fn main() { | ||
// Use the SDK_VERSION environment variable if it is set (e.g. by CI) or get it from Git | ||
let sdk_version = env::var("SDK_VERSION") | ||
.or_else(|_| version_from_git_info()) | ||
.unwrap_or("unknown".to_string()); | ||
|
||
println!("cargo:rustc-env=SDK_VERSION={sdk_version}"); | ||
println!("cargo:rustc-env=CARGO_PKG_VERSION={sdk_version}"); | ||
} | ||
|
||
fn run(args: &[&str]) -> Result<String, std::io::Error> { | ||
let out = Command::new(args[0]).args(&args[1..]).output()?; | ||
if !out.status.success() { | ||
use std::io::{Error, ErrorKind}; | ||
return Err(Error::new(ErrorKind::Other, "Command not successful")); | ||
} | ||
Ok(String::from_utf8(out.stdout).unwrap().trim().to_string()) | ||
} | ||
|
||
/// This method reads info from Git, namely tags, branch, and revision | ||
/// To access these values, use: | ||
/// - `env!("GIT_EXACT_TAG")` | ||
/// - `env!("GIT_BRANCH")` | ||
/// - `env!("GIT_REV")` | ||
fn version_from_git_info() -> Result<String, std::io::Error> { | ||
// The exact tag for the current commit, can be empty when | ||
// the current commit doesn't have an associated tag | ||
let exact_tag = run(&["git", "describe", "--abbrev=0", "--tags", "--exact-match"]).ok(); | ||
if let Some(ref exact) = exact_tag { | ||
println!("cargo:rustc-env=GIT_EXACT_TAG={exact}"); | ||
} | ||
|
||
// The current branch name | ||
let branch = run(&["git", "rev-parse", "--abbrev-ref", "HEAD"])?; | ||
println!("cargo:rustc-env=GIT_BRANCH={branch}"); | ||
|
||
// The current git commit hash | ||
let rev = run(&["git", "rev-parse", "HEAD"])?; | ||
let rev_short = rev.get(..8).unwrap_or_default(); | ||
println!("cargo:rustc-env=GIT_REV={rev_short}"); | ||
|
||
// Combined version | ||
if let Some(exact) = exact_tag { | ||
Ok(exact) | ||
} else if &branch != "main" && &branch != "master" && &branch != "HEAD" { | ||
Ok(format!("{rev_short} ({branch})")) | ||
} else { | ||
Ok(format!("{rev_short}")) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters