Allow 'refactor' and 'other' in conventional messages if they have breaking changes (#198)

Byron · Byron · commit 4eebaac669e5 · 2021-10-10T21:50:11.000+08:00
diff --git a/cargo-smart-release/src/changelog/parse.rs b/cargo-smart-release/src/changelog/parse.rs
@@ -162,6 +162,8 @@ impl Section {
                                 || title.starts_with(as_headline("change").expect("valid"))
                                 || title.starts_with(as_headline("docs").expect("valid"))
                                 || title.starts_with(as_headline("perf").expect("valid"))
+                                || title.starts_with("refactor")
+                                || title.starts_with("other")
                                 || title.starts_with(as_headline("fix").expect("valid")) =>
                         {
                             State::ParseConventional {
@@ -226,11 +228,13 @@ fn parse_conventional_to_next_section_title(
     level: u32,
     unknown: &mut String,
 ) -> Segment {
-    let is_breaking = title.ends_with(section::segment::Conventional::BREAKING_TITLE);
-    let kind = ["fix", "add", "feat", "revert", "remove", "change", "docs", "perf"]
-        .iter()
-        .find(|kind| title.starts_with(section::segment::conventional::as_headline(*kind).expect("valid")))
-        .expect("BUG: this list needs an update too if new kinds of conventional messages are added");
+    let is_breaking = title.ends_with(section::segment::Conventional::BREAKING_TITLE_ENCLOSED);
+    let kind = [
+        "fix", "add", "feat", "revert", "remove", "change", "docs", "perf", "refactor", "other",
+    ]
+    .iter()
+    .find(|kind| title.starts_with(section::segment::conventional::as_headline(*kind).unwrap_or(*kind)))
+    .expect("BUG: this list needs an update too if new kinds of conventional messages are added");
 
     let mut conventional = section::segment::Conventional {
         kind: *kind,
diff --git a/cargo-smart-release/src/changelog/section/segment.rs b/cargo-smart-release/src/changelog/section/segment.rs
@@ -22,6 +22,7 @@ pub mod conventional {
     }
 
     /// Note that this depends on `crate::commit::message::to_static()`,
+    /// Note having a headline means it won't be written back unless it contains breaking changes.
     pub fn as_headline(kind: &str) -> Option<&'static str> {
         // NOTE: adding one here needs additions to parse.rs
         Some(match kind {
@@ -52,7 +53,8 @@ pub struct Conventional {
 
 impl Conventional {
     pub const REMOVED_HTML_PREFIX: &'static str = "<csr-id-";
-    pub const BREAKING_TITLE: &'static str = "(BREAKING)";
+    pub const BREAKING_TITLE: &'static str = "BREAKING";
+    pub const BREAKING_TITLE_ENCLOSED: &'static str = "(BREAKING)";
 }
 
 pub mod details {
diff --git a/cargo-smart-release/src/changelog/write.rs b/cargo-smart-release/src/changelog/write.rs
@@ -89,15 +89,15 @@ impl section::Segment {
                 is_breaking,
                 removed,
                 messages,
-            }) => match segment::conventional::as_headline(kind) {
+            }) => match segment::conventional::as_headline(kind).or_else(|| is_breaking.then(|| *kind)) {
                 Some(headline) => {
                     writeln!(
                         out,
                         "{} {}{}\n",
                         heading(section_level),
                         headline,
                         if *is_breaking {
-                            format!(" {}", segment::Conventional::BREAKING_TITLE)
+                            format!(" {}", segment::Conventional::BREAKING_TITLE_ENCLOSED)
                         } else {
                             "".into()
                         },
diff --git a/git-actor/CHANGELOG.md b/git-actor/CHANGELOG.md
@@ -11,16 +11,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <csr-read-only-do-not-edit/>
 
- - 1 commit contributed to the release.
+ - 2 commits contributed to the release.
  - 0 commits where understood as [conventional](https://www.conventionalcommits.org).
- - 1 unique issue was worked on
+ - 2 unique issues were worked on
 
 ### Commit Details
 
 <csr-read-only-do-not-edit/>
 
 <details><summary>view details</summary>
 
+ * **#198**
+    - new changelogs for actor and features crates (e0d437c)
  * **Uncategorized**
     - make fmt, but now it picked up some parts that usually don't get altered… (01f7b72)
 </details>
diff --git a/git-diff/CHANGELOG.md b/git-diff/CHANGELOG.md
@@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <csr-read-only-do-not-edit/>
 
- - 10 commits contributed to the release over the course of 14 calendar days.
+ - 12 commits contributed to the release over the course of 26 calendar days.
  - 0 commits where understood as [conventional](https://www.conventionalcommits.org).
  - 2 unique issues were worked on
 
@@ -22,16 +22,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <details><summary>view details</summary>
 
  * **#198**
-    - Rebuild all changelogs to assure properly ordered headlines (cfcaa66)
-    - Sort all commits by time, descending… (7c37a3d)
-    - greatly reduce changelog size now that the traversal fix is applied (3924c03)
-    - Generate changelogs with details (fd0f3bd)
-    - Update all changelogs with details (0732699)
-    - Update changelogs (b30db3b)
+    - Rebuild all changelogs to assure properly ordered headlines (4a9a05f)
+    - Sort all commits by time, descending… (f536bad)
+    - greatly reduce changelog size now that the traversal fix is applied (a0bc98c)
+    - Generate changelogs with details (e1861ca)
+    - Update all changelogs with details (58ab2ae)
+    - Update changelogs (c857d61)
     - Avoid adding newlines which make writing unstable (6b5c394)
     - Fix section headline level (9d6f263)
     - Write first version of changlogs thus far… (719b6bd)
  * **Uncategorized**
+    - make fmt, but now it picked up some parts that usually don't get altered… (01f7b72)
+    - Update changelogs just for fun (21541b3)
     - Bump git-traverse v0.9.0, safety bump 8 crates (d39fabb)
 </details>
 
diff --git a/git-features/CHANGELOG.md b/git-features/CHANGELOG.md
@@ -11,16 +11,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <csr-read-only-do-not-edit/>
 
- - 1 commit contributed to the release.
+ - 2 commits contributed to the release over the course of 1 calendar day.
  - 0 commits where understood as [conventional](https://www.conventionalcommits.org).
- - 1 unique issue was worked on
+ - 2 unique issues were worked on
 
 ### Commit Details
 
 <csr-read-only-do-not-edit/>
 
 <details><summary>view details</summary>
 
+ * **#198**
+    - new changelogs for actor and features crates (e0d437c)
  * **Uncategorized**
     - make fmt, but now it picked up some parts that usually don't get altered… (01f7b72)
 </details>
@@ -624,10 +626,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## v0.1.0 (2020-07-12)
 
-### other
-
- - <csr-id-ab6f98b905f13ed2a7c0c483f34fab63141fbc5b/> try-join with static typing works, but…
-
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
diff --git a/git-hash/CHANGELOG.md b/git-hash/CHANGELOG.md
@@ -7,13 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### New Features
+
+ - <csr-id-ed16bce97c235e7e188444afd7a0d3f7e04a6c72/> `oid::short_hex(len)` for truncated hex representations
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
 
- - 7 commits contributed to the release.
+ - 8 commits contributed to the release over the course of 7 calendar days.
  - 2 commits where understood as [conventional](https://www.conventionalcommits.org).
- - 1 unique issue was worked on
+ - 2 unique issues were worked on
 
 ### Commit Details
 
@@ -22,13 +26,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <details><summary>view details</summary>
 
  * **#198**
-    - Rebuild all changelogs to assure properly ordered headlines (cfcaa66)
-    - Sort all commits by time, descending… (7c37a3d)
-    - greatly reduce changelog size now that the traversal fix is applied (3924c03)
-    - rename `oid::short_hex()` to `oid::to_hex()` (deb99b3)
-    - Fixup remaining changelogs… (0ac488a)
-    - Generate changelogs with details (fd0f3bd)
-    - oid::short_hex(len) for truncated hex representations (d234b97)
+    - Rebuild all changelogs to assure properly ordered headlines (4a9a05f)
+    - Sort all commits by time, descending… (f536bad)
+    - greatly reduce changelog size now that the traversal fix is applied (a0bc98c)
+    - rename `oid::short_hex()` to `oid::to_hex()` (8be4036)
+    - Fixup remaining changelogs… (2f75db2)
+    - Generate changelogs with details (e1861ca)
+    - oid::short_hex(len) for truncated hex representations (ed16bce)
+ * **Uncategorized**
+    - Update changelogs just for fun (21541b3)
 </details>
 
 ## v0.6.0 (2021-09-07)
diff --git a/git-lock/CHANGELOG.md b/git-lock/CHANGELOG.md
@@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <csr-read-only-do-not-edit/>
 
- - 5 commits contributed to the release over the course of 33 calendar days.
+ - 6 commits contributed to the release over the course of 45 calendar days.
  - 0 commits where understood as [conventional](https://www.conventionalcommits.org).
  - 2 unique issues were worked on
 
@@ -22,11 +22,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <details><summary>view details</summary>
 
  * **#198**
-    - Rebuild all changelogs to assure properly ordered headlines (cfcaa66)
-    - Sort all commits by time, descending… (7c37a3d)
-    - greatly reduce changelog size now that the traversal fix is applied (3924c03)
-    - Fixup remaining changelogs… (0ac488a)
+    - Rebuild all changelogs to assure properly ordered headlines (4a9a05f)
+    - Sort all commits by time, descending… (f536bad)
+    - greatly reduce changelog size now that the traversal fix is applied (a0bc98c)
+    - Fixup remaining changelogs… (2f75db2)
  * **Uncategorized**
+    - Update changelogs just for fun (21541b3)
     - Merge pull request #172 from mellowagain/main (61aebbf)
 </details>
 
diff --git a/git-object/CHANGELOG.md b/git-object/CHANGELOG.md
@@ -7,11 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Performance
+
+ - <csr-id-83d591d536d1a43e8523082824ec0b95cca55d34/> parse entry mode into number instead of comparing it to byte strings
+ - <csr-id-f9232acf8e52f8cd95520d122469e136eb07b39f/> ObjectID specific hashers, using the fact that object ids are hashes
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
 
- - 40 commits contributed to the release over the course of 11 calendar days.
+ - 41 commits contributed to the release over the course of 23 calendar days.
  - 3 commits where understood as [conventional](https://www.conventionalcommits.org).
  - 3 unique issues were worked on
 
@@ -22,12 +27,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <details><summary>view details</summary>
 
  * **#198**
-    - Rebuild all changelogs to assure properly ordered headlines (cfcaa66)
-    - Sort all commits by time, descending… (7c37a3d)
-    - greatly reduce changelog size now that the traversal fix is applied (3924c03)
-    - Generate changelogs with details (fd0f3bd)
-    - Update all changelogs with details (0732699)
-    - Update changelogs (b30db3b)
+    - Rebuild all changelogs to assure properly ordered headlines (4a9a05f)
+    - Sort all commits by time, descending… (f536bad)
+    - greatly reduce changelog size now that the traversal fix is applied (a0bc98c)
+    - Generate changelogs with details (e1861ca)
+    - Update all changelogs with details (58ab2ae)
+    - Update changelogs (c857d61)
     - Avoid adding newlines which make writing unstable (6b5c394)
     - Fix section headline level (9d6f263)
     - Write first version of changlogs thus far… (719b6bd)
@@ -60,6 +65,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - ObjectID specific hashers, using the fact that object ids are hashes (f9232ac)
     - Tree parsing now probably is twice as fast… (d1e2b89)
  * **Uncategorized**
+    - Update changelogs just for fun (21541b3)
     - Merge branch 'main' into changelog-generation (c956f33)
     - thanks clippy (d78d382)
     - thanks clippy (4ea1126)
diff --git a/git-odb/CHANGELOG.md b/git-odb/CHANGELOG.md
@@ -11,7 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <csr-read-only-do-not-edit/>
 
- - 13 commits contributed to the release over the course of 14 calendar days.
+ - 14 commits contributed to the release over the course of 26 calendar days.
  - 0 commits where understood as [conventional](https://www.conventionalcommits.org).
  - 3 unique issues were worked on
 
@@ -22,20 +22,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <details><summary>view details</summary>
 
  * **#198**
-    - Rebuild all changelogs to assure properly ordered headlines (cfcaa66)
-    - Sort all commits by time, descending… (7c37a3d)
-    - greatly reduce changelog size now that the traversal fix is applied (3924c03)
-    - Fixup remaining changelogs… (0ac488a)
-    - Generate changelogs with details (fd0f3bd)
-    - Update all changelogs with details (0732699)
-    - Update changelogs (b30db3b)
+    - Rebuild all changelogs to assure properly ordered headlines (4a9a05f)
+    - Sort all commits by time, descending… (f536bad)
+    - greatly reduce changelog size now that the traversal fix is applied (a0bc98c)
+    - Fixup remaining changelogs… (2f75db2)
+    - Generate changelogs with details (e1861ca)
+    - Update all changelogs with details (58ab2ae)
+    - Update changelogs (c857d61)
     - Avoid adding newlines which make writing unstable (6b5c394)
     - Fix section headline level (9d6f263)
     - Write first version of changlogs thus far… (719b6bd)
     - Parse more user generated section content, adapt existing changelogs to work correctly (2f43a54)
  * **#67**
     - Assure pack-ids are actually unique, the simple way… (0509b4f)
  * **Uncategorized**
+    - Update changelogs just for fun (21541b3)
     - Bump git-traverse v0.9.0, safety bump 8 crates (d39fabb)
 </details>
 
diff --git a/git-pack/CHANGELOG.md b/git-pack/CHANGELOG.md
@@ -7,11 +7,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### New Features
+
+ - <csr-id-d6c44e6ab8f436020d4fb235e423b018fd1e7a9f/> dynamically sized full-object speeds up diff-based object counting
+   which is what happens when counting objects for fetches where only changed objects should be sent.
+ - <csr-id-50cf610e8939812c3d2268c48835e2dac67d0c31/> `cache::Object` trait for caching and retrieving whole objects
+ - <csr-id-60c9fad8002b4e3f6b9607bba6361871752f4d3d/> control pack and object cache size in megabytes
+ - <csr-id-5a8c2da6cb1e2accf7cfdccc16bc3a1d0b2a7dbc/> object cache size is configurable
+
+### Fixed
+
+ - <csr-id-d8fe8141e80a9e9a433b5e1a072b850325c806c8/> don't put more objects into the pack cache than needed.
+   
+   Previously when accessing a packed object, it would store the base
+   object into the pack cache (if it wasn't retrieved from there)
+   which is great if that operation is free.
+   
+   Since it isn't, it's better not to stress the cache with puts
+   and trash more objects than necessary.
+   
+   Now only the last decompressed object will be put into the LRU cache.
+ - <csr-id-faf6f813927720c5adf62102f9ce46606ff2617c/> don't include submodules in count,
+   which avoids dealing with missing objects entirely. Those ominous missing objects where just git submodules after all.
+   
+   It's still a good idea to handle these gracefully though, git itself
+   seems to ignore them, too, and so do we at least for now.
+
+### Performance
+
+ - <csr-id-f9232acf8e52f8cd95520d122469e136eb07b39f/> ObjectID specific hashers, using the fact that object ids are hashes
+
 ### Commit Statistics
 
 <csr-read-only-do-not-edit/>
 
- - 25 commits contributed to the release over the course of 15 calendar days.
+ - 27 commits contributed to the release over the course of 27 calendar days.
  - 10 commits where understood as [conventional](https://www.conventionalcommits.org).
  - 4 unique issues were worked on
 
@@ -24,14 +54,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
  * **#164**
     - Avoid duplicate module paths in 'tree' and 'commit' (2f2d856)
  * **#198**
-    - Rebuild all changelogs to assure properly ordered headlines (cfcaa66)
-    - Sort all commits by time, descending… (7c37a3d)
-    - greatly reduce changelog size now that the traversal fix is applied (3924c03)
-    - don't put more objects into the pack cache than needed (d89e474)
-    - Fixup remaining changelogs… (0ac488a)
-    - Generate changelogs with details (fd0f3bd)
-    - Update all changelogs with details (0732699)
-    - Update changelogs (b30db3b)
+    - Rebuild all changelogs to assure properly ordered headlines (4a9a05f)
+    - Sort all commits by time, descending… (f536bad)
+    - greatly reduce changelog size now that the traversal fix is applied (a0bc98c)
+    - don't put more objects into the pack cache than needed (d8fe814)
+    - Fixup remaining changelogs… (2f75db2)
+    - Generate changelogs with details (e1861ca)
+    - Update all changelogs with details (58ab2ae)
+    - Update changelogs (c857d61)
     - Avoid adding newlines which make writing unstable (6b5c394)
     - Fix section headline level (9d6f263)
     - Write first version of changlogs thus far… (719b6bd)
@@ -49,6 +79,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - Count ref-deltas in thin packs as well (80c6994)
     - Add '--thin' flag to pack-create and pass it on (2664d73)
  * **Uncategorized**
+    - make fmt, but now it picked up some parts that usually don't get altered… (01f7b72)
+    - Update changelogs just for fun (21541b3)
     - Bump git-traverse v0.9.0, safety bump 8 crates (d39fabb)
 </details>
 
diff --git a/git-packetline/CHANGELOG.md b/git-packetline/CHANGELOG.md
diff --git a/git-repository/CHANGELOG.md b/git-repository/CHANGELOG.md

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ pub mod conventional {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	/// Note that this depends on `crate::commit::message::to_static()`,
	`25`	`+ /// Note having a headline means it won't be written back unless it contains breaking changes.`
`25`	`26`	`pub fn as_headline(kind: &str) -> Option<&'static str> {`
`26`	`27`	`// NOTE: adding one here needs additions to parse.rs`
`27`	`28`	`Some(match kind {`
`@@ -52,7 +53,8 @@ pub struct Conventional {`
`52`	`53`
`53`	`54`	`impl Conventional {`
`54`	`55`	`pub const REMOVED_HTML_PREFIX: &'static str = "<csr-id-";`
`55`		`- pub const BREAKING_TITLE: &'static str = "(BREAKING)";`
	`56`	`+ pub const BREAKING_TITLE: &'static str = "BREAKING";`
	`57`	`+ pub const BREAKING_TITLE_ENCLOSED: &'static str = "(BREAKING)";`
`56`	`58`	`}`
`57`	`59`
`58`	`60`	`pub mod details {`