Skip to content

Commit

Permalink
feat: implement dynamic build-version variable
Browse files Browse the repository at this point in the history
  • Loading branch information
coroiu committed Oct 21, 2024
1 parent c7a06b8 commit 401d008
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 1 deletion.
52 changes: 52 additions & 0 deletions crates/bitwarden-wasm-internal/build.rs
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}"))
}
}
2 changes: 1 addition & 1 deletion crates/bitwarden-wasm-internal/src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ impl BitwardenClient {
}

pub fn version(&self) -> String {
"PM-12989-create-process-for-qa-to-build-client-with-particular-sdk-version".to_owned()
env!("SDK_VERSION").to_owned()
}

Check warning on line 54 in crates/bitwarden-wasm-internal/src/client.rs

View check run for this annotation

Codecov / codecov/patch

crates/bitwarden-wasm-internal/src/client.rs#L52-L54

Added lines #L52 - L54 were not covered by tests

pub fn throw(&self, msg: String) -> Result<(), crate::error::GenericError> {
Expand Down

0 comments on commit 401d008

Please sign in to comment.