chore: Enable CHANGELOG.md generation(#37)

Author: MykolaMarusenko

.chglog/CHANGELOG.tpl.md

@@ -0,0 +1,60 @@
+{{ if .Versions -}}
+<a name="unreleased"></a>
+## [Unreleased]
+
+{{ 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 }}
+{{ end }}
+{{ end -}}
+
+{{- if .RevertCommits -}}
+### Reverts
+
+{{ range .RevertCommits -}}
+- {{ .Revert.Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .MergeCommits -}}
+### Pull Requests
+{{ range .MergeCommits -}}
+- {{ .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 -}}

.chglog/config.yml

@@ -0,0 +1,50 @@
+style: none
+template: CHANGELOG.tpl.md
+info:
+  title: CHANGELOG
+  repository_url: https://github.com/KubeRocketCI/gitfusion
+
+options:
+  tag_filter_pattern: '^v'
+  sort: "semVer"
+
+  commits:
+    filters:
+      Type:
+        - chore
+        - docs
+        - feat
+        - fix
+        - refactor
+        - style
+        - test
+
+  commit_groups:
+    group_by: Type
+    sort_by: Custom
+    title_order:
+      - feat
+      - fix
+      - refactor
+      - style
+      - test
+      - chore
+      - docs
+    title_maps:
+      chore: Routine
+      docs: Documentation
+      feat: Features
+      fix: Bug Fixes
+      refactor: Code Refactoring
+      style: Formatting
+      test: Testing
+
+  header:
+    pattern: "^(feat|fix|docs|style|refactor|test|chore)+!?:\\s(.*)$"
+    pattern_maps:
+      - Type
+      - Subject
+
+  notes:
+    keywords:
+      - "BREAKING CHANGE:"

.chglog/release.tpl.md

@@ -0,0 +1,29 @@
+{{ 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 }}
+{{ end }}
+{{ end -}}
+
+{{- if .NoteGroups -}}
+{{ range .NoteGroups -}}
+### {{ .Title }}
+
+{{ range .Notes }}
+{{ .Body }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
+
+{{- if .Versions }}
+{{ range .Versions -}}
+{{ if .Tag.Previous -}}
+[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
+{{ end -}}
+{{ end -}}
+{{ end -}}

Makefile

@@ -1,6 +1,7 @@
 OAPICODEGEN_VERSION ?= v2.4.1
 GOLANGCI_LINT_VERSION ?= v2.1.6
 HELMDOCS_VERSION ?= v1.14.2
+GITCHGLOG_VERSION ?= v0.15.4
 
 CURRENT_DIR=$(shell pwd)
 HOST_OS?=$(shell go env GOOS)
@@ -41,6 +42,15 @@ lint: golangci-lint ## Run go lint
 lint-fix: golangci-lint ## Run go lint fix
 	${GOLANGCI_LINT} run -v -c .golangci.yaml ./... --fix
 
+# use https://github.com/git-chglog/git-chglog/
+.PHONY: changelog
+changelog: git-chglog	## generate changelog
+ifneq (${NEXT_RELEASE_TAG},)
+	$(GITCHGLOG) --next-tag v${NEXT_RELEASE_TAG} -o CHANGELOG.md
+else
+	$(GITCHGLOG) -o CHANGELOG.md
+endif
+
 # Run tests
 test:
 	go test ./... -coverprofile=coverage.out
@@ -65,6 +75,11 @@ HELMDOCS = $(LOCALBIN)/helm-docs
 helmdocs: ## Download helm-docs locally if necessary.
 	$(call go-install-tool,$(HELMDOCS),github.com/norwoodj/helm-docs/cmd/helm-docs,$(HELMDOCS_VERSION))
 
+GITCHGLOG = $(LOCALBIN)/git-chglog
+.PHONY: git-chglog
+git-chglog: ## Download git-chglog locally if necessary.
+	$(call go-install-tool,$(GITCHGLOG),github.com/git-chglog/git-chglog/cmd/git-chglog,$(GITCHGLOG_VERSION))
+
 # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
 # $1 - target path with name of binary
 # $2 - package url which can be installed