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

feat(build): Add extra version information #418

Merged
merged 1 commit into from
Mar 23, 2024
Merged

feat(build): Add extra version information #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cli/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bootc"
version = "0.1.0"
version = "0.1.9"
edition = "2021"
license = "MIT OR Apache-2.0"
repository = "https://github.com/cgwalters/bootc"
Expand Down
5 changes: 3 additions & 2 deletions lib/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ license = "MIT OR Apache-2.0"
name = "bootc-lib"
readme = "README.md"
repository = "https://github.com/cgwalters/bootc"
version = "0.1.0"
version = "0.1.9"
rust-version = "1.64.0"
build = "build.rs"

include = ["/src", "LICENSE-APACHE", "LICENSE-MIT"]

Expand All @@ -17,7 +18,7 @@ anyhow = "1.0"
camino = { version = "1.1.6", features = ["serde1"] }
ostree-ext = { version = "0.13.3" }
chrono = { version = "0.4.35", features = ["serde"] }
clap = { version= "4.5", features = ["derive"] }
clap = { version= "4.5", features = ["derive","cargo"] }
clap_mangen = { version = "0.2", optional = true }
cap-std-ext = "4"
hex = "^0.4.3"
Expand Down
22 changes: 22 additions & 0 deletions lib/build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// build.rs

use std::env;
use std::fs;
use std::path::Path;

fn main() {
let out_dir = env::var_os("OUT_DIR").unwrap();
let dest_path = Path::new(&out_dir).join("version.rs");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just so I understand better...is this build.rs effectively a workaround for the constant generated by the clap tooling in https://docs.rs/clap/latest/clap/macro.crate_version.html not having a docstring?

Or basically can you just add a comment with why we need this build.rs? Something like:

// Generate a source file with the crate version that includes a documentation string
// so that our #[deny(missing_docs)] works

or something like that?

(It seems like we could send a patch to clap to add a dummy docstring too?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doing this in order to then be able to pull in other information from the environment. In this way, we could have the version string reflect that it's a dev build, or do something different at release. It doesn't do that now. If you want me to go even simpler now and include the build.rs later when I get an actual use-case, I'm fine with that too.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a strong opinion, good with this as as is. Thanks for working on this!

fs::write(
&dest_path,
"
#[allow(dead_code)]
#[allow(clippy::all)]
use clap::crate_version;
#[doc=r#\"Version string\"#]
pub const CLAP_LONG_VERSION: &str = crate_version!();
",
)
.unwrap();
println!("cargo:rerun-if-changed=build.rs");
}
3 changes: 3 additions & 0 deletions lib/src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ use crate::spec::Host;
use crate::spec::ImageReference;
use crate::utils::sigpolicy_from_opts;

include!(concat!(env!("OUT_DIR"), "/version.rs"));

/// Perform an upgrade operation
#[derive(Debug, Parser)]
pub(crate) struct UpgradeOpts {
Expand Down Expand Up @@ -171,6 +173,7 @@ pub(crate) enum TestingOpts {
#[derive(Debug, Parser)]
#[clap(name = "bootc")]
#[clap(rename_all = "kebab-case")]
#[clap(version,long_version=CLAP_LONG_VERSION)]
#[allow(clippy::large_enum_variant)]
pub(crate) enum Opt {
/// Download and queue an updated container image to apply.
Expand Down