Skip to content

Commit 63129ce

Browse files
CyclonitCyclonit
authored
doc(config): update comments for all configuration options (#1057)
1 parent cd26bb2 commit 63129ce

File tree

52 files changed

+849
-509
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+849
-509
lines changed

‎.github/fixtures/new-fixture-template/cliff.toml

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
# git-cliff ~ configuration file
2+
# https://git-cliff.org/docs/configuration
3+
14
[changelog]
2-
# template for the changelog footer
5+
# A Tera template to be rendered as the changelog's header.
6+
# See https://keats.github.io/tera/docs/#introduction
37
header = """
48
# Changelog\n
59
All notable changes to this project will be documented in this file.\n
610
"""
7-
# template for the changelog body
8-
# https://keats.github.io/tera/docs/#introduction
11+
# A Tera template to be rendered for each release in the changelog.
12+
# See https://keats.github.io/tera/docs/#introduction
913
body = """
1014
{% if version %}\
1115
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
@@ -19,15 +23,18 @@ body = """
1923
{% endfor %}
2024
{% endfor %}\n
2125
"""
22-
# template for the changelog footer
26+
# A Tera template to be rendered as the changelog's footer.
27+
# See https://keats.github.io/tera/docs/#introduction
2328
footer = """
2429
<!-- generated by git-cliff -->
2530
"""
26-
# remove the leading and trailing whitespace from the templates
31+
# Remove leading and trailing whitespaces from the changelog's body.
2732
trim = true
2833

2934
[git]
30-
# regex for parsing and grouping commits
35+
# An array of regex based parsers for extracting data from the commit message.
36+
# Assigns commits to groups.
37+
# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.
3138
commit_parsers = [
3239
{ message = "^feat", group = "Features", default_scope = "app" },
3340
{ message = "^fix", group = "Bug Fixes", scope = "cli" },

‎.github/fixtures/test-bitbucket-integration/cliff.toml

+19-10
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1+
# git-cliff ~ configuration file
2+
# https://git-cliff.org/docs/configuration
3+
4+
# Bitbucket integration for fetching commit metadata.
15
[remote.bitbucket]
26
owner = "mcwarman-playground"
37
repo = "git-cliff-readme-example"
48

59
[changelog]
6-
# template for the changelog body
7-
# https://keats.github.io/tera/docs/#introduction
10+
# A Tera template to be rendered for each release in the changelog.
11+
# See https://keats.github.io/tera/docs/#introduction
812
body = """
913
{%- macro remote_url() -%}
1014
https://bitbucket.org/{{ remote.bitbucket.owner }}/{{ remote.bitbucket.repo }}
@@ -32,21 +36,26 @@ body = """
3236
{%- endfor -%}
3337
{% raw %}\n\n{% endraw -%}
3438
"""
35-
# remove the leading and trailing whitespace from the template
39+
# Remove leading and trailing whitespaces from the changelog's body.
3640
trim = true
37-
# changelog footer
41+
# A Tera template to be rendered as the changelog's footer.
42+
# See https://keats.github.io/tera/docs/#introduction
3843
footer = """
3944
<!-- generated by -cliff -->
4045
"""
4146

4247
[git]
43-
# parse the commits based on https://www.conventionalcommits.org
48+
# Parse commits according to the conventional commits specification.
49+
# See https://www.conventionalcommits.org
4450
conventional_commits = false
45-
# filter out the commits that are not conventional
51+
# Exclude commits that do not match the conventional commits specification.
4652
filter_unconventional = true
47-
# process each line of a commit as an individual commit
53+
# Split commits on newlines, treating each line as an individual commit.
4854
split_commits = false
49-
# regex for preprocessing the commit messages
50-
commit_preprocessors = [{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" }]
51-
# protect breaking changes from being skipped due to matching a skipping commit_parser
55+
# An array of regex based parsers to modify commit messages prior to further processing.
56+
commit_preprocessors = [
57+
# Remove issue numbers.
58+
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
59+
]
60+
# Prevent commits that are breaking from being excluded by commit parsers.
5261
protect_breaking_commits = false

‎.github/fixtures/test-bump-initial-tag-cli-arg/cliff.toml

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
# git-cliff ~ configuration file
2+
# https://git-cliff.org/docs/configuration
3+
14
[changelog]
2-
# template for the changelog footer
5+
# A Tera template to be rendered as the changelog's header.
6+
# See https://keats.github.io/tera/docs/#introduction
37
header = """
48
# Changelog\n
59
All notable changes to this project will be documented in this file.\n
610
"""
7-
# template for the changelog body
8-
# https://keats.github.io/tera/docs/#introduction
11+
# A Tera template to be rendered for each release in the changelog.
12+
# See https://keats.github.io/tera/docs/#introduction
913
body = """
1014
{% if version %}\
1115
## [{{ version | trim_start_matches(pat="v") }}]
@@ -19,15 +23,18 @@ body = """
1923
{% endfor %}
2024
{% endfor %}\n
2125
"""
22-
# template for the changelog footer
26+
# A Tera template to be rendered as the changelog's footer.
27+
# See https://keats.github.io/tera/docs/#introduction
2328
footer = """
2429
<!-- generated by git-cliff -->
2530
"""
26-
# remove the leading and trailing whitespace from the templates
31+
# Remove leading and trailing whitespaces from the changelog's body.
2732
trim = true
2833

2934
[git]
30-
# regex for parsing and grouping commits
35+
# An array of regex based parsers for extracting data from the commit message.
36+
# Assigns commits to groups.
37+
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
3138
commit_parsers = [
3239
{ message = "^feat", group = "Features", default_scope = "app" },
3340
{ message = "^fix", group = "Bug Fixes", scope = "cli" },

‎.github/fixtures/test-bump-initial-tag-default/cliff.toml

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
# git-cliff ~ configuration file
2+
# https://git-cliff.org/docs/configuration
3+
14
[changelog]
2-
# template for the changelog footer
5+
# A Tera template to be rendered as the changelog's header.
6+
# See https://keats.github.io/tera/docs/#introduction
37
header = """
48
# Changelog\n
59
All notable changes to this project will be documented in this file.\n
610
"""
7-
# template for the changelog body
8-
# https://keats.github.io/tera/docs/#introduction
11+
# A Tera template to be rendered for each release in the changelog.
12+
# See https://keats.github.io/tera/docs/#introduction
913
body = """
1014
{% if version %}\
1115
## [{{ version | trim_start_matches(pat="v") }}]
@@ -19,15 +23,18 @@ body = """
1923
{% endfor %}
2024
{% endfor %}\n
2125
"""
22-
# template for the changelog footer
26+
# A Tera template to be rendered as the changelog's footer.
27+
# See https://keats.github.io/tera/docs/#introduction
2328
footer = """
2429
<!-- generated by git-cliff -->
2530
"""
26-
# remove the leading and trailing whitespace from the templates
31+
# Remove leading and trailing whitespaces from the changelog's body.
2732
trim = true
2833

2934
[git]
30-
# regex for parsing and grouping commits
35+
# An array of regex based parsers for extracting data from the commit message.
36+
# Assigns commits to groups.
37+
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
3138
commit_parsers = [
3239
{ message = "^feat", group = "Features", default_scope = "app" },
3340
{ message = "^fix", group = "Bug Fixes", scope = "cli" },

‎.github/fixtures/test-bump-initial-tag/cliff.toml

+14-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
# git-cliff ~ configuration file
2+
# https://git-cliff.org/docs/configuration
3+
14
[changelog]
2-
# template for the changelog footer
5+
# A Tera template to be rendered as the changelog's header.
6+
# See https://keats.github.io/tera/docs/#introduction
37
header = """
48
# Changelog\n
59
All notable changes to this project will be documented in this file.\n
610
"""
7-
# template for the changelog body
8-
# https://keats.github.io/tera/docs/#introduction
11+
# A Tera template to be rendered for each release in the changelog.
12+
# See https://keats.github.io/tera/docs/#introduction
913
body = """
1014
{% if version %}\
1115
## [{{ version | trim_start_matches(pat="v") }}]
@@ -19,19 +23,22 @@ body = """
1923
{% endfor %}
2024
{% endfor %}\n
2125
"""
22-
# template for the changelog footer
26+
# A Tera template to be rendered as the changelog's footer.
27+
# See https://keats.github.io/tera/docs/#introduction
2328
footer = """
2429
<!-- generated by git-cliff -->
2530
"""
26-
# remove the leading and trailing whitespace from the templates
31+
# Remove leading and trailing whitespaces from the changelog's body.
2732
trim = true
2833

2934
[git]
30-
# regex for parsing and grouping commits
35+
# An array of regex based parsers for extracting data from the commit message.
36+
# Assigns commits to groups.
37+
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
3138
commit_parsers = [
3239
{ message = "^feat", group = "Features", default_scope = "app" },
3340
{ message = "^fix", group = "Bug Fixes", scope = "cli" },
3441
]
3542

3643
[bump]
37-
initial_tag = "1.15.5"
44+
initial_tag = "1.15.5"

‎.github/fixtures/test-bump-version-keep-zerover/cliff.toml

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
# git-cliff ~ configuration file
2+
# https://git-cliff.org/docs/configuration
3+
14
[changelog]
2-
# template for the changelog footer
5+
# A Tera template to be rendered as the changelog's header.
6+
# See https://keats.github.io/tera/docs/#introduction
37
header = """
48
# Changelog\n
59
All notable changes to this project will be documented in this file.\n
610
"""
7-
# template for the changelog body
8-
# https://keats.github.io/tera/docs/#introduction
11+
# A Tera template to be rendered for each release in the changelog.
12+
# See https://keats.github.io/tera/docs/#introduction
913
body = """
1014
{% if version %}\
1115
## [{{ version | trim_start_matches(pat="v") }}]
@@ -19,11 +23,12 @@ body = """
1923
{% endfor %}
2024
{% endfor %}\n
2125
"""
22-
# template for the changelog footer
26+
# A Tera template to be rendered as the changelog's footer.
27+
# See https://keats.github.io/tera/docs/#introduction
2328
footer = """
2429
<!-- generated by git-cliff -->
2530
"""
26-
# remove the leading and trailing whitespace from the templates
31+
# Remove leading and trailing whitespaces from the changelog's body.
2732
trim = true
2833

2934
[bump]

‎.github/fixtures/test-bump-version/cliff.toml

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
# git-cliff ~ configuration file
2+
# https://git-cliff.org/docs/configuration
3+
14
[changelog]
2-
# template for the changelog footer
5+
# A Tera template to be rendered as the changelog's header.
6+
# See https://keats.github.io/tera/docs/#introduction
37
header = """
48
# Changelog\n
59
All notable changes to this project will be documented in this file.\n
610
"""
7-
# template for the changelog body
8-
# https://keats.github.io/tera/docs/#introduction
11+
# A Tera template to be rendered for each release in the changelog.
12+
# See https://keats.github.io/tera/docs/#introduction
913
body = """
1014
{% if version %}\
1115
## [{{ version | trim_start_matches(pat="v") }}]
@@ -19,9 +23,10 @@ body = """
1923
{% endfor %}
2024
{% endfor %}\n
2125
"""
22-
# template for the changelog footer
26+
# A Tera template to be rendered as the changelog's footer.
27+
# See https://keats.github.io/tera/docs/#introduction
2328
footer = """
2429
<!-- generated by git-cliff -->
2530
"""
26-
# remove the leading and trailing whitespace from the templates
31+
# Remove leading and trailing whitespaces from the changelog's body.
2732
trim = true

‎.github/fixtures/test-bumped-version/cliff.toml

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
# git-cliff ~ configuration file
2+
# https://git-cliff.org/docs/configuration
3+
14
[changelog]
2-
# template for the changelog footer
5+
# A Tera template to be rendered as the changelog's header.
6+
# See https://keats.github.io/tera/docs/#introduction
37
header = """
48
# Changelog\n
59
All notable changes to this project will be documented in this file.\n
610
"""
7-
# template for the changelog body
8-
# https://keats.github.io/tera/docs/#introduction
11+
# A Tera template to be rendered for each release in the changelog.
12+
# See https://keats.github.io/tera/docs/#introduction
913
body = """
1014
{% if version %}\
1115
## [{{ version | trim_start_matches(pat="v") }}]
@@ -19,9 +23,10 @@ body = """
1923
{% endfor %}
2024
{% endfor %}\n
2125
"""
22-
# template for the changelog footer
26+
# A Tera template to be rendered as the changelog's footer.
27+
# See https://keats.github.io/tera/docs/#introduction
2328
footer = """
2429
<!-- generated by git-cliff -->
2530
"""
26-
# remove the leading and trailing whitespace from the templates
31+
# Remove leading and trailing whitespaces from the changelog's body.
2732
trim = true

‎.github/fixtures/test-commit-footers/cliff.toml

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
# git-cliff ~ configuration file
2+
# https://git-cliff.org/docs/configuration
3+
14
[changelog]
2-
# template for the changelog footer
5+
# A Tera template to be rendered as the changelog's header.
6+
# See https://keats.github.io/tera/docs/#introduction
37
header = """
48
# Changelog\n
59
All notable changes to this project will be documented in this file.\n
610
"""
7-
# template for the changelog body
8-
# https://keats.github.io/tera/docs/#introduction
11+
# A Tera template to be rendered for each release in the changelog.
12+
# See https://keats.github.io/tera/docs/#introduction
913
body = """
1014
{% if version %}\
1115
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
@@ -22,9 +26,10 @@ body = """
2226
{% endfor %}
2327
{% endfor %}\n
2428
"""
25-
# template for the changelog footer
29+
# A Tera template to be rendered as the changelog's footer.
30+
# See https://keats.github.io/tera/docs/#introduction
2631
footer = """
2732
<!-- generated by git-cliff -->
2833
"""
29-
# remove the leading and trailing whitespace from the templates
34+
# Remove leading and trailing whitespaces from the changelog's body.
3035
trim = true

‎.github/fixtures/test-commit-preprocessors/cliff.toml

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1+
# git-cliff ~ configuration file
2+
# https://git-cliff.org/docs/configuration
3+
14
[changelog]
2-
# template for the changelog footer
5+
# A Tera template to be rendered as the changelog's header.
6+
# See https://keats.github.io/tera/docs/#introduction
37
header = """
48
# Changelog\n
59
All notable changes to this project will be documented in this file.\n
610
"""
7-
# template for the changelog body
8-
# https://keats.github.io/tera/docs/#introduction
11+
# A Tera template to be rendered for each release in the changelog.
12+
# See https://keats.github.io/tera/docs/#introduction
913
body = """
1014
{% if version %}\
1115
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
@@ -19,16 +23,19 @@ body = """
1923
{% endfor %}
2024
{% endfor %}\n
2125
"""
22-
# template for the changelog footer
26+
# A Tera template to be rendered as the changelog's footer.
27+
# See https://keats.github.io/tera/docs/#introduction
2328
footer = """
2429
<!-- generated by git-cliff -->
2530
"""
26-
# remove the leading and trailing whitespace from the templates
31+
# Remove leading and trailing whitespaces from the changelog's body.
2732
trim = true
2833

2934
[git]
30-
# regex for preprocessing the commit messages
35+
# An array of regex based parsers to modify commit messages prior to further processing.
3136
commit_preprocessors = [
37+
# Replace issue numbers with links to the issue.
3238
{ pattern = '\(#([0-9]+)\)', replace = "([issue#${1}](https://github.com/orhun/git-cliff/issues/${1}))" },
39+
# Trim multiple spaces.
3340
{ pattern = " +", replace = " " },
3441
]

0 commit comments

Comments
 (0)