Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Jun 17, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea9841e
feat(changelog): make changelog.header a template (#697)
Cyclonit Jun 16, 2024
8cc5f46
refactor: clean up implementation
orhun Jun 17, 2024
17540a0
docs: update the description of header field
orhun Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/fixtures/new-fixture-template/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-bump-initial-tag-cli-arg/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-bump-initial-tag-default/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-bump-initial-tag/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-bump-version-keep-zerover/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-bump-version/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-bumped-version/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-commit-footers/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-commit-preprocessors/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-configure-from-cargo-toml/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-custom-scope/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-custom-tag-pattern/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-date-order/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-footer-template/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
31 changes: 31 additions & 0 deletions .github/fixtures/test-header-template/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
16 changes: 16 additions & 0 deletions .github/fixtures/test-header-template/commit.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
33 changes: 33 additions & 0 deletions .github/fixtures/test-header-template/expected.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion .github/fixtures/test-ignore-tags/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-keep-a-changelog-links-current-arg/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-keep-a-changelog-links-latest-arg/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-keep-a-changelog-links-no-tags/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-keep-a-changelog-links-one-tag-bump-arg/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-keep-a-changelog-links-one-tag/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-keep-a-changelog-links-tag-arg/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-keep-a-changelog-links-unreleased-arg/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-keep-a-changelog-links/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-latest-with-one-tag/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-limit-commits/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-no-exec/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-regex-replace-parser/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-skip-breaking-changes/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-skip-commits/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-split-commits/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-topo-order-arg/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/fixtures/test-topo-order/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""
Expand Down
2 changes: 1 addition & 1 deletion config/cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/cocogitto.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/detailed.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/github-keepachangelog.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion examples/keepachangelog.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion examples/scoped.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/scopesorted.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/unconventional.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading