Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Removed deprecated 'gen' and 'ConstantsFlags' #53

Merged
merged 11 commits into from Mar 16, 2021
Merged

Removed deprecated 'gen' and 'ConstantsFlags' #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4d6c28b
removed deprecated 'gen' and 'ConstantsFlags'
jasonozias Mar 2, 2021
38428f6
removed some dead statics
jasonozias Mar 2, 2021
f8bcca4
feature snafu
jasonozias Mar 2, 2021
24c0b86
removed deprecated 'gen' and 'ConstantsFlags'
jasonozias Mar 2, 2021
e0312ad
removed some dead statics
jasonozias Mar 2, 2021
4b91f4f
feature snafu
jasonozias Mar 2, 2021
f914900
Merge branch 'feature/v5.0.0' of github.com:rustyhorde/vergen into fe…
jasonozias Mar 8, 2021
5d8c779
removed deprecation warning
CraZySacX Mar 11, 2021
aa50ee6
removed Error from public API, converted to use anyhow
CraZySacX Mar 11, 2021
bb867d5
use current_dir instead of .
jasonozias Mar 12, 2021
7e04892
added more robust matrix
CraZySacX Mar 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/workflows/main.yml
View file
Open in desktop
Expand Up @@ -12,39 +12,75 @@ jobs:
- os: ubuntu-latest
rust: stable
other: i686-unknown-linux-gnu
- os: ubuntu-latest
rust: stable
other: x86_64-unknown-linux-gnu
- os: ubuntu-latest
rust: beta
other: i686-unknown-linux-gnu
- os: ubuntu-latest
rust: beta
other: x86_64-unknown-linux-gnu
- os: ubuntu-latest
rust: nightly
other: i686-unknown-linux-gnu
- os: ubuntu-latest
rust: nightly
other: x86_64-unknown-linux-gnu
- os: macos-latest
rust: stable
other: x86_64-apple-darwin
- os: macos-latest
rust: stable
other: x86_64-apple-ios
- os: macos-latest
rust: beta
other: x86_64-apple-darwin
- os: macos-latest
rust: beta
other: x86_64-apple-ios
- os: macos-latest
rust: nightly
other: x86_64-apple-darwin
- os: macos-latest
rust: nightly
other: x86_64-apple-ios
- os: windows-latest
rust: stable-msvc
other: i686-pc-windows-msvc
- os: windows-latest
rust: stable-msvc
other: x86_64-pc-windows-msvc
- os: windows-latest
rust: beta-msvc
other: i686-pc-windows-msvc
- os: windows-latest
rust: beta-msvc
other: x86_64-pc-windows-msvc
- os: windows-latest
rust: nightly-msvc
other: i686-pc-windows-msvc
- os: windows-latest
rust: nightly-msvc
other: x86_64-pc-windows-msvc
- os: windows-latest
rust: stable-gnu
other: i686-pc-windows-gnu
- os: windows-latest
rust: stable-gnu
other: x86_64-pc-windows-gnu
- os: windows-latest
rust: beta-gnu
other: i686-pc-windows-gnu
- os: windows-latest
rust: beta-gnu
other: x86_64-pc-windows-gnu
- os: windows-latest
rust: nightly-gnu
other: i686-pc-windows-gnu
- os: windows-latest
rust: nightly-gnu
other: x86_64-pc-windows-gnu
steps:
- name: ✔️ Checkout ✔️
uses: actions/checkout@v2
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Expand Up @@ -20,7 +20,7 @@ git = ["chrono", "git2"]
rustc = ["rustc_version"]

[dependencies]
bitflags = "1"
anyhow = "1"
chrono = { version = "0", optional = true }
enum-iterator = "0"
getset = "0"
Expand Down
27 changes: 4 additions & 23 deletions src/config.rs
View file
Open in desktop
Expand Up @@ -18,18 +18,15 @@ use crate::feature::Git;
use crate::feature::Rustc;
use crate::{
constants::{
ConstantsFlags, BUILD_DATE_NAME, BUILD_SEMVER_NAME, BUILD_TIMESTAMP_NAME, BUILD_TIME_NAME,
CARGO_FEATURES, CARGO_PROFILE, CARGO_TARGET_TRIPLE, GIT_BRANCH_NAME, GIT_COMMIT_DATE_NAME,
BUILD_DATE_NAME, BUILD_SEMVER_NAME, BUILD_TIMESTAMP_NAME, BUILD_TIME_NAME, CARGO_FEATURES,
CARGO_PROFILE, CARGO_TARGET_TRIPLE, GIT_BRANCH_NAME, GIT_COMMIT_DATE_NAME,
GIT_COMMIT_TIMESTAMP_NAME, GIT_COMMIT_TIME_NAME, GIT_SEMVER_NAME, GIT_SEMVER_TAGS_NAME,
GIT_SHA_NAME, GIT_SHA_SHORT_NAME, RUSTC_CHANNEL_NAME, RUSTC_COMMIT_DATE, RUSTC_COMMIT_HASH,
RUSTC_HOST_TRIPLE_NAME, RUSTC_LLVM_VERSION, RUSTC_SEMVER_NAME,
},
error::Result,
feature::{
add_build_config, add_cargo_config, add_git_config, add_rustc_config, configure_build,
configure_cargo, configure_git, configure_rustc,
},
feature::{configure_build, configure_cargo, configure_git, configure_rustc},
};
use anyhow::Result;
use enum_iterator::IntoEnumIterator;
use getset::{Getters, MutGetters};
use std::{
Expand Down Expand Up @@ -224,22 +221,6 @@ impl Default for Config {
}
}

impl Config {
pub(crate) fn build<T>(flags: ConstantsFlags, repo_path: Option<T>) -> Result<Config>
where
T: AsRef<Path>,
{
let mut config = Config::default();

add_build_config(flags, &mut config);
add_git_config(flags, repo_path, &mut config)?;
add_rustc_config(flags, &mut config)?;
add_cargo_config(flags, &mut config);

Ok(config)
}
}

#[cfg(test)]
mod test {
use super::{Config, Instructions};
Expand Down
224 changes: 1 addition & 223 deletions src/constants.rs
View file
Open in desktop
Expand Up @@ -6,179 +6,7 @@
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.

//! Flags used to toggle individual `cargo:` instruction generation

use bitflags::bitflags;

bitflags!(
/// **DEPRECATED** - [`ConstantsFlags`] has been deprecated in favor of [`Config`](crate::config::Instructions).
///
/// Please make the switch to that instead. [`ConstantsFlags`] will be removed in
/// version 5.
///
/// Flags used to toggle individual `cargo:` instruction generation
///
/// Use these to toggle off instructions you don't wish to generate
///
/// # Example
/// ```
/// # use vergen::ConstantsFlags;
/// #
/// # fn main() {
/// let mut actual_flags = ConstantsFlags::all();
/// actual_flags.toggle(ConstantsFlags::SHA_SHORT);
/// actual_flags.toggle(ConstantsFlags::BUILD_DATE);
/// actual_flags.toggle(ConstantsFlags::SEMVER_LIGHTWEIGHT);
/// actual_flags.toggle(ConstantsFlags::SEMVER_FROM_CARGO_PKG);
///
/// let expected_flags = ConstantsFlags::BUILD_TIMESTAMP |
/// ConstantsFlags::SHA |
/// ConstantsFlags::COMMIT_DATE |
/// ConstantsFlags::RUSTC_HOST_TRIPLE |
/// ConstantsFlags::SEMVER |
/// ConstantsFlags::RUSTC_SEMVER |
/// ConstantsFlags::RUSTC_CHANNEL |
/// ConstantsFlags::REBUILD_ON_HEAD_CHANGE |
/// ConstantsFlags::BRANCH |
/// ConstantsFlags::RUSTC_COMMIT_HASH |
/// ConstantsFlags::RUSTC_COMMIT_DATE |
/// ConstantsFlags::RUSTC_LLVM_VERSION |
/// ConstantsFlags::CARGO_TARGET_TRIPLE |
/// ConstantsFlags::CARGO_PROFILE |
/// ConstantsFlags::CARGO_FEATURES;
///
/// assert_eq!(actual_flags, expected_flags)
/// # }
/// ```
pub struct ConstantsFlags: u64 {
/// Output the build timestamp instruction `VERGEN_BUILD_TIMESTAMP`
///
/// `cargo:rustc-env=VERGEN_BUILD_TIMESTAMP=2021-02-12T01:54:15.134750+00:00`
///
/// This is the UTC timestamp when the build was run
const BUILD_TIMESTAMP = 0b0000_0000_0000_0001;
/// Output the build date instruction `VERGEN_BUILD_DATE`
///
/// `cargo:rustc-env=VERGEN_BUILD_DATE=2021-02-12`
///
/// This is the UTC date when the build was run
const BUILD_DATE = 0b0000_0000_0000_0010;
/// Output the SHA instruction `VERGEN_GIT_SHA`
///
/// `cargo:rustc-env=VERGEN_GIT_SHA=95fc0f5d066710f16e0c23ce3239d6e040abca0d`
///
/// This is the most recent commit SHA on the current branch
const SHA = 0b0000_0000_0000_0100;
/// Output the short SHA instruction `VERGEN_GIT_SHA_SHORT`
///
/// `cargo:rustc-env=VERGEN_GIT_SHA_SHORT=95fc0f5`
///
/// This is the most recent commit SHA on the current branch short version
const SHA_SHORT = 0b0000_0000_0000_1000;
/// Output the short SHA instruction `VERGEN_GIT_COMMIT_DATE`
///
/// `cargo:rustc-env=VERGEN_GIT_COMMIT_DATE=2021-02-11T20:05:53-05:00`
///
/// This is the local timestamp of the most recent commit on the current branch
const COMMIT_DATE = 0b0000_0000_0001_0000;
/// Output the semantic version instruction `VERGEN_GIT_SEMVER`
///
/// `cargo:rustc-env=VERGEN_GIT_SEMVER=v3.2.0-86-g95fc0f5`
///
/// This defaults to the output of [`git2::Repository::describe`].
/// If the `git` feature is disabled or the describe call fails, generation falls back to the [`CARGO_PKG_VERSION`] environment variable.
/// Note that the [git describe] method is only useful if you have tags on your repository.
/// I recommend [`SemVer`] tags, but this will work with any tag format.
///
/// [git describe]: git2::Repository::describe
/// [`SemVer`]: https://semver.org/
/// [`CARGO_PKG_VERSION`]: https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates
const SEMVER = 0b0000_0000_0100_0000;
/// Output the semantic version instruction `VERGEN_GIT_SEMVER_LIGHTWEIGHT`
///
/// `cargo:rustc-env=VERGEN_GIT_SEMVER_LIGHTWEIGHT=blah-33-g95fc0f5`
///
/// This follows the same rules as described in [`ConstantsFlags::SEMVER`].
/// Note that `VERGEN_GIT_SEMVER_LIGHTWEIGHT` will only differ from `VERGEN_GIT_SEMVER` if you use lightweight tags on your repository.
const SEMVER_LIGHTWEIGHT = 0b0000_0000_1000_0000;
/// Output the `cargo:rerun-if-changed` instructions
///
/// `cargo:rerun-if-changed=/Users/yoda/projects/rust-lang/vergen/.git/HEAD`
///
/// `cargo:rerun-if-changed=/Users/yoda/projects/rust-lang/vergen/.git/refs/heads/feature/git2`
///
/// This toggle is useful to force the build script to re-run when you perform different git actions, i.e. change branches.
const REBUILD_ON_HEAD_CHANGE = 0b0000_0001_0000_0000;
/// Output the semantic version instruction `VERGEN_GIT_SEMVER`
///
/// `cargo:rustc-env=VERGEN_GIT_SEMVER=0.1.0`
///
/// This flag can be used to force the semver instruction to be generated from the `CARGO_PKG_VERSION` environment variable.
/// Note that it is mutually exclusive with the `SEMVER` and `SEMVER_LIGHTWEIGHT` flags.
const SEMVER_FROM_CARGO_PKG = 0b0000_0010_0000_0000;
/// Output the rustc compiler version instruction `VERGEN_RUSTC_SEMVER`
///
/// `cargo:rustc-env=VERGEN_RUSTC_SEMVER=1.52.0-nightly`
///
/// This output is generated via the `rustversion` library and refers to the version of rust that was used to create the build.
const RUSTC_SEMVER = 0b0000_0100_0000_0000;
/// Output the rustc compiler channel instruction `VERGEN_RUSTC_CHANNEL`
///
/// `cargo:rustc-env=VERGEN_RUSTC_CHANNEL=nightly`
///
/// This output is generated via the `rustversion` library and refers to the channel (dev, nightly, beta, or stable) of rust that was used to create the build.
const RUSTC_CHANNEL = 0b0000_1000_0000_0000;
/// Output the rustc compiler host triple instruction `VERGEN_RUSTC_HOST_TRIPLE`
///
/// `cargo:rustc-env=VERGEN_RUSTC_HOST_TRIPLE=x86_64-apple-darwin`
///
/// This output is generated via the `rustversion` library and refers to the host triple of rust that was used to create the build.
const RUSTC_HOST_TRIPLE = 0b0001_0000_0000_0000;
/// Output the semantic version instruction `VERGEN_GIT_BRANCH`
///
/// `cargo:rustc-env=VERGEN_GIT_BRANCH=feature/git2`
///
/// This output represents the current branch when the build was performed.
const BRANCH = 0b0010_0000_0000_0000;
/// Output the rustc compiler commit SHA instruction `VERGEN_RUSTC_COMMIT_HASH`
///
/// `cargo:rustc-env=VERGEN_RUSTC_COMMIT_HASH=07194ffcd25b0871ce560b9f702e52db27ac9f77`
///
/// This output is generated via the `rustversion` library and refers to the commit SHA of rust that was used to create the build.
const RUSTC_COMMIT_HASH = 0b0100_0000_0000_0000;
/// Output the rustc compiler commit date instruction `VERGEN_RUSTC_COMMIT_DATE`
///
/// `cargo:rustc-env=VERGEN_RUSTC_COMMIT_DATE=2021-02-10`
///
/// This output is generated via the `rustversion` library and refers to the commit date of rust that was used to create the build.
const RUSTC_COMMIT_DATE = 0b1000_0000_0000_0000;
/// Output the rustc compiler LLVM instruction `VERGEN_RUSTC_LLVM_VERSION`
///
/// `cargo:rustc-env=VERGEN_RUSTC_LLVM_VERSION=11.0`
///
/// This output is generated via the `rustversion` library and refers to the LLVM version of rust that was used to create the build.
/// Note that this output is only valid on the `nightly` channel currently.
const RUSTC_LLVM_VERSION = 0b0001_0000_0000_0000_0000;
/// Output the cargo target triple instruction `VERGEN_CARGO_TARGET_TRIPLE`
///
/// `cargo:rustc-env=VERGEN_CARGO_TARGET_TRIPLE=x86_64-unknown-linux-gnu`
///
/// This output is made available by cargo at build time, and may be different than the host triple.
const CARGO_TARGET_TRIPLE = 0b0010_0000_0000_0000_0000;
/// Output the cargo profile instruction `VERGEN_CARGO_PROFILE`
///
/// `cargo:rustc-env=VERGEN_CARGO_PROFILE=debug`
///
/// This output is made available by cargo at build time and represents the current profile cargo is using during the build.
const CARGO_PROFILE = 0b0100_0000_0000_0000_0000;
/// Output the cargo features instruction `VERGEN_CARGO_FEATURES`
///
/// `cargo:rustc-env=VERGEN_CARGO_FEATURES=git,build`
///
/// This output is made available by cargo at build time and represents the current features cargo has enabled during the build.
const CARGO_FEATURES = 0b1000_0000_0000_0000_0000;
}
);
//! Internal Constants

// Build Constants
pub(crate) const BUILD_TIMESTAMP_NAME: &str = "VERGEN_BUILD_TIMESTAMP";
Expand Down Expand Up @@ -213,56 +41,6 @@ pub(crate) const CARGO_FEATURES: &str = "VERGEN_CARGO_FEATURES";
mod test {
use super::*;

#[test]
fn bitflags_dont_change() {
assert_eq!(ConstantsFlags::BUILD_TIMESTAMP.bits(), 0b0000_0001);
assert_eq!(ConstantsFlags::BUILD_DATE.bits(), 0b0000_0010);
assert_eq!(ConstantsFlags::SHA.bits(), 0b0000_0100);
assert_eq!(ConstantsFlags::SHA_SHORT.bits(), 0b0000_1000);
assert_eq!(ConstantsFlags::COMMIT_DATE.bits(), 0b0001_0000);
assert_eq!(ConstantsFlags::SEMVER.bits(), 0b0100_0000);
assert_eq!(ConstantsFlags::SEMVER_LIGHTWEIGHT.bits(), 0b1000_0000);
assert_eq!(
ConstantsFlags::REBUILD_ON_HEAD_CHANGE.bits(),
0b0001_0000_0000
);
assert_eq!(
ConstantsFlags::SEMVER_FROM_CARGO_PKG.bits(),
0b0010_0000_0000
);
assert_eq!(ConstantsFlags::RUSTC_SEMVER.bits(), 0b0100_0000_0000);
assert_eq!(ConstantsFlags::RUSTC_CHANNEL.bits(), 0b1000_0000_0000);
assert_eq!(
ConstantsFlags::RUSTC_HOST_TRIPLE.bits(),
0b0001_0000_0000_0000
);
assert_eq!(ConstantsFlags::BRANCH.bits(), 0b0010_0000_0000_0000);
assert_eq!(
ConstantsFlags::RUSTC_COMMIT_HASH.bits(),
0b0100_0000_0000_0000
);
assert_eq!(
ConstantsFlags::RUSTC_COMMIT_DATE.bits(),
0b1000_0000_0000_0000
);
assert_eq!(
ConstantsFlags::RUSTC_LLVM_VERSION.bits(),
0b0001_0000_0000_0000_0000
);
assert_eq!(
ConstantsFlags::CARGO_TARGET_TRIPLE.bits(),
0b0010_0000_0000_0000_0000
);
assert_eq!(
ConstantsFlags::CARGO_PROFILE.bits(),
0b0100_0000_0000_0000_0000
);
assert_eq!(
ConstantsFlags::CARGO_FEATURES.bits(),
0b1000_0000_0000_0000_0000
);
}

#[test]
fn constants_dont_change() {
// Build Constants
Expand Down
5 changes: 1 addition & 4 deletions src/error.rs
View file
Open in desktop
Expand Up @@ -10,9 +10,6 @@

use std::fmt;

/// A result that must include an `crate::error::Error`
pub(crate) type Result<T> = std::result::Result<T, Error>;

enum ErrKind {
Protocol,
Env,
Expand All @@ -30,7 +27,7 @@ impl fmt::Display for ErrKind {

/// An error generated from the `vergen` library
#[derive(Debug, thiserror::Error)]
pub enum Error {
pub(crate) enum Error {
/// An error from the `git2` library
#[cfg(feature = "git")]
#[error("{}: An error occurred in the 'git2' library: {}", ErrKind::Protocol, .0)]
Expand Down