From 7bd7028e2e81942f9b0eaa936d883a339a4319d5 Mon Sep 17 00:00:00 2001 From: Mia Winter Date: Fri, 29 Mar 2024 19:00:27 +0100 Subject: [PATCH] Added git-chglog for automatic changelogs --- .chglog/CHANGELOG.tpl.md | 24 +++++++++++++++++++++++ .chglog/config.yml | 41 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+) create mode 100644 .chglog/CHANGELOG.tpl.md create mode 100644 .chglog/config.yml diff --git a/.chglog/CHANGELOG.tpl.md b/.chglog/CHANGELOG.tpl.md new file mode 100644 index 0000000..f02e1fe --- /dev/null +++ b/.chglog/CHANGELOG.tpl.md @@ -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 -}} diff --git a/.chglog/config.yml b/.chglog/config.yml new file mode 100644 index 0000000..84bb302 --- /dev/null +++ b/.chglog/config.yml @@ -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 \ No newline at end of file