Adjust all changelogs to fulfil requirements for publishing (#198)

Byron · Byron · commit 04b9ca025a16 · 2021-10-14T15:05:56.000+08:00
diff --git a/cargo-smart-release/src/command/release/manifest.rs b/cargo-smart-release/src/command/release/manifest.rs
@@ -264,7 +264,8 @@ pub(in crate::command::release_impl) fn edit_version_and_fixup_dependent_crates_
                     logs.iter().map(|p| p.name.as_str()).collect::<Vec<_>>().join(", ");
                 if skip_publish {
                     log::warn!(
-                        "Please consider creating changelog entries for crate(s) {}",
+                        "Please consider creating changelog entries for crate{}: {}",
+                        if logs.len() == 1 { "" } else { "s" },
                         names_of_crates_in_need_of_changelog_entry
                     );
                     None
@@ -310,12 +311,17 @@ pub(in crate::command::release_impl) fn edit_version_and_fixup_dependent_crates_
             let names_of_crates_that_would_need_review =
                 comma_separated_crate_names(&changelog_ids_with_statistical_segments_only);
             log::warn!(
-                "WOULD {} as the changelog entry is empty for crates {}",
+                "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 {
+                    ""
+                } else {
+                    "s"
+                },
                 names_of_crates_that_would_need_review
             );
             if !changelog_ids_probably_lacking_user_edits.is_empty() {
diff --git a/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-b-dry-run-success-multi-crate-unconditional b/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-b-dry-run-success-multi-crate-unconditional
@@ -13,7 +13,7 @@
 [INFO ] Pending 'c' manifest version update: "8.1.0"
 [INFO ] Pending 'c' manifest dependencies update: 'b = "^0.9.0"' (from  "0.8.0" )
 [INFO ] WOULD persist changes to 3 manifests and 2 changelogs with: "Bump a v0.9.0, b v0.9.0, safety bump c v8.1.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates a, b
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates: a, b
 [INFO ] WOULD run "git" "commit" "-am" "Bump a v0.9.0, b v0.9.0, safety bump c v8.1.0"
 [INFO ] WOULD create tag a-v0.9.0
 [INFO ] WOULD create tag b-v0.9.0
diff --git a/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-b-dry-run-success-unconditional b/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-b-dry-run-success-unconditional
@@ -11,7 +11,7 @@
 [INFO ] Pending 'c' manifest version update: "8.1.0"
 [INFO ] Pending 'c' manifest dependencies update: 'b = "^0.9.0"' (from  "0.8.0" )
 [INFO ] WOULD persist changes to 3 manifests and 1 changelogs with: "Bump a v0.9.0, safety bump 2 crates\n\nSAFETY BUMP: b v0.9.0, c v8.1.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates a
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crate: a
 [INFO ] WOULD run "git" "commit" "-am" "Bump a v0.9.0, safety bump 2 crates\n\nSAFETY BUMP: b v0.9.0, c v8.1.0"
 [INFO ] WOULD create tag a-v0.9.0
 [INFO ] Congratulations for the new release of 'b' 🎉
@@ -21,6 +21,6 @@
 [INFO ] Pending 'c' manifest version update: "8.1.0"
 [INFO ] Pending 'c' manifest dependencies update: 'b = "^0.9.0"' (from  "0.8.0" )
 [INFO ] WOULD persist changes to 2 manifests and 1 changelogs with: "Bump b v0.9.0, safety bump c v8.1.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates b
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crate: b
 [INFO ] WOULD run "git" "commit" "-am" "Bump b v0.9.0, safety bump c v8.1.0"
 [INFO ] WOULD create tag b-v0.9.0
diff --git a/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-dry-run-success b/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-dry-run-success
@@ -7,6 +7,6 @@
 [INFO ] WOULD prepare release of a v0.8.0
 [INFO ] WOULD edit existing changelog for 'a'
 [INFO ] WOULD persist changes to 1 manifests and 1 changelogs with: "Bump a v0.8.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates a
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crate: a
 [INFO ] WOULD run "git" "commit" "-am" "Bump a v0.8.0"
 [INFO ] WOULD create tag a-v0.8.0
diff --git a/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-dry-run-success-multi-crate b/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-dry-run-success-multi-crate
@@ -6,6 +6,6 @@
 [INFO ] WOULD prepare releases of a v0.8.0
 [INFO ] WOULD edit existing changelog for 'a'
 [INFO ] WOULD persist changes to 1 manifests and 1 changelogs with: "Bump a v0.8.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates a
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crate: a
 [INFO ] WOULD run "git" "commit" "-am" "Bump a v0.8.0"
 [INFO ] WOULD create tag a-v0.8.0
diff --git a/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-dry-run-success-multi-crate-auto-bump-no-change b/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-dry-run-success-multi-crate-auto-bump-no-change
@@ -7,6 +7,6 @@
 [INFO ] WOULD prepare releases of a v0.8.0
 [INFO ] WOULD edit existing changelog for 'a'
 [INFO ] WOULD persist changes to 1 manifests and 1 changelogs with: "Bump a v0.8.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates a
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crate: a
 [INFO ] WOULD run "git" "commit" "-am" "Bump a v0.8.0"
 [INFO ] WOULD create tag a-v0.8.0
diff --git a/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-dry-run-success-multi-crate-unconditional b/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-dry-run-success-multi-crate-unconditional
@@ -10,6 +10,6 @@
 [INFO ] Pending 'c' manifest version update: "8.1.0"
 [INFO ] Pending 'c' manifest dependencies update: 'b = "^0.9.0"' (from  "0.8.0" )
 [INFO ] WOULD persist changes to 3 manifests and 1 changelogs with: "Bump a v0.9.0, safety bump 2 crates\n\nSAFETY BUMP: b v0.9.0, c v8.1.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates a
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crate: a
 [INFO ] WOULD run "git" "commit" "-am" "Bump a v0.9.0, safety bump 2 crates\n\nSAFETY BUMP: b v0.9.0, c v8.1.0"
 [INFO ] WOULD create tag a-v0.9.0
diff --git a/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-dry-run-success-unconditional b/cargo-smart-release/tests/snapshots/triple-depth-workspace/a-dry-run-success-unconditional
@@ -10,6 +10,6 @@
 [INFO ] Pending 'c' manifest version update: "8.1.0"
 [INFO ] Pending 'c' manifest dependencies update: 'b = "^0.9.0"' (from  "0.8.0" )
 [INFO ] WOULD persist changes to 3 manifests and 1 changelogs with: "Bump a v0.9.0, safety bump 2 crates\n\nSAFETY BUMP: b v0.9.0, c v8.1.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates a
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crate: a
 [INFO ] WOULD run "git" "commit" "-am" "Bump a v0.9.0, safety bump 2 crates\n\nSAFETY BUMP: b v0.9.0, c v8.1.0"
 [INFO ] WOULD create tag a-v0.9.0
diff --git a/cargo-smart-release/tests/snapshots/triple-depth-workspace/c-dry-run-success-multi-crate-auto-bump-breaking-change b/cargo-smart-release/tests/snapshots/triple-depth-workspace/c-dry-run-success-multi-crate-auto-bump-breaking-change
@@ -18,7 +18,7 @@
 [INFO ] WOULD edit existing changelog for 'b'
 [INFO ] WOULD create a new changelog for 'c'
 [INFO ] WOULD persist changes to 3 manifests and 3 changelogs (1 new) with: "Bump a v0.8.0, b v0.8.0, c v8.0.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates a, b
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates: a, b
 [INFO ] WOULD run "git" "commit" "-am" "Bump a v0.8.0, b v0.8.0, c v8.0.0"
 [INFO ] WOULD create tag a-v0.8.0
 [INFO ] WOULD create tag b-v0.8.0
diff --git a/cargo-smart-release/tests/snapshots/triple-depth-workspace/c-dry-run-success-multi-crate-auto-bump-minor-change b/cargo-smart-release/tests/snapshots/triple-depth-workspace/c-dry-run-success-multi-crate-auto-bump-minor-change
@@ -18,7 +18,7 @@
 [INFO ] WOULD edit existing changelog for 'b'
 [INFO ] WOULD create a new changelog for 'c'
 [INFO ] WOULD persist changes to 3 manifests and 3 changelogs (1 new) with: "Bump a v0.8.0, b v0.8.0, c v8.0.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates a, b
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates: a, b
 [INFO ] WOULD run "git" "commit" "-am" "Bump a v0.8.0, b v0.8.0, c v8.0.0"
 [INFO ] WOULD create tag a-v0.8.0
 [INFO ] WOULD create tag b-v0.8.0
diff --git a/cargo-smart-release/tests/snapshots/triple-depth-workspace/c-dry-run-success-multi-crate-auto-bump-no-change b/cargo-smart-release/tests/snapshots/triple-depth-workspace/c-dry-run-success-multi-crate-auto-bump-no-change
@@ -18,7 +18,7 @@
 [INFO ] WOULD edit existing changelog for 'b'
 [INFO ] WOULD create a new changelog for 'c'
 [INFO ] WOULD persist changes to 3 manifests and 3 changelogs (1 new) with: "Bump a v0.8.0, b v0.8.0, c v8.0.0"
-[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates a, b, c
+[WARN ] WOULD ask for review after commit as the changelog entry is empty for crates: a, b, c
 [INFO ] WOULD run "git" "commit" "-am" "Bump a v0.8.0, b v0.8.0, c v8.0.0"
 [INFO ] WOULD create tag a-v0.8.0
 [INFO ] WOULD create tag b-v0.8.0
diff --git a/git-actor/CHANGELOG.md b/git-actor/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## v0.5.3 (2021-10-12)
 
+This release contains no functional changes.
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
diff --git a/git-diff/CHANGELOG.md b/git-diff/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## v0.10.0 (2021-10-12)
 
+It looks like there were no functional changes despite the minor version bump.
+Please consider it a fluke that will be fixed with `cargo smart-release` automating
+version number generation.
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
diff --git a/git-lock/CHANGELOG.md b/git-lock/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## v1.0.1 (2021-10-12)
 
+This release contains no functional changes, but a more useful changelog.
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
diff --git a/git-odb/CHANGELOG.md b/git-odb/CHANGELOG.md
@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## v0.22.0 (2021-10-12)
 
+### Dependency Upgrade (BREAKING)
+
+* `git-traverse` saw a breaking change moving to v0.9, which triggered this crate to signal a breaking change, too.
+
+### Improvements
+
+* pack-ids as generated when instantiating a compound database are now sequential. That way, they never clash which
+  was possible before when it was using a CRC32 over the filename.
+
+  The latter was done to allow deduplicating packs, but it turns out not to be necessary just yet.
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
diff --git a/git-packetline/CHANGELOG.md b/git-packetline/CHANGELOG.md
@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## v0.11.0 (2021-10-12)
 
+### Dependency Upgrade (BREAKING)
+
+* `git-traverse` saw a breaking change moving to v0.9, which triggered this crate to signal a breaking change, too.
+
+### Type Change (BREAKING)
+
+* `read_line(…)` now strongly types `ERR` packet lines using the new `read::Error`
+   type instead of transforming it into a string-error.
+   This makes it easier to retrieve the exact error message from the
+   returned `std::io::Error` which is useful for presentation to the user.
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
diff --git a/git-tempfile/CHANGELOG.md b/git-tempfile/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## v1.0.3 (2021-10-12)
 
+This release contains no functional changes, but a more useful changelog.
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
diff --git a/git-transport/CHANGELOG.md b/git-transport/CHANGELOG.md
@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## v0.12.0 (2021-10-12)
 
+### Dependency Upgrade (BREAKING)
+
+* `git-traverse` saw a breaking change moving to v0.9, which triggered this crate to signal a breaking change, too.
+
+### Improvements
+
+* `git-packetline` is now publicly re-exported as `packetline`.
+  
+  This helps to avoid additional dependencies which in turn may have breaking
+  changes. Re-using `packetline` assures it's usable.
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
diff --git a/git-url/CHANGELOG.md b/git-url/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## v0.3.4 (2021-10-12)
 
+This release contains no functional change, but a more useful changelog.
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
diff --git a/git-validate/CHANGELOG.md b/git-validate/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## v0.5.3 (2021-10-12)
 
+This release contains no functional changes.
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
