Skip to content

Commit 0c46132

Browse files
committed
chore: Adding CHANGELOG
Signed-off-by: Michael Ethridge <michael.ethridge@cdw.com>
1 parent d9bb7c1 commit 0c46132

File tree

3 files changed

+74
-0
lines changed

3 files changed

+74
-0
lines changed

.chglog/CHANGELOG.tpl.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!-- markdownlint-disable -->
2+
{{ range .Versions }}
3+
<a name="{{ .Tag.Name }}"></a>
4+
## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }} ({{ datetime "2006-01-02" .Tag.Date }})
5+
6+
{{ range .CommitGroups -}}
7+
### {{ .Title }}
8+
9+
{{ range .Commits -}}
10+
* {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
11+
{{ end }}
12+
{{ end -}}
13+
14+
{{- if .RevertCommits -}}
15+
### Reverts
16+
17+
{{ range .RevertCommits -}}
18+
* {{ .Revert.Header }}
19+
{{ end }}
20+
{{ end -}}
21+
22+
{{- if .MergeCommits -}}
23+
### Pull Requests
24+
25+
{{ range .MergeCommits -}}
26+
* {{ .Header }}
27+
{{ end }}
28+
{{ end -}}
29+
30+
{{- if .NoteGroups -}}
31+
{{ range .NoteGroups -}}
32+
### {{ .Title }}
33+
34+
{{ range .Notes }}
35+
{{ .Body }}
36+
{{ end }}
37+
{{ end -}}
38+
{{ end -}}
39+
{{ end -}}

.chglog/config.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
style: github
2+
template: CHANGELOG.tpl.md
3+
info:
4+
title: CHANGELOG
5+
repository_url: https://github.com/404-code-not-found-com/terraform-module-template
6+
options:
7+
commits:
8+
# filters:
9+
# Type:
10+
# - feat
11+
# - fix
12+
# - perf
13+
# - refactor
14+
commit_groups:
15+
# title_maps:
16+
# feat: Features
17+
# fix: Bug Fixes
18+
# perf: Performance Improvements
19+
# refactor: Code Refactoring
20+
header:
21+
pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$"
22+
pattern_maps:
23+
- Type
24+
- Scope
25+
- Subject
26+
notes:
27+
keywords:
28+
- BREAKING CHANGE

Taskfile.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ tasks:
1818
cmds:
1919
- trufflehog git file://. --since-commit HEAD --only-verified --fail
2020

21+
log:
22+
cmds:
23+
- |
24+
git-chglog --next-tag v$(autotag -vn --scheme=conventional) -o CHANGELOG.md
25+
git add CHANGELOG.md
26+
git commit -m 'chore: update CHANGELOG.md'
27+
2128
pre:
2229
cmds:
2330
- pre-commit autoupdate

0 commit comments

Comments
 (0)