THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Browse Source

docs: Update changelog template

Changes the git-chglog template to Keep a Changelog
pull/5/head
Brett Bender 3 months ago
parent
commit
32d93edae4
Signed by: apoll <brett@brettb.xyz> GPG Key ID: 1D8324D8F593696E
3 changed files with 55 additions and 13 deletions
  1. +26
    -9
      .chglog/CHANGELOG.tpl.md
  2. +1
    -2
      .chglog/config.yml
  3. +28
    -2
      CHANGELOG.md

+ 26
- 9
.chglog/CHANGELOG.tpl.md View File

@ -1,32 +1,49 @@
{{ range .Versions }}
<a name="{{ .Tag.Name }}"></a>
## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }}
{{ if .Versions -}}
<a name="unreleased"></a>
## [Unreleased]
> {{ datetime "2006-01-02" .Tag.Date }}
{{ if .Unreleased.CommitGroups -}}
{{ range .Unreleased.CommitGroups -}}
### {{ .Title }}
{{ range .Commits -}}
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
{{ end }}
{{ end -}}
{{ end -}}
{{ end -}}
{{ range .Versions }}
<a name="{{ .Tag.Name }}"></a>
## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
{{ range .CommitGroups -}}
### {{ .Title }}
{{ range .Commits -}}
* {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
{{ end }}
{{ end -}}
{{- if .RevertCommits -}}
### Reverts
{{ range .RevertCommits -}}
* {{ .Revert.Header }}
- {{ .Revert.Header }}
{{ end }}
{{ end -}}
{{- if .NoteGroups -}}
{{ range .NoteGroups -}}
### {{ .Title }}
{{ range .Notes }}
{{ .Body }}
{{ end }}
{{ end -}}
{{ end -}}
{{ end -}}
{{- if .Versions }}
[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD
{{ range .Versions -}}
{{ if .Tag.Previous -}}
[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
{{ end -}}
{{ end -}}
{{ end -}}

+ 1
- 2
.chglog/config.yml View File

@ -18,10 +18,9 @@ options:
# perf: Performance Improvements
# refactor: Code Refactoring
header:
pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$"
pattern: "^(\\w*)\\:\\s(.*)$"
pattern_maps:
- Type
- Scope
- Subject
notes:
keywords:

+ 28
- 2
CHANGELOG.md View File

@ -1,6 +1,32 @@
<a name="unreleased"></a>
## [Unreleased]
### Docs
- Update changelog template
- Add changelog
<a name="v1.0.0"></a>
## [v1.0.0](https://github.com/GreatGodApollo/qsr/compare/v0.9.0...v1.0.0)
## [v1.0.0] - 2020-04-01
<a name="v0.9.0"></a>
## [v0.9.0] - 2020-04-01
<a name="v0.8.0"></a>
## [v0.8.0] - 2020-04-01
<a name="v0.7.0"></a>
## [v0.7.0] - 2020-04-01
<a name="v0.6"></a>
## [v0.6] - 2020-03-22
> 2020-04-01
<a name="v0.5"></a>
## v0.5 - 2020-03-22
[Unreleased]: https://github.com/GreatGodApollo/qsr/compare/v1.0.0...HEAD
[v1.0.0]: https://github.com/GreatGodApollo/qsr/compare/v0.9.0...v1.0.0
[v0.9.0]: https://github.com/GreatGodApollo/qsr/compare/v0.8.0...v0.9.0
[v0.8.0]: https://github.com/GreatGodApollo/qsr/compare/v0.7.0...v0.8.0
[v0.7.0]: https://github.com/GreatGodApollo/qsr/compare/v0.6...v0.7.0
[v0.6]: https://github.com/GreatGodApollo/qsr/compare/v0.5...v0.6

Loading…
Cancel
Save