feat(changelog): make changelog.header a template (#698)

* feat(changelog): make changelog.header a template (#697) * refactor: clean up implementation * docs: update the description of header field --------- Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
orhun · Jun 17, 2024 · 9fc12bb · 9fc12bb
1 parent 50c240c
commit 9fc12bb
Show file tree

Hide file tree

Showing 46 changed files with 155 additions and 52 deletions.
diff --git a/.github/fixtures/new-fixture-template/cliff.toml b/.github/fixtures/new-fixture-template/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-bump-initial-tag-cli-arg/cliff.toml b/.github/fixtures/test-bump-initial-tag-cli-arg/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-bump-initial-tag-default/cliff.toml b/.github/fixtures/test-bump-initial-tag-default/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-bump-initial-tag/cliff.toml b/.github/fixtures/test-bump-initial-tag/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-bump-version-keep-zerover/cliff.toml b/.github/fixtures/test-bump-version-keep-zerover/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-bump-version/cliff.toml b/.github/fixtures/test-bump-version/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-bumped-version/cliff.toml b/.github/fixtures/test-bumped-version/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-commit-footers/cliff.toml b/.github/fixtures/test-commit-footers/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-commit-preprocessors/cliff.toml b/.github/fixtures/test-commit-preprocessors/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-configure-from-cargo-toml/Cargo.toml b/.github/fixtures/test-configure-from-cargo-toml/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [package.metadata.git-cliff.changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-custom-scope/cliff.toml b/.github/fixtures/test-custom-scope/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-custom-tag-pattern/cliff.toml b/.github/fixtures/test-custom-tag-pattern/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-date-order/cliff.toml b/.github/fixtures/test-date-order/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-footer-template/cliff.toml b/.github/fixtures/test-footer-template/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-header-template/cliff.toml b/.github/fixtures/test-header-template/cliff.toml
@@ -0,0 +1,31 @@
+[changelog]
+# template for the changelog footer
+header = """
+# Changelog
+{% for release in releases %}\
+    {% if release.version %}\
+        {% if release.previous.version %}\
+            <!--{{ release.previous.version }}..{{ release.version }}-->
+        {% endif %}\
+    {% else %}\
+        <!--{{ release.previous.version }}..HEAD-->
+    {% endif %}\
+{% endfor %}\
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}]
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the templates
+trim = true
diff --git a/.github/fixtures/test-header-template/commit.sh b/.github/fixtures/test-header-template/commit.sh
@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -e
+
+GIT_COMMITTER_DATE="2021-01-23 01:23:45" git commit --allow-empty -m "feat: add feature 1"
+GIT_COMMITTER_DATE="2021-01-23 01:23:45" git commit --allow-empty -m "feat: add feature 2"
+git tag v0.1.0
+
+GIT_COMMITTER_DATE="2021-01-23 01:23:46" git commit --allow-empty -m "fix: fix feature 1"
+GIT_COMMITTER_DATE="2021-01-23 01:23:46" git commit --allow-empty -m "fix: fix feature 2"
+git tag v0.2.0
+
+GIT_COMMITTER_DATE="2021-01-23 01:23:47" git commit --allow-empty -m "feat: add footer"
+git tag v3.0.0
+
+GIT_COMMITTER_DATE="2021-01-23 01:23:47" git commit --allow-empty -m "test: footer"
+GIT_COMMITTER_DATE="2021-01-23 01:23:47" git commit --allow-empty -m "perf: footer"
diff --git a/.github/fixtures/test-header-template/expected.md b/.github/fixtures/test-header-template/expected.md
@@ -0,0 +1,33 @@
+# Changelog
+<!--v3.0.0..HEAD-->
+<!--v0.2.0..v3.0.0-->
+<!--v0.1.0..v0.2.0-->
+## [unreleased]
+
+### Perf
+
+- Footer
+
+### Test
+
+- Footer
+
+## [3.0.0]
+
+### Feat
+
+- Add footer
+
+## [0.2.0]
+
+### Fix
+
+- Fix feature 1
+- Fix feature 2
+
+## [0.1.0]
+
+### Feat
+
+- Add feature 1
+- Add feature 2
diff --git a/.github/fixtures/test-ignore-tags/cliff.toml b/.github/fixtures/test-ignore-tags/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-keep-a-changelog-links-current-arg/cliff.toml b/.github/fixtures/test-keep-a-changelog-links-current-arg/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.

diff --git a/.github/fixtures/test-keep-a-changelog-links-latest-arg/cliff.toml b/.github/fixtures/test-keep-a-changelog-links-latest-arg/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.

diff --git a/.github/fixtures/test-keep-a-changelog-links-no-tags/cliff.toml b/.github/fixtures/test-keep-a-changelog-links-no-tags/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.

diff --git a/.github/fixtures/test-keep-a-changelog-links-one-tag-bump-arg/cliff.toml b/.github/fixtures/test-keep-a-changelog-links-one-tag-bump-arg/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.

diff --git a/.github/fixtures/test-keep-a-changelog-links-one-tag/cliff.toml b/.github/fixtures/test-keep-a-changelog-links-one-tag/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.

diff --git a/.github/fixtures/test-keep-a-changelog-links-tag-arg/cliff.toml b/.github/fixtures/test-keep-a-changelog-links-tag-arg/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.

diff --git a/.github/fixtures/test-keep-a-changelog-links-unreleased-arg/cliff.toml b/.github/fixtures/test-keep-a-changelog-links-unreleased-arg/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.

diff --git a/.github/fixtures/test-keep-a-changelog-links/cliff.toml b/.github/fixtures/test-keep-a-changelog-links/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.

diff --git a/.github/fixtures/test-latest-with-one-tag/cliff.toml b/.github/fixtures/test-latest-with-one-tag/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-limit-commits/cliff.toml b/.github/fixtures/test-limit-commits/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-no-exec/cliff.toml b/.github/fixtures/test-no-exec/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-regex-replace-parser/cliff.toml b/.github/fixtures/test-regex-replace-parser/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-skip-breaking-changes/cliff.toml b/.github/fixtures/test-skip-breaking-changes/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-skip-commits/cliff.toml b/.github/fixtures/test-skip-commits/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-split-commits/cliff.toml b/.github/fixtures/test-split-commits/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-topo-order-arg/cliff.toml b/.github/fixtures/test-topo-order-arg/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/.github/fixtures/test-topo-order/cliff.toml b/.github/fixtures/test-topo-order/cliff.toml
@@ -1,5 +1,5 @@
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/cliff.toml b/cliff.toml
@@ -6,7 +6,7 @@
 # See documentation for more information on available options.
 
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 [![animation](https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff-anim.gif)](https://git-cliff.org)\n
 """

diff --git a/config/cliff.toml b/config/cliff.toml
@@ -6,7 +6,7 @@
 # See documentation for more information on available options.
 
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/examples/cocogitto.toml b/examples/cocogitto.toml
@@ -2,7 +2,7 @@
 # https://git-cliff.org/docs/configuration
 
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.\n

diff --git a/examples/detailed.toml b/examples/detailed.toml
@@ -2,7 +2,7 @@
 # https://git-cliff.org/docs/configuration
 
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/examples/github-keepachangelog.toml b/examples/github-keepachangelog.toml
@@ -2,7 +2,7 @@
 # https://git-cliff.org/docs/configuration
 
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.

diff --git a/examples/keepachangelog.toml b/examples/keepachangelog.toml
@@ -2,7 +2,7 @@
 # https://git-cliff.org/docs/configuration
 
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.

diff --git a/examples/scoped.toml b/examples/scoped.toml
@@ -2,7 +2,7 @@
 # https://git-cliff.org/docs/configuration
 
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/examples/scopesorted.toml b/examples/scopesorted.toml
@@ -2,7 +2,7 @@
 # https://git-cliff.org/docs/configuration
 
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n

diff --git a/examples/unconventional.toml b/examples/unconventional.toml
@@ -2,7 +2,7 @@
 # https://git-cliff.org/docs/configuration
 
 [changelog]
-# changelog header
+# template for the changelog footer
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n