Skip to content

Commit 0e129c3

Browse files
committed
feat: automate pre-generation of Changelog
1 parent bfb67e7 commit 0e129c3

File tree

4 files changed

+91
-0
lines changed

4 files changed

+91
-0
lines changed

Diff for: .chglog/CHANGELOG.tpl.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
{{ if .Versions -}}
2+
<a name="unreleased"></a>
3+
## [Unreleased]
4+
5+
{{ if .Unreleased.CommitGroups -}}
6+
{{ range .Unreleased.CommitGroups -}}
7+
### {{ .Title }}
8+
{{ range .Commits -}}
9+
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
10+
{{ end }}
11+
{{ end -}}
12+
{{ end -}}
13+
{{ end -}}
14+
15+
{{ range .Versions }}
16+
<a name="{{ .Tag.Name }}"></a>
17+
## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
18+
{{ range .CommitGroups -}}
19+
### {{ .Title }}
20+
{{ range .Commits -}}
21+
- {{ if .Scope }}**{{ upperFirst .Scope }}:** {{ end }}{{ .Subject }}
22+
{{ end }}
23+
{{ end -}}
24+
25+
{{- if .RevertCommits -}}
26+
### Reverts
27+
{{ range .RevertCommits -}}
28+
- {{ .Revert.Header }}
29+
{{ end }}
30+
{{ end -}}
31+
32+
{{- if .MergeCommits -}}
33+
### Pull Requests
34+
{{ range .MergeCommits -}}
35+
- {{ .Header }}
36+
{{ end }}
37+
{{ end -}}
38+
39+
{{- if .NoteGroups -}}
40+
{{ range .NoteGroups -}}
41+
### {{ .Title }}
42+
{{ range .Notes }}
43+
{{ .Body }}
44+
{{ end }}
45+
{{ end -}}
46+
{{ end -}}
47+
{{ end -}}
48+
49+
{{- if .Versions }}
50+
[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD
51+
{{ range .Versions -}}
52+
{{ if .Tag.Previous -}}
53+
[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
54+
{{ end -}}
55+
{{ end -}}
56+
{{ end -}}

Diff for: .chglog/config.yml

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

Diff for: .gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,7 @@ test_report
295295
wheelhouse
296296
/.idea/*
297297
*.html
298+
TMP_CHANGELOG.md
298299

299300
# Docs files
300301
docs/.cache/

Diff for: Makefile

+4
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,7 @@ release: pr
7979
poetry build
8080
$(MAKE) release-test
8181
$(MAKE) release-prod
82+
83+
changelog:
84+
@echo "[+] Pre-generating CHANGELOG for tag: $$(git describe --abbrev=0 --tag)"
85+
docker run -v ${PWD}:/workdir quay.io/git-chglog/git-chglog $$(git describe --abbrev=0 --tag).. -o TMP_CHANGELOG.md

0 commit comments

Comments
 (0)