1
0
Fork 0
mirror of https://github.com/miawinter98/just-short-it.git synced 2024-11-10 03:59:53 +00:00

Added git-chglog for automatic changelogs

This commit is contained in:
Mia Rose Winter 2024-03-29 19:00:27 +01:00
parent 6055f11e22
commit 7bd7028e2e
Signed by: miawinter
GPG key ID: 4B6F6A83178F595E
2 changed files with 65 additions and 0 deletions

24
.chglog/CHANGELOG.tpl.md Normal file
View file

@ -0,0 +1,24 @@
{{ range .Versions }}
## {{ .Tag.Name }} ({{ datetime "2006-01-02" .Tag.Date }})
{{ range .CommitGroups -}}
### {{ .Title }}
{{- $title := .Title }}
{{ range .Commits -}}
* {{ (replace (upperFirst .Subject) $title "" 1) | trim | upperFirst }}
{{ end }}
{{ end -}}
{{- if .NoteGroups -}}
{{ range .NoteGroups -}}
### {{ .Title }}
{{ range .Notes }}
{{ .Body }}
{{ end }}
{{ end -}}
{{ end -}}
### [Unreleased](https://github.com/miawinter98/Wave/compare/{{ .Tag.Name }}...HEAD)
{{ end -}}

41
.chglog/config.yml Normal file
View file

@ -0,0 +1,41 @@
style: "github"
template: CHANGELOG.tpl.md
info:
title: CHANGELOG
repository_url: https://github.com/miawinter98/Wave
options:
tag_filter_pattern: '^v'
issues:
prefix:
- '#'
commits:
filters:
Type:
- Added
- Changed
- fixed
- Implemented
- Improved
- Removed
commit_groups:
sort_by: Custom
title_order:
- Added
- Implemented
- Improved
- Changed
- Removed
- fixed
# title_maps:
# feat: Features
# fix: Bug Fixes
# perf: Performance Improvements
# refactor: Code Refactoring
header:
pattern: "^((\\w+)\\s.*)$"
pattern_maps:
- Subject
- Type
notes:
keywords:
- BREAKING CHANGE