refactor(config)!: refactor option git.filter_commits into `changel…

…og.exclude_ungrouped_changes`

Renamed and moved option `git.filter_commits` into `changelog.exclude_ungrouped_changes` for clarity.
Updated description and documentation for option `commit.exclude_ungrouped_changes`.

.github/fixtures/test-keep-a-changelog-links-current-arg/cliff.toml

@@ -76,8 +76,8 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = true
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = true
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest.

.github/fixtures/test-keep-a-changelog-links-latest-arg/cliff.toml

@@ -41,6 +41,8 @@ trim = true
 footer_template = """
 <!-- generated by git-cliff -->
 """
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = true
 
 [release]
 # Regex to select git tags that represent releases.
@@ -76,8 +78,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = true
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

.github/fixtures/test-keep-a-changelog-links-no-tags/cliff.toml

@@ -41,6 +41,8 @@ trim = true
 footer_template = """
 <!-- generated by git-cliff -->
 """
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = true
 
 [release]
 # Regex to select git tags that represent releases.
@@ -76,8 +78,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = true
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

.github/fixtures/test-keep-a-changelog-links-one-tag-bump-arg/cliff.toml

@@ -41,6 +41,8 @@ trim = true
 footer_template = """
 <!-- generated by git-cliff -->
 """
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = true
 
 [release]
 # Regex to select git tags that represent releases.
@@ -76,8 +78,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = true
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

.github/fixtures/test-keep-a-changelog-links-one-tag/cliff.toml

@@ -41,6 +41,8 @@ trim = true
 footer_template = """
 <!-- generated by git-cliff -->
 """
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = true
 
 [release]
 # Regex to select git tags that represent releases.
@@ -76,8 +78,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = true
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

.github/fixtures/test-keep-a-changelog-links-tag-arg/cliff.toml

@@ -41,6 +41,8 @@ trim = true
 footer_template = """
 <!-- generated by git-cliff -->
 """
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = true
 
 [release]
 # Regex to select git tags that represent releases.
@@ -76,8 +78,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = true
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

.github/fixtures/test-keep-a-changelog-links-unreleased-arg/cliff.toml

@@ -41,6 +41,8 @@ trim = true
 footer_template = """
 <!-- generated by git-cliff -->
 """
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = true
 
 [release]
 # Regex to select git tags that represent releases.
@@ -76,8 +78,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = true
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

.github/fixtures/test-keep-a-changelog-links/cliff.toml

@@ -41,6 +41,8 @@ footer_template = """
 """
 # remove the leading and trailing whitespace from the templates
 trim = true
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = true
 
 [release]
 # Regex to select git tags that represent releases.
@@ -76,8 +78,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = true
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

cliff.toml

@@ -59,6 +59,8 @@ trim = true
 postprocessors = [
   { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
 ]
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = false
 
 [release]
 # Regex to select git tags that represent releases.
@@ -108,8 +110,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = false
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "beta|alpha"
 # Whether to order commits newest to oldest or oldest to newest in their group.

config/cliff.toml

@@ -37,6 +37,8 @@ trim = true
 postprocessors = [
   # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
 ]
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = false
 
 [release]
 # # Regex to select git tags that represent releases.
@@ -86,8 +88,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = false
 # # Regex to select git tags that should be excluded from the changelog.
 # exclude_tags_pattern = ""
 # Whether to order commits newest to oldest or oldest to newest in their group.

examples/cocogitto.toml

@@ -47,6 +47,8 @@ trim = true
 postprocessors = [
     { pattern = '\$REPO', replace = "https://github.com/cocogitto/cocogitto" }, # replace repository URL
 ]
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = false
 
 [release]
 # Regex to select git tags that represent releases.
@@ -89,8 +91,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = false
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

examples/detailed.toml

@@ -36,6 +36,8 @@ footer_template = """
 """
 # remove the leading and trailing whitespace from the templates
 trim = true
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = false
 
 [release]
 # Regex to select git tags that represent releases.
@@ -76,8 +78,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = false
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

examples/github-keepachangelog.toml

@@ -66,6 +66,8 @@ footer_template = """
 """
 # remove the leading and trailing whitespace from the templates
 trim = true
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = true
 
 [release]
 # Regex to select git tags that represent releases.
@@ -106,8 +108,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = true
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

examples/github.toml

@@ -56,6 +56,8 @@ footer_template = """
 """
 # A list of postprocessors using regex to modify the changelog.
 postprocessors = []
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = false
 
 [release]
 # Regex to select git tags that represent releases.
@@ -84,8 +86,6 @@ message_preprocessors = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = false
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "beta|alpha"
 # Whether to order commits newest to oldest or oldest to newest in their group.

examples/keepachangelog.toml

@@ -42,6 +42,8 @@ footer_template = """
 """
 # remove the leading and trailing whitespace from the templates
 trim = true
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = true
 
 [release]
 # Regex to select git tags that represent releases.
@@ -77,8 +79,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = true
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

examples/scoped.toml

@@ -30,6 +30,8 @@ footer_template = """
 """
 # remove the leading and trailing whitespace from the templates
 trim = true
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = false
 
 [release]
 # Regex to select git tags that represent releases.
@@ -67,8 +69,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = false
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

examples/scopesorted.toml

@@ -43,6 +43,8 @@ footer_template = """
 """
 # remove the leading and trailing whitespace from the templates
 trim = true
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = false
 
 [release]
 # Regex to select git tags that represent releases.
@@ -80,8 +82,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = false
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

examples/unconventional.toml

@@ -27,6 +27,8 @@ footer_template = """
 """
 # remove the leading and trailing whitespace from the templates
 trim = true
+# Whether to exclude changes that do not belong to any group from the changelog.
+exclude_ungrouped_changes = false
 
 [release]
 # Regex to select git tags that represent releases.
@@ -65,8 +67,6 @@ commit_parsers = [
 ]
 # Whether to prevent breaking changes from being excluded by commit parsers.
 retain_breaking_changes = false
-# filter out the commits that are not matched by commit parsers
-filter_commits = false
 # Regex to select git tags that should be excluded from the changelog.
 exclude_tags_pattern = "v0.1.0-beta.1"
 # Whether to order commits newest to oldest or oldest to newest in their group.

git-cliff-core/src/changelog.rs

@@ -81,7 +81,7 @@ impl<'a> Changelog<'a> {
 						vec![commit]
 					}
 				})
-				.filter_map(|commit| match commit.process(&self.config.commit) {
+				.filter_map(|commit| match commit.process(&self.config.changelog, &self.config.commit) {
 					Ok(commit) => Some(commit),
 					Err(e) => {
 						trace!(
@@ -346,6 +346,7 @@ mod test {
 					replace:         Some(String::from("exciting")),
 					replace_command: None,
 				}]),
+        exclude_ungrouped_changes: Some(false),
 			},
 			release: ReleaseConfig {
 				tags_pattern: None,
@@ -477,7 +478,6 @@ mod test {
 					},
 				]),
 				retain_breaking_changes:  None,
-				filter_commits:           Some(false),
 				exclude_tags_pattern:     Regex::new("v3.*").ok(),
 				sort_order:               Some(String::from("oldest")),
 				link_parsers:             None,