refactor(config): make example templates more user-friendly

Author: orhun

config/cliff.toml

@@ -71,19 +71,9 @@ commit_parsers = [
   { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
   { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
 ]
-# protect breaking changes from being skipped due to matching a skipping commit_parser
-protect_breaking_commits = false
 # filter out the commits that are not matched by commit parsers
 filter_commits = false
-# regex for matching git tags
-# tag_pattern = "v[0-9].*"
-# regex for skipping tags
-# skip_tags = ""
-# regex for ignoring tags
-# ignore_tags = ""
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order
 sort_commits = "oldest"
-# limit the number of commits included in the changelog.
-# limit_commits = 42

examples/cocogitto.toml

@@ -74,19 +74,9 @@ commit_parsers = [
     { message = "^chore", group = "Miscellaneous Chores" },
     { body = ".*security", group = "Security" },
 ]
-# protect breaking changes from being skipped due to matching a skipping commit_parser
-protect_breaking_commits = false
 # filter out the commits that are not matched by commit parsers
 filter_commits = false
-# regex for matching git tags
-tag_pattern = "v[0-9].*"
-# regex for skipping tags
-skip_tags = "v0.1.0-beta.1"
-# regex for ignoring tags
-ignore_tags = ""
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order
 sort_commits = "oldest"
-# limit the number of commits included in the changelog.
-# limit_commits = 42

examples/detailed.toml

@@ -61,16 +61,8 @@ commit_parsers = [
     { message = "^chore|^ci", group = "Miscellaneous Tasks" },
     { body = ".*security", group = "Security" },
 ]
-# protect breaking changes from being skipped due to matching a skipping commit_parser
-protect_breaking_commits = false
 # filter out the commits that are not matched by commit parsers
 filter_commits = false
-# regex for matching git tags
-tag_pattern = "v[0-9].*"
-# regex for skipping tags
-skip_tags = "v0.1.0-beta.1"
-# regex for ignoring tags
-ignore_tags = ""
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order

examples/github-keepachangelog.toml

@@ -91,16 +91,8 @@ commit_parsers = [
     { message = "^.*: fix", group = "Fixed" },
     { message = "^.*", group = "Changed" },
 ]
-# protect breaking changes from being skipped due to matching a skipping commit_parser
-protect_breaking_commits = false
 # filter out the commits that are not matched by commit parsers
 filter_commits = true
-# regex for matching git tags
-tag_pattern = "v[0-9].*"
-# regex for skipping tags
-skip_tags = "v0.1.0-beta.1"
-# regex for ignoring tags
-ignore_tags = ""
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order

examples/github.toml

@@ -72,16 +72,8 @@ commit_preprocessors = [
   # remove issue numbers from commits
   { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
 ]
-# protect breaking changes from being skipped due to matching a skipping commit_parser
-protect_breaking_commits = false
 # filter out the commits that are not matched by commit parsers
 filter_commits = false
-# regex for matching git tags
-tag_pattern = "v[0-9].*"
-# regex for skipping tags
-skip_tags = "beta|alpha"
-# regex for ignoring tags
-ignore_tags = "rc"
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order

examples/keepachangelog.toml

@@ -62,16 +62,8 @@ commit_parsers = [
   { message = "^.*: fix", group = "Fixed" },
   { message = "^.*", group = "Changed" },
 ]
-# protect breaking changes from being skipped due to matching a skipping commit_parser
-protect_breaking_commits = false
 # filter out the commits that are not matched by commit parsers
 filter_commits = true
-# regex for matching git tags
-tag_pattern = "v[0-9].*"
-# regex for skipping tags
-skip_tags = "v0.1.0-beta.1"
-# regex for ignoring tags
-ignore_tags = ""
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order

examples/scoped.toml

@@ -52,16 +52,8 @@ commit_parsers = [
     { message = "^chore", group = "Miscellaneous Tasks" },
     { body = ".*security", group = "Security" },
 ]
-# protect breaking changes from being skipped due to matching a skipping commit_parser
-protect_breaking_commits = false
 # filter out the commits that are not matched by commit parsers
 filter_commits = false
-# regex for matching git tags
-tag_pattern = "v[0-9].*"
-# regex for skipping tags
-skip_tags = "v0.1.0-beta.1"
-# regex for ignoring tags
-ignore_tags = ""
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order

examples/scopesorted.toml

@@ -66,16 +66,8 @@ commit_parsers = [
     { message = "^chore", group = "Miscellaneous Tasks" },
     { body = ".*security", group = "Security" },
 ]
-# protect breaking changes from being skipped due to matching a skipping commit_parser
-protect_breaking_commits = false
 # filter out the commits that are not matched by commit parsers
 filter_commits = false
-# regex for matching git tags
-tag_pattern = "v[0-9].*"
-# regex for skipping tags
-skip_tags = "v0.1.0-beta.1"
-# regex for ignoring tags
-ignore_tags = ""
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order

examples/unconventional.toml

@@ -18,7 +18,7 @@ body = """
 {% for group, commits in commits | group_by(attribute="group") %}
     ### {{ group | upper_first }}
     {% for commit in commits %}
-        - {{ commit.message | upper_first | trim_end }} {% if commit.conventional %}✔️{% else %}❌{% endif %}\
+        - {{ commit.message | split(pat="\n") | first | trim_end }}\
     {% endfor %}
 {% endfor %}\n
 """
@@ -32,7 +32,7 @@ trim = true
 
 [git]
 # parse the commits based on https://www.conventionalcommits.org
-conventional_commits = true
+conventional_commits = false
 # filter out the commits that are not conventional
 filter_unconventional = false
 # process each line of a commit as an individual commit
@@ -51,16 +51,8 @@ commit_parsers = [
     { body = ".*security", group = "Security" },
     { body = ".*", group = "Other (unconventional)" },
 ]
-# protect breaking changes from being skipped due to matching a skipping commit_parser
-protect_breaking_commits = false
 # filter out the commits that are not matched by commit parsers
 filter_commits = false
-# regex for matching git tags
-tag_pattern = "v[0-9].*"
-# regex for skipping tags
-skip_tags = "v0.1.0-beta.1"
-# regex for ignoring tags
-ignore_tags = ""
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order

website/docs/templating/examples.md

@@ -854,37 +854,37 @@ All notable changes to this project will be documented in this file.
 
 ### Features
 
-- Support multiple file formats ✔️
-- Use cache while fetching pages ✔️
+- feat(config): support multiple file formats
+- feat(cache): use cache while fetching pages
 
 ## [1.0.1] - 2021-07-18
 
 ### Miscellaneous Tasks
 
-- Add release script ✔️
+- chore(release): add release script
 
 ### Refactor
 
-- Expose string functions ✔️
+- refactor(parser): expose string functions
 
 ## [1.0.0] - 2021-07-18
 
 ### Bug Fixes
 
-- Rename help argument due to conflict ✔️
+- fix(args): rename help argument due to conflict
 
 ### Documentation
 
-- Add README.md ✔️
-- Add tested usage example ✔️
+- docs(project): add README.md
+- docs(example)!: add tested usage example
 
 ### Features
 
-- Add ability to parse arrays ✔️
+- feat(parser): add ability to parse arrays
 
 ### Other (unconventional)
 
-- Initial commit ❌
+- Initial commit
 
 <!-- generated by git-cliff -->
 ```
@@ -902,37 +902,37 @@ All notable changes to this project will be documented in this file.
 
 ### Features
 
-- Support multiple file formats ✔️
-- Use cache while fetching pages ✔️
+- feat(config): support multiple file formats
+- feat(cache): use cache while fetching pages
 
 ## [1.0.1] - 2021-07-18
 
 ### Miscellaneous Tasks
 
-- Add release script ✔️
+- chore(release): add release script
 
 ### Refactor
 
-- Expose string functions ✔️
+- refactor(parser): expose string functions
 
 ## [1.0.0] - 2021-07-18
 
 ### Bug Fixes
 
-- Rename help argument due to conflict ✔️
+- fix(args): rename help argument due to conflict
 
 ### Documentation
 
-- Add README.md ✔️
-- Add tested usage example ✔️
+- docs(project): add README.md
+- docs(example)!: add tested usage example
 
 ### Features
 
-- Add ability to parse arrays ✔️
+- feat(parser): add ability to parse arrays
 
 ### Other (unconventional)
 
-- Initial commit ❌
+- Initial commit
 
 <!-- generated by git-cliff -->