use crate::config;
use crate::error::CliError;
use crate::ops::git;
use crate::ops::replace::{Template, NOW};
use crate::steps::plan;
#[derive(Debug, Clone, clap::Args)]
pub struct CommitStep {
#[command(flatten)]
manifest: clap_cargo::Manifest,
#[arg(short, long = "config", value_name = "PATH")]
custom_config: Option<std::path::PathBuf>,
#[arg(long)]
isolated: bool,
#[arg(long, value_delimiter = ',')]
allow_branch: Option<Vec<String>>,
#[arg(short = 'x', long)]
execute: bool,
#[arg(short = 'n', long, conflicts_with = "execute", hide = true)]
dry_run: bool,
#[arg(long)]
no_confirm: bool,
#[command(flatten)]
commit: crate::config::CommitArgs,
}
impl CommitStep {
pub fn run(&self) -> Result<(), CliError> {
git::git_version()?;
if self.dry_run {
let _ =
crate::ops::shell::warn("`--dry-run` is superfluous, dry-run is done by default");
}
let ws_meta = self
.manifest
.metadata()
.features(cargo_metadata::CargoOpt::AllFeatures)
.exec()?;
let config = self.to_config();
let ws_config = crate::config::load_workspace_config(&config, &ws_meta)?;
let pkgs = plan::load(&config, &ws_meta)?;
let pkgs = plan::plan(pkgs)?;
let (selected_pkgs, excluded_pkgs): (Vec<_>, Vec<_>) = pkgs
.into_iter()
.map(|(_, pkg)| pkg)
.partition(|p| p.config.release());
if crate::ops::git::is_dirty(ws_meta.workspace_root.as_std_path())?.is_none() {
let _ = crate::ops::shell::error("nothing to commit");
return Err(2.into());
}
let dry_run = !self.execute;
let mut failed = false;
failed |= !super::verify_git_branch(
ws_meta.workspace_root.as_std_path(),
&ws_config,
dry_run,
log::Level::Warn,
)?;
failed |= !super::verify_if_behind(
ws_meta.workspace_root.as_std_path(),
&ws_config,
dry_run,
log::Level::Warn,
)?;
super::confirm("Commit", &selected_pkgs, self.no_confirm, dry_run)?;
if ws_config.is_workspace {
let consolidate_commits = super::consolidate_commits(&selected_pkgs, &excluded_pkgs)?;
if !consolidate_commits {
let _ = crate::shell::warn(
"ignoring `consolidate-commits=false`; `cargo release commit` can effectively only do one commit",
);
}
super::commit::workspace_commit(&ws_meta, &ws_config, &selected_pkgs, dry_run)?;
} else if !selected_pkgs.is_empty() {
let selected_pkg = selected_pkgs
.first()
.expect("non-workspace can have at most 1 package");
super::commit::pkg_commit(selected_pkg, dry_run)?;
}
super::finish(failed, dry_run)
}
fn to_config(&self) -> crate::config::ConfigArgs {
crate::config::ConfigArgs {
custom_config: self.custom_config.clone(),
isolated: self.isolated,
allow_branch: self.allow_branch.clone(),
commit: self.commit.clone(),
..Default::default()
}
}
}
pub fn pkg_commit(pkg: &plan::PackageRelease, dry_run: bool) -> Result<(), CliError> {
let cwd = &pkg.package_root;
let crate_name = pkg.meta.name.as_str();
let version = pkg.planned_version.as_ref().unwrap_or(&pkg.initial_version);
let prev_version_var = pkg.initial_version.bare_version_string.as_str();
let prev_metadata_var = pkg.initial_version.full_version.build.as_str();
let version_var = version.bare_version_string.as_str();
let metadata_var = version.full_version.build.as_str();
let template = Template {
prev_version: Some(prev_version_var),
prev_metadata: Some(prev_metadata_var),
version: Some(version_var),
metadata: Some(metadata_var),
crate_name: Some(crate_name),
date: Some(NOW.as_str()),
..Default::default()
};
let commit_msg = template.render(pkg.config.pre_release_commit_message());
let sign = pkg.config.sign_commit();
if !git::commit_all(cwd, &commit_msg, sign, dry_run)? {
return Err(101.into());
}
Ok(())
}
pub fn workspace_commit(
ws_meta: &cargo_metadata::Metadata,
ws_config: &config::Config,
pkgs: &[plan::PackageRelease],
dry_run: bool,
) -> Result<(), CliError> {
let shared_version = super::find_shared_versions(pkgs)?;
let shared_commit_msg = {
let version_var = shared_version
.as_ref()
.map(|v| v.bare_version_string.as_str());
let metadata_var = shared_version
.as_ref()
.map(|v| v.full_version.build.as_str());
let template = Template {
version: version_var,
metadata: metadata_var,
date: Some(NOW.as_str()),
..Default::default()
};
template.render(ws_config.pre_release_commit_message())
};
if !git::commit_all(
ws_meta.workspace_root.as_std_path(),
&shared_commit_msg,
ws_config.sign_commit(),
dry_run,
)? {
return Err(101.into());
}
Ok(())
}