Include VCS information via cargo build-time environment variables

mathstuf · April 4, 2024, 5:04am

Here's the information I gather for ghostflow-director binaries (via build.rs).

See this issue:

github.com/tikv/tikv

Generate build info in cargo's build scripts

opened 07:52AM - 10 Jan 19 UTC

overvenus

help wanted component/build difficulty/easy status/mentor

## Feature Request **Is your feature request related to a problem? Please des…cribe:** Currently, building a tikv-server needs a Makefile to collect git hash and others, otherwise `tikv-server --version` shows unknown. This means a proper build needs helps from the outside of cargo. **Describe the feature you'd like:** Instead of Makefile, we can collect these info in cargo's build script. > `rustc-env=VAR=VALUE` indicates that the specified environment variable will be added to the environment which the compiler is run within. The value can be then retrieved by the env! macro in the compiled crate. This is useful for embedding additional metadata in crate's code, such as the hash of Git HEAD or the unique identifier of a continuous integration server. https://doc.rust-lang.org/cargo/reference/build-scripts.html#outputs-of-the-build-script EDIT: we should use `rustc-env` instead of `rustc-cfg`.

I noted this in the above issue. export-subst may be useful here.

Topic		Replies	Views
Build.rs use cases and stories sought! cargo	47	3464	June 5, 2019
Pre-RFC: Cargo build and native dependency integration via crate-based build scripts	20	3545	March 25, 2019
Link rust crate outside cargo? cargo	5	1186	September 25, 2020
Proposal: Add "cargo:rustc-compile-crate-without-waiting-for-build-rs" for build.rs compiler	11	1027	November 28, 2022
Idea: Cargo git dependency commit pinning flag cargo	5	2473	March 25, 2019

Include VCS information via cargo build-time environment variables

Related topics