mirror of
https://github.com/axllent/mailpit.git
synced 2025-05-21 22:33:29 +02:00
Docs: Switch to git-cliff for changelog generation
This commit is contained in:
parent
cfe695c35d
commit
009f3a8fd9
@ -1,47 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
Notable changes to Mailpit will be documented in this file.
|
|
||||||
|
|
||||||
{{ if .Versions -}}
|
|
||||||
{{ if .Unreleased.CommitGroups -}}
|
|
||||||
## [Unreleased]
|
|
||||||
|
|
||||||
{{ if .Unreleased.CommitGroups -}}
|
|
||||||
{{ range .Unreleased.CommitGroups -}}
|
|
||||||
### {{ .Title }}
|
|
||||||
{{ range .Commits -}}
|
|
||||||
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
|
|
||||||
{{ end }}
|
|
||||||
{{ end }}
|
|
||||||
{{ end -}}
|
|
||||||
{{ end -}}
|
|
||||||
{{ end -}}
|
|
||||||
|
|
||||||
{{ range .Versions }}
|
|
||||||
{{- if .CommitGroups -}}
|
|
||||||
## [{{ .Tag.Name }}]
|
|
||||||
|
|
||||||
{{ if .NoteGroups -}}
|
|
||||||
{{ range .NoteGroups -}}
|
|
||||||
### {{ .Title }}
|
|
||||||
{{ range .Notes }}
|
|
||||||
{{ .Body }}
|
|
||||||
{{ end -}}
|
|
||||||
{{ end }}
|
|
||||||
{{ end -}}
|
|
||||||
{{ end -}}
|
|
||||||
|
|
||||||
{{ range .CommitGroups -}}
|
|
||||||
### {{ .Title }}
|
|
||||||
{{ range .Commits -}}
|
|
||||||
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
|
|
||||||
{{ end }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
{{- if .MergeCommits -}}
|
|
||||||
### Pull Requests
|
|
||||||
{{ range .MergeCommits -}}
|
|
||||||
- {{ .Header }}
|
|
||||||
{{ end }}
|
|
||||||
{{ end }}
|
|
||||||
{{ end -}}
|
|
@ -1,12 +0,0 @@
|
|||||||
{{ if .Versions -}}
|
|
||||||
{{ range .Versions }}
|
|
||||||
{{- if .CommitGroups -}}
|
|
||||||
{{ range .CommitGroups -}}
|
|
||||||
### {{ .Title }}
|
|
||||||
{{ range .Commits -}}
|
|
||||||
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
|
|
||||||
{{ end }}
|
|
||||||
{{ end -}}
|
|
||||||
{{ end -}}
|
|
||||||
{{ end -}}
|
|
||||||
{{ end -}}
|
|
@ -1,46 +0,0 @@
|
|||||||
style: github
|
|
||||||
template: CHANGELOG.tpl.md
|
|
||||||
info:
|
|
||||||
title: CHANGELOG
|
|
||||||
repository_url: https://github.com/axllent/mailpit
|
|
||||||
options:
|
|
||||||
commits:
|
|
||||||
# filters:
|
|
||||||
# Type:
|
|
||||||
# - feat
|
|
||||||
# - fix
|
|
||||||
# - perf
|
|
||||||
# - refactor
|
|
||||||
commit_groups:
|
|
||||||
title_maps:
|
|
||||||
feature: Feature
|
|
||||||
fix: Fix
|
|
||||||
# perf: Performance Improvements
|
|
||||||
# refactor: Code Refactoring
|
|
||||||
sort_by: Custom
|
|
||||||
title_order:
|
|
||||||
- Feature
|
|
||||||
- Chore
|
|
||||||
- UI
|
|
||||||
- API
|
|
||||||
- Libs
|
|
||||||
- Docker
|
|
||||||
- Security
|
|
||||||
- Fix
|
|
||||||
- Bugfix
|
|
||||||
- Docs
|
|
||||||
- Swagger
|
|
||||||
- Build
|
|
||||||
- Testing
|
|
||||||
- Test
|
|
||||||
- Tests
|
|
||||||
- Pull Requests
|
|
||||||
header:
|
|
||||||
pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$"
|
|
||||||
pattern_maps:
|
|
||||||
- Type
|
|
||||||
- Scope
|
|
||||||
- Subject
|
|
||||||
notes:
|
|
||||||
keywords:
|
|
||||||
- BREAKING CHANGE
|
|
48
.github/cliff.toml
vendored
Normal file
48
.github/cliff.toml
vendored
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
## https://git-cliff.org/
|
||||||
|
[changelog]
|
||||||
|
body = """
|
||||||
|
{% if version %}\
|
||||||
|
\n## [{{ version }}]
|
||||||
|
{% else %}\
|
||||||
|
\n## Unreleased
|
||||||
|
{% endif %}\
|
||||||
|
{% for group, commits in commits | group_by(attribute="group") %}
|
||||||
|
### {{ group | striptags | trim | upper_first }}\
|
||||||
|
{% for commit in commits %}
|
||||||
|
- {{ commit.message | upper_first }}\
|
||||||
|
{% endfor %}
|
||||||
|
{% endfor %}\n
|
||||||
|
"""
|
||||||
|
footer = ""
|
||||||
|
header = "# Changelog\n\nNotable changes to Mailpit will be documented in this file."
|
||||||
|
postprocessors = [
|
||||||
|
{pattern = "reponse", replace = "response"},
|
||||||
|
{pattern = "messsage", replace = "message"},
|
||||||
|
{pattern = '(?i) go modules', replace = " Go dependencies"},
|
||||||
|
{pattern = '(?i) node modules', replace = " node dependencies"},
|
||||||
|
{pattern = '#([0-9]+)', replace = "[#$1](https://github.com/axllent/mailpit/issues/$1)"},
|
||||||
|
]
|
||||||
|
trim = true
|
||||||
|
|
||||||
|
[git]
|
||||||
|
# HTML comments added for grouping order, stripped on generation
|
||||||
|
commit_parsers = [
|
||||||
|
{body = ".*security", group = "<!-- 1 -->Security"},
|
||||||
|
{message = "(?i)^feat", group = "<!-- 2 -->Feature"},
|
||||||
|
{message = "(?i)^chore", group = "<!-- 3 -->Chore"},
|
||||||
|
{message = "(?i)^libs", group = "<!-- 3 -->Chore"},
|
||||||
|
{message = "(?i)^ui", group = "<!-- 3 -->Chore"},
|
||||||
|
{message = "(?i)^api", group = "<!-- 4 -->API"},
|
||||||
|
{message = "(?i)^fix", group = "<!-- 5 -->Fix"},
|
||||||
|
{message = "(?i)^doc", group = "<!-- 6 -->Documentation", default_scope = "unscoped"},
|
||||||
|
{message = "(?i)^swagger", group = "<!-- 6 -->Documentation", default_scope = "unscoped"},
|
||||||
|
{message = "(?i)^test", group = "<!-- 7 -->Test"},
|
||||||
|
]
|
||||||
|
|
||||||
|
# Exclude commits that are not matched by any commit parser.
|
||||||
|
# filter_commits = true
|
||||||
|
# Order releases topologically instead of chronologically.
|
||||||
|
# topo_order = true
|
||||||
|
# Order of commits in each group/release within the changelog.
|
||||||
|
# Allowed values: newest, oldest
|
||||||
|
sort_commits = "oldest"
|
Loading…
x
Reference in New Issue
Block a user