-
-
Notifications
You must be signed in to change notification settings - Fork 208
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(example): add github-keepachangelog example
- Loading branch information
Showing
4 changed files
with
195 additions
and
11 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,92 @@ | ||
| # git-cliff ~ configuration file | ||
| # https://git-cliff.org/docs/configuration | ||
|
|
||
| [changelog] | ||
| # changelog header | ||
| header = """ | ||
| # Changelog\n | ||
| All notable changes to this project will be documented in this file. | ||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n | ||
| """ | ||
| # template for the changelog body | ||
| # https://keats.github.io/tera/docs/#introduction | ||
| body = """ | ||
| {% if version -%} | ||
| ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} | ||
| {% else -%} | ||
| ## [Unreleased] | ||
| {% endif -%} | ||
| ### Details\ | ||
| {% for group, commits in commits | group_by(attribute="group") %} | ||
| #### {{ group | upper_first }} | ||
| {%- for commit in commits %} | ||
| - {{ commit.message | upper_first | trim }}\ | ||
| {% if commit.github.username %} by @{{ commit.github.username }}{%- endif -%} | ||
| {% if commit.github.pr_number %} in #{{ commit.github.pr_number }}{%- endif -%} | ||
| {% endfor %} | ||
| {% endfor %} | ||
| {%- if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} | ||
| ## New Contributors | ||
| {%- endif -%} | ||
| {% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} | ||
| * @{{ contributor.username }} made their first contribution in #{{ contributor.pr_number }}\ | ||
| {%- endfor %}\n | ||
| """ | ||
| # template for the changelog footer | ||
| footer = """ | ||
| {% for release in releases -%} | ||
| {% if release.version -%} | ||
| {% if release.previous.version -%} | ||
| [{{ release.version | trim_start_matches(pat="v") }}]: \ | ||
| https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\ | ||
| /compare/{{ release.previous.version }}..{{ release.version }} | ||
| {% endif -%} | ||
| {% else -%} | ||
| [unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\ | ||
| /compare/{{ release.previous.version }}..HEAD | ||
| {% endif -%} | ||
| {% endfor %} | ||
| <!-- generated by git-cliff --> | ||
| """ | ||
| # remove the leading and trailing whitespace from the templates | ||
| trim = true | ||
|
|
||
| [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 | ||
| commit_preprocessors = [{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" }] | ||
| # regex for parsing and grouping commits | ||
| commit_parsers = [ | ||
| { message = "^.*: add", group = "Added" }, | ||
| { message = "^.*: support", group = "Added" }, | ||
| { message = "^.*: remove", group = "Removed" }, | ||
| { message = "^.*: delete", group = "Removed" }, | ||
| { message = "^test", group = "Fixed" }, | ||
| { message = "^fix", group = "Fixed" }, | ||
| { 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 | ||
| sort_commits = "oldest" |
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
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
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