mirror of
https://github.com/orhun/git-cliff.git
synced 2024-09-11 06:55:38 +03:00
5238326790
See <https://git-cliff.org/docs/integration/github> Squashed history: * feat(github): support integration with GitHub repos * fix(changelog): fix generation logic * refactor(github): use verbose logging for errors * fix(test): update tests accordingly to the render parameters * feat(github): support deriving upstream URL from the repo * docs(lib): update the description of the error module * chore(github): add disclaimer for the github feature * chore(config): filter the contributors in the github example * fix(github): make GitHub login field optional * chore(github): increase the logging verbosity for remote info * refactor(git): reduce the log level for upstream remote * feat(github): log the request error * feat(args): add `--github-repo` argument * feat(github): add caching for network requests * feat(github): add progress bar for the network requests * refactor(github): gate the implementation behind github feature flag * fix(github): use the local cache for HTTP requests * feat(github): set TCP keepalive value for HTTP client * chore(cargo): create update-informer feature * docs(website): add documentation about available features * docs(website): reorder installation sections * fix(config): skip serializing secret * docs(website): add documentation about GitHub integration * chore(example): update the style of GitHub config * docs(website): add github example * test(fixture): add test fixture for GitHub integration * test(fixture): run the GitHub integration test * fix(changelog): print header before fetching GitHub * feat(github): allow using remote values without fetching GitHub * chore(example): simplify Keep a Changelog example * feat(example): add github-keepachangelog example * chore(example): update the examples in default config * chore(ci): test all features * test(github): add unit tests for GitHub integration * chore(ci): set upstream remote for tests * chore(ci): show the current git status for test step * chore(ci): skip git upstream test * chore(ci): run tests without default features * chore(ci): skip test with full name * docs(website): add note about github-keepachangelog format * chore(ci): skip the faulty git test for all test steps * refactor(error): update the error type for logger
79 lines
2.7 KiB
TOML
79 lines
2.7 KiB
TOML
# 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 -%}
|
|
{% for group, commits in commits | group_by(attribute="group") %}
|
|
### {{ group | upper_first }}
|
|
{% for commit in commits %}
|
|
- {{ commit.message | upper_first }}\
|
|
{% endfor %}
|
|
{% 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
|
|
# 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"
|