-
-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(example): add example for generating changelog similar to cocogitto
- Loading branch information
Showing
2 changed files
with
192 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| # configuration file for git-cliff | ||
|
|
||
| [changelog] | ||
| # changelog header | ||
| header = """ | ||
| # Changelog\n | ||
| All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.\n | ||
| """ | ||
| # template for the changelog body | ||
| # https://tera.netlify.app/docs | ||
| body = """ | ||
| --- | ||
| {% if version %}\ | ||
| {% if previous.version %}\ | ||
| ## [{{ version | trim_start_matches(pat="v") }}]($REPO/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} | ||
| {% else %}\ | ||
| ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} | ||
| {% endif %}\ | ||
| {% else %}\ | ||
| ## [unreleased] | ||
| {% endif %}\ | ||
| {% for group, commits in commits | group_by(attribute="group") %} | ||
| ### {{ group | striptags | trim | upper_first }} | ||
| {% for commit in commits | ||
| | filter(attribute="scope") | ||
| | sort(attribute="scope") %} | ||
| - **({{commit.scope}})**{% if commit.breaking %} [**breaking**]{% endif %} \ | ||
| {{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }} | ||
| {%- endfor -%} | ||
| {% raw %}\n{% endraw %}\ | ||
| {%- for commit in commits %} | ||
| {%- if commit.scope -%} | ||
| {% else -%} | ||
| - {% if commit.breaking %} [**breaking**]{% endif %}\ | ||
| {{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }} | ||
| {% endif -%} | ||
| {% endfor -%} | ||
| {% endfor %}\n | ||
| """ | ||
| # remove the leading and trailing whitespace from the template | ||
| trim = true | ||
| # changelog footer | ||
| footer = """ | ||
| <!-- generated by git-cliff --> | ||
| """ | ||
| # postprocessors | ||
| postprocessors = [ | ||
| { pattern = '\$REPO', replace = "https://github.com/cocogitto/cocogitto" }, # replace repository URL | ||
| ] | ||
|
|
||
| [git] | ||
| # parse the commits based on https://www.conventionalcommits.org | ||
| conventional_commits = true | ||
| # filter out the commits that are not conventional | ||
| filter_unconventional = true | ||
| # process each line of a commit as an individual commit | ||
| split_commits = false | ||
| # regex for preprocessing the commit messages | ||
| commit_preprocessors = [ | ||
| # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers | ||
| ] | ||
| # regex for parsing and grouping commits | ||
| commit_parsers = [ | ||
| { message = "^feat", group = "Features" }, | ||
| { message = "^fix", group = "Bug Fixes" }, | ||
| { message = "^doc", group = "Documentation" }, | ||
| { message = "^perf", group = "Performance" }, | ||
| { message = "^refactor", group = "Refactoring" }, | ||
| { message = "^style", group = "Style" }, | ||
| { message = "^revert", group = "Revert" }, | ||
| { message = "^test", group = "Tests" }, | ||
| { message = "^chore\\(version\\):", skip = true }, | ||
| { 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 | ||
| # glob pattern 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters