chore: remove initial tag from configuration

Remove the initial_tag entry from the configuration settings 
to streamline the setup process. Comment out some unnecessary 
lines in the postprocessors and commit_preprocessors sections 
for improved readability and focus on the relevant options. 
These changes aim to simplify the configuration and maintain 
clarity in the file structure.
This commit is contained in:
2025-10-21 15:29:01 +02:00
parent 52ba3460dc
commit ddadf63cab
+17 -24
View File
@@ -5,9 +5,6 @@
# Configuration options are organized into tables and keys. # Configuration options are organized into tables and keys.
# See documentation for more information on available options. # See documentation for more information on available options.
[bump]
initial_tag = "v0.0.1"
[changelog] [changelog]
# template for the changelog header # template for the changelog header
header = """ header = """
@@ -39,7 +36,7 @@ footer = """
trim = true trim = true
# postprocessors # postprocessors
postprocessors = [ postprocessors = [
# { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
] ]
# render body even when there are no releases to process # render body even when there are no releases to process
# render_always = true # render_always = true
@@ -55,28 +52,25 @@ filter_unconventional = true
split_commits = false split_commits = false
# regex for preprocessing the commit messages # regex for preprocessing the commit messages
commit_preprocessors = [ commit_preprocessors = [
# Replace issue numbers # Replace issue numbers
#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
# Check spelling of the commit with https://github.com/crate-ci/typos # Check spelling of the commit with https://github.com/crate-ci/typos
# If the spelling is incorrect, it will be automatically fixed. # If the spelling is incorrect, it will be automatically fixed.
#{ pattern = '.*', replace_command = 'typos --write-changes -' }, #{ pattern = '.*', replace_command = 'typos --write-changes -' },
] ]
# regex for parsing and grouping commits # regex for parsing and grouping commits
commit_parsers = [ commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->🚀 Features" }, { message = "^feat", group = "<!-- 0 -->🚀 Features" },
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" }, { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" }, { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" }, { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" }, { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
{ message = "^style", group = "<!-- 5 -->🎨 Styling" }, { message = "^style", group = "<!-- 5 -->🎨 Styling" },
{ message = "^test", group = "<!-- 6 -->🧪 Testing" }, { message = "^test", group = "<!-- 6 -->🧪 Testing" },
{ message = "^chore\\(release\\): prepare for", skip = true }, { message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore\\(deps.*\\)", skip = true }, { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
{ message = "^chore\\(pr\\)", skip = true }, { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
{ message = "^chore\\(pull\\)", skip = true }, { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
{ message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
{ body = ".*security", group = "<!-- 8 -->🛡️ Security" },
{ message = "^revert", group = "<!-- 9 -->◀️ Revert" },
] ]
# filter out the commits that are not matched by commit parsers # filter out the commits that are not matched by commit parsers
filter_commits = false filter_commits = false
@@ -84,4 +78,3 @@ filter_commits = false
topo_order = false topo_order = false
# sort the commits inside sections by oldest/newest order # sort the commits inside sections by oldest/newest order
sort_commits = "oldest" sort_commits = "oldest"
tag_pattern = "v[0-9]+\\.[0-9]+\\.[0-9]+"