oysterpack_built

From a DevOps perspective, it is critical to know exactly what is deployed. oysterpack_built is used as a build-time dependency to gather application build related metadata. The information is gathered from the cargo build. It produces a Rust source file named built.rs in the project's build script output directory. The location can be obtained via:

let built_rs = concat!(env!("OUT_DIR"), "/built.rs");

How to integrate within your project

1. Add the following to Cargo.toml:

   [package]
   build = "build.rs"
   
   [dependencies]
   oysterpack_app_metadata = "0.1"
   semver = "0.9"
   chrono = "0.4"
   
   [build-dependencies]
   oysterpack_built = "0.3"
   

   • oysterpack_built is added as a build dependency
   • build.rs is the name of the cargo build script to use
   • oysterpack_app_metadata is used in conjuction with this crate to load the application build metadata into the domain model defined by oysterpack_app_metadata

2. Include the following in build.rs:

   extern crate oysterpack_built;
   
   fn main() {
      oysterpack_built::run();
   }
   

3. The build script will by default write a file named built.rs into Cargo's build output directory, which will contain the following constants:

The application metadata can be loaded via oysterpack_app_metadata op_build_mod!()):

#[macro_use]
extern crate oysterpack_app_metadata;
extern crate chrono;
extern crate semver;

// loads the application metadata into `pub mod build {...}'
op_build_mod!()

use oysterpack_app_metadata::Build;

fn main () {
    let app_build = build::get();
    // integrate the application build metadata ...
}