CHANGELOG.md

CHANGELOG.md

Changelog

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.

[Unreleased]

[Full Changes]

CHANGELOG.tpl.md

[Unreleased]

[Full Changes]({{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD)

{{ range .Versions }}

{{ .Tag.Name }} ({{ datetime "2006-01-02 15:04:05 -07:00" .Tag.Date }})

{{ if .Tag.Previous -}} [Full Changes]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}) {{ end }}

{{- if .NoteGroups }}

Breaking Changes

{{- $noteIdx := 0 -}} {{- range .NoteGroups }}{{ range .Notes }} {{- $noteIdx = add $noteIdx 1 -}} {{ end }} {{ end }} Have {{ $noteIdx }} breaking changes. Check below logs with ⚠️ . {{ end }}

{{- range .CommitGroups }}

{{ .Title }}

{{ 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 -}}

Reverts

{{ range .RevertCommits -}}

• {{ .Revert.Header }} {{ end }} {{ end -}}

{{- if .MergeCommits -}}

Pull Requests

{{ range .MergeCommits -}}

• {{ .Header }} {{ end }} {{ end -}} {{ end -}}

config.yml

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

These files are templates for generating CHANGELOG.md by makefile-utils.