Skip to content

Commit 384081d

Browse files
committed
docs(changelog): Enhance changelog template formatting
- Add commit hash links to changelog entries - Exclude '__snapshots__/' from version control - Modify changelog configuration to improve readability and formatting
1 parent 0f1c0a4 commit 384081d

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

.ai-commit.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
":!*-lock.json",
44
":!*.lock",
55
":!*.sum",
6-
":!/baselines/*.neon"
6+
":!/baselines/*.neon",
7+
":(exclude)__snapshots__/"
78
]
89
}

.chglog/CHANGELOG.tpl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ All notable changes to this project will be documented in this file.
1212
{{ range .Unreleased.CommitGroups -}}
1313
### {{ .Title }}
1414
{{ range .Commits -}}
15-
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
15+
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} ([{{ .Hash.Short }}]({{ $.Info.RepositoryURL }}/commit/{{ .Hash.Short }}))
1616
{{ end }}
1717
{{ end -}}
1818
{{ end -}}
@@ -24,7 +24,7 @@ All notable changes to this project will be documented in this file.
2424
{{ range .CommitGroups -}}
2525
### {{ .Title }}
2626
{{ range .Commits -}}
27-
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
27+
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} ([{{ .Hash.Short }}]({{ $.Info.RepositoryURL }}/commit/{{ .Hash.Short }}))
2828
{{ end }}
2929
{{ end -}}
3030

.chglog/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
style: github
2+
# https://github.com/garden-io/garden
3+
# https://github.com/git-chglog/git-chglog
4+
# https://github.com/quay/clair
25
template: CHANGELOG.tpl.md
36
info:
47
title: CHANGELOG

0 commit comments

Comments
 (0)