All notable changes to this project will be documented in this file.
The format is inspired by Keep a Changelog 1.0.0.
The versions follow the rules of Semantic Versioning 2.0.0.
[Full Changes]
Last active
February 23, 2023 21:20
-
-
Save adoyle-h/9d466c80bf419ceba278316198eb5690 to your computer and use it in GitHub Desktop.
CHANGELOG.md
[Full Changes]({{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD)
{{ if .Tag.Previous -}} [Full Changes]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}) {{ end }}
{{- if .NoteGroups }}
{{- $noteIdx := 0 -}}
{{- range .NoteGroups }}{{ range .Notes }}
{{- $noteIdx = add $noteIdx 1 -}}
{{ end }}
{{ end }}
Have {{ $noteIdx }} breaking changes. Check below logs with
{{- range .CommitGroups }}
{{ range .Commits -}}
- {{ if .Notes }}
⚠️ {{ end }}{{ if .Scope }}{{ .Scope }}: {{ end }} {{- regexReplaceAll "([^`])(<.*>)([^`])" .Subject "$1$2$3" }} ({{.Hash.Short}}) {{- if .Refs }} ({{ range .Refs }}[#{{ .Ref }}]({{$.Info.RepositoryURL}}/issues/{{ .Ref }}) {{- end }}){{- end }} {{- if not (empty .Body) }}{{ regexReplaceAll "\n" .Body "\n > " | abbrev 960 }}
{{- end }} {{ end }} {{- end -}}
{{- if .RevertCommits -}}
{{ range .RevertCommits -}}
- {{ .Revert.Header }} {{ end }} {{ end -}}
{{- if .MergeCommits -}}
{{ range .MergeCommits -}}
- {{ .Header }} {{ end }} {{ end -}} {{ end -}}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| style: github | |
| template: CHANGELOG.tpl.md | |
| info: | |
| title: CHANGELOG | |
| repository_url: https://github.com/adoyle-h/makefile-utils | |
| options: | |
| tag_filter_pattern: '^v' | |
| sort: "date" | |
| commits: | |
| filters: | |
| Type: | |
| - feat | |
| - fix | |
| - revert | |
| - perf | |
| - docs | |
| sort_by: Scope | |
| commit_groups: | |
| group_by: Type | |
| sort_by: Custom | |
| title_order: | |
| - feat | |
| - fix | |
| - revert | |
| - perf | |
| - docs | |
| title_maps: | |
| feat: New Features | |
| fix: Bug Fixes | |
| perf: Performance Improvements | |
| docs: Document Changes | |
| header: | |
| pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?!?\\:\\s(.*)$" | |
| pattern_maps: | |
| - Type | |
| - Scope | |
| - Subject | |
| notes: | |
| keywords: | |
| - BREAKING CHANGE |
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
These files are templates for generating CHANGELOG.md by makefile-utils.