Merge pull request GitoxideLabs#61 from GitoxideLabs/allow-generated

feat: add `--allow-empty-release-message` actually ignore empty changelogs

Author: Byron

src/cli/main.rs

@@ -59,6 +59,7 @@ fn main() -> anyhow::Result<()> {
             no_changelog_preview,
             no_changelog_github_release,
             allow_fully_generated_changelogs,
+            allow_empty_release_message,
             no_dependencies,
             no_isolate_dependencies_from_breaking_changes,
             capitalize_commit,
@@ -88,6 +89,7 @@ fn main() -> anyhow::Result<()> {
                     preview: !no_changelog_preview,
                     generator_segments: names_to_segment_selection(&changelog_without)?,
                     allow_fully_generated_changelogs,
+                    allow_empty_release_message,
                     changelog_links: !no_changelog_links,
                     allow_changelog_github_release: !no_changelog_github_release,
                     capitalize_commit,

src/cli/options.rs

@@ -84,12 +84,15 @@ pub enum SubCommands {
         no_changelog_github_release: bool,
 
         /// If changelogs are generated from git-conventional comments extracted from the commit history exclusively, publishes
-        /// will fail as in order to give opportunity to author at least a portion of the upcoming release.
+        /// will fail as to give an opportunity to author at least a portion of the upcoming release.
         ///
         /// With this flag set, the release will not stop.
         /// Note that changelog entries purely composed of statistical information will always stop a release.
         #[clap(long, help_heading = Some("CHANGELOG-EXPERT"))]
         allow_fully_generated_changelogs: bool,
+        /// If changelogs have no message or release information at all, continue anyway.
+        #[clap(long, help_heading = Some("CHANGELOG-EXPERT"))]
+        allow_empty_release_message: bool,
 
         /// Do not generate links to commits and issues when writing the changelogs. This currently only works for GitHub.
         #[clap(long, help_heading = Some("CHANGELOG"))]

src/command/mod.rs

@@ -23,6 +23,7 @@ pub mod release {
         pub preview: bool,
         pub generator_segments: segment::Selection,
         pub allow_fully_generated_changelogs: bool,
+        pub allow_empty_release_message: bool,
         pub changelog_links: bool,
         pub allow_changelog_github_release: bool,
         pub capitalize_commit: bool,

src/command/release/manifest.rs

@@ -5,11 +5,6 @@ use std::{
     str::FromStr,
 };
 
-use anyhow::{bail, Context as ContextTrait};
-use cargo_metadata::{camino::Utf8PathBuf, Package};
-use gix::{lock::File, Id};
-use semver::{Version, VersionReq};
-
 use super::{cargo, git, Context, Options};
 use crate::{
     changelog,
@@ -18,6 +13,10 @@ use crate::{
     utils::{names_and_versions, try_to_published_crate_and_new_version, version_req_unset_or_default, will},
     version, ChangeLog,
 };
+use anyhow::{bail, Context as ContextTrait};
+use cargo_metadata::{camino::Utf8PathBuf, Package};
+use gix::{lock::File, Id};
+use semver::{Version, VersionReq};
 
 pub struct Outcome<'repo, 'meta> {
     pub commit_id: Option<Id<'repo>>,
@@ -76,8 +75,9 @@ pub(in crate::command::release_impl) fn edit_version_and_fixup_dependent_crates_
         )?;
     }
 
-    let would_stop_release = !(changelog_ids_with_statistical_segments_only.is_empty()
-        && changelog_ids_probably_lacking_user_edits.is_empty());
+    let would_stop_release = (!changelog_ids_with_statistical_segments_only.is_empty()
+        && !opts.allow_fully_generated_changelogs)
+        || (!changelog_ids_probably_lacking_user_edits.is_empty() && !opts.allow_empty_release_message);
     let safety_bumped_packages = crates
         .iter()
         .filter_map(|c| c.mode.safety_bump().map(|b| (c.package, &b.next_release)))
@@ -123,6 +123,7 @@ fn commit_locks_and_generate_bail_message(
         dry_run,
         skip_publish,
         allow_fully_generated_changelogs,
+        allow_empty_release_message,
         ..
     }: Options,
 ) -> anyhow::Result<Option<String>> {
@@ -134,15 +135,15 @@ fn commit_locks_and_generate_bail_message(
                 || changelog_ids_with_statistical_segments_only.contains(&idx)
             {
                 lock.commit()?;
-                if !changelog_ids_with_statistical_segments_only.is_empty() {
+                if !allow_fully_generated_changelogs && !changelog_ids_with_statistical_segments_only.is_empty() {
                     packages_whose_changelogs_need_edits
                         .get_or_insert_with(Vec::new)
                         .push(package);
                 }
             } else {
                 drop(lock);
             }
-            if changelog_ids_probably_lacking_user_edits.contains(&idx) {
+            if allow_empty_release_message || changelog_ids_probably_lacking_user_edits.contains(&idx) {
                 packages_which_might_be_fully_generated
                     .get_or_insert_with(Vec::new)
                     .push(package);
@@ -152,42 +153,40 @@ fn commit_locks_and_generate_bail_message(
             manifest_lock.commit()?;
         }
         // This is dangerous as incompatibilities can happen here, leaving the working tree dirty.
-        // For now we leave it that way without auto-restoring originals to facilitate debugging.
+        // For now, we leave it that way without auto-restoring originals to facilitate debugging.
         cargo::refresh_lock_file()?;
 
-        packages_whose_changelogs_need_edits
-            .and_then(|logs| {
-                let names_of_crates_in_need_of_changelog_entry =
-                    logs.iter().map(|p| p.name.as_str()).collect::<Vec<_>>().join(", ");
-                if skip_publish {
-                    log::warn!(
-                        "Please consider creating changelog entries for crate{}: {}",
-                        if logs.len() == 1 { "" } else { "s" },
-                        names_of_crates_in_need_of_changelog_entry
-                    );
-                    None
-                } else {
-                    Some(format!(
-                        "Write changelog entries for crate(s) {names_of_crates_in_need_of_changelog_entry} and try again"
-                    ))
-                }
-            })
-            .or_else(|| {
-                packages_which_might_be_fully_generated.and_then(|packages| {
-                    let crate_names = packages.iter().map(|p| p.name.as_str()).collect::<Vec<_>>().join(", ");
-                    (!allow_fully_generated_changelogs).then(|| {
-                        format!(
-                            "{} edits by hand to avoid being entirely generated: {}",
-                            if crate_names.len() == 1 {
-                                "This changelog needs"
-                            } else {
-                                "These changelogs need"
-                            },
-                            crate_names
-                        )
-                    })
-                })
+        if let Some(logs) = packages_whose_changelogs_need_edits {
+            let names_of_crates_in_need_of_changelog_entry =
+                logs.iter().map(|p| p.name.as_str()).collect::<Vec<_>>().join(", ");
+            if skip_publish {
+                log::warn!(
+                    "Please consider creating changelog entries for crate{}: {}",
+                    if logs.len() == 1 { "" } else { "s" },
+                    names_of_crates_in_need_of_changelog_entry
+                );
+                None
+            } else {
+                Some(format!(
+                    "Write changelog entries for crate(s) {names_of_crates_in_need_of_changelog_entry} and try again"
+                ))
+            }
+        } else if let Some(packages) = packages_which_might_be_fully_generated {
+            let crate_names = packages.iter().map(|p| p.name.as_str()).collect::<Vec<_>>().join(", ");
+            (!allow_fully_generated_changelogs).then(|| {
+                format!(
+                    "{} edits by hand to avoid being entirely generated: {}",
+                    if crate_names.len() == 1 {
+                        "This changelog needs"
+                    } else {
+                        "These changelogs need"
+                    },
+                    crate_names
+                )
             })
+        } else {
+            None
+        }
     } else {
         let crate_names = |ids: &[usize]| {
             ids.iter()
@@ -207,23 +206,27 @@ fn commit_locks_and_generate_bail_message(
             let crate_names = crate_names(&changelog_ids_with_statistical_segments_only);
             let names_of_crates_that_would_need_review = crate_names.join(", ");
             log::warn!(
-                "WOULD {} as the changelog entry is empty for crate{}: {}",
-                if skip_publish {
-                    "ask for review after commit"
-                } else {
-                    "stop release after commit"
-                },
-                if changelog_ids_with_statistical_segments_only.len() == 1 {
+                "WOULD {message}{plural_s}: {crates}",
+                crates = names_of_crates_that_would_need_review,
+                plural_s = if changelog_ids_with_statistical_segments_only.len() == 1 {
                     ""
                 } else {
                     "s"
                 },
-                names_of_crates_that_would_need_review
-            );
-            log::warn!(
-                "To fix the changelog manually, run: cargo changelog --write {}",
-                ctx.base.crate_names.join(" ")
+                message = if allow_empty_release_message {
+                    "continue despite the changelog entry being empty for crate"
+                } else if skip_publish {
+                    "ask for review after commit as the changelog entry is empty for crate"
+                } else {
+                    "stop release after commit as the changelog entry is empty for crate"
+                },
             );
+            if !allow_empty_release_message {
+                log::warn!(
+                    "To fix the changelog manually, run: cargo changelog --write {}",
+                    ctx.base.crate_names.join(" ")
+                );
+            }
         }
         if !changelog_ids_probably_lacking_user_edits.is_empty() {
             let crate_names = crate_names(&changelog_ids_probably_lacking_user_edits);

tests/snapshots/triple-depth-workspace/a-dry-run-success-multi-crate-auto-bump-breaking-change-dependant-publish

@@ -11,11 +11,11 @@
 [TRACE] Pending 'b' manifest dependencies update: 'a = "^0.9.0"' (from  "0.8.0" )
 [TRACE] Pending 'c' manifest version update: "9.0.0"
 [TRACE] Pending 'c' manifest dependencies update: 'b = "^0.9.0"' (from  "0.8.0" )
-[TRACE] WOULD persist changes to 3 manifests and 3 changelogs (1 new) with: "Adjusting changelogs prior to release of a v0.9.0, b v0.9.0, c v9.0.0, safety bump 2 crates\n\nSAFETY BUMP: b v0.9.0, c v9.0.0"
+[TRACE] WOULD persist changes to 3 manifests and 3 changelogs (1 new) with: "Bump a v0.9.0, b v0.9.0, c v9.0.0, safety bump 2 crates\n\nSAFETY BUMP: b v0.9.0, c v9.0.0"
 [INFO ] Up to 3 changelogs would be previewed if the --execute is set and --no-changelog-preview is unset.
 [WARN ] WOULD ask for review after commit as the changelog entry is empty for crates: b, c
 [WARN ] To fix the changelog manually, run: cargo changelog --write c a
-[TRACE] WOULD run "git" "commit" "-am" "Adjusting changelogs prior to release of a v0.9.0, b v0.9.0, c v9.0.0, safety bump 2 crates\n\nSAFETY BUMP: b v0.9.0, c v9.0.0"
+[TRACE] WOULD run "git" "commit" "-am" "Bump a v0.9.0, b v0.9.0, c v9.0.0, safety bump 2 crates\n\nSAFETY BUMP: b v0.9.0, c v9.0.0"
 [TRACE] WOULD create tag object a-v0.9.0 with changelog message, first line is: '### Refactor (BREAKING)'
 [TRACE] WOULD create tag object b-v0.9.0 with changelog message, first line is: '### Commit Statistics'
 [TRACE] WOULD create tag object c-v9.0.0 with changelog message, first line is: '### Commit Statistics'