-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(changelog): add
git-cliff (#67)
* chore(deps): update indirect dependencies * chore(vscode): enable `go.diagnostic.vulncheck` * ci(github): update `goreleaser` job * docs(changelog): add `git-cliff` * docs(readme): update badges
- Loading branch information
Showing
11 changed files
with
297 additions
and
62 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| [files] | ||
| extend-exclude = ["CHANGELOG.md"] |
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| # Changelog | ||
|
|
||
| ## [2.0.4-beta.3](https://github.com/DeadNews/deadnews-template-go/compare/v2.0.3...v2.0.4-beta.3) - 2024-04-06 | ||
|
|
||
| ### 📚 Documentation | ||
|
|
||
| - _(changelog)_ add `git-cliff` - ([072a4fd](https://github.com/DeadNews/deadnews-template-go/commit/072a4fdaf9271966695288ee4988bcd5217d42fc)) | ||
| - _(changelog)_ add `git-cliff` - ([08102e5](https://github.com/DeadNews/deadnews-template-go/commit/08102e5c77c9189ab3104bbd7070c755662609ef)) | ||
| - _(readme)_ update badges - ([61ac858](https://github.com/DeadNews/deadnews-template-go/commit/61ac858d692fe6e291574505ab02e0e76fcf22a4)) | ||
| - _(readme)_ update badges - ([cb62cf2](https://github.com/DeadNews/deadnews-template-go/commit/cb62cf25c608345c34073f28ca33993f1e946eeb)) | ||
| - _(readme)_ update badges - ([e171584](https://github.com/DeadNews/deadnews-template-go/commit/e171584c9c59e14a67747491b0804189ec3b242a)) | ||
| - _(readme)_ add badges - ([b0e89dc](https://github.com/DeadNews/deadnews-template-go/commit/b0e89dc0b9c1191933101d2ba7f450a731988f1f)) | ||
|
|
||
| ### 🧹 Chores | ||
|
|
||
| - _(makefile)_ update - ([aa7e699](https://github.com/DeadNews/deadnews-template-go/commit/aa7e69997481479e4f0d62a03798d739409e58a8)) | ||
| - _(vscode)_ enable `go.diagnostic.vulncheck` - ([450bbb3](https://github.com/DeadNews/deadnews-template-go/commit/450bbb33fbb9ee7141dff214105dcac40594d4de)) | ||
|
|
||
| ### 👷 Build | ||
|
|
||
| - _(dockerfile)_ explicitly disable `cgo` - ([d863cfe](https://github.com/DeadNews/deadnews-template-go/commit/d863cfe6533db65d19c5afc3759fe08b621616c6)) | ||
| - _(dockerfile)_ explicitly disable `cgo` - ([44bc4e3](https://github.com/DeadNews/deadnews-template-go/commit/44bc4e3ccc5c4363af529485ca709ab2e9435f16)) | ||
| - _(dockerfile)_ explicitly disable `cgo` - ([9acff34](https://github.com/DeadNews/deadnews-template-go/commit/9acff34cd3bd4f065d519ddbc1c95e3f41566aaa)) | ||
|
|
||
| ### ⚙️ CI/CD | ||
|
|
||
| - _(github)_ update `goreleaser` job - ([21fc62c](https://github.com/DeadNews/deadnews-template-go/commit/21fc62c7a3998d4956d01a7b24db16a891567f2e)) | ||
| - _(github)_ update `goreleaser` job - ([0eb95a7](https://github.com/DeadNews/deadnews-template-go/commit/0eb95a70407f8bb4f74b0b6e6fce58eb046d7b57)) | ||
| - _(github)_ update `goreleaser` job - ([f33ebe3](https://github.com/DeadNews/deadnews-template-go/commit/f33ebe34164b9402606e88f2825629834c98a666)) | ||
| - _(github)_ update `goreleaser` job - ([1d3464e](https://github.com/DeadNews/deadnews-template-go/commit/1d3464e2051cc81b068b7386ccee034beed63c14)) | ||
| - _(pre-commit)_ replace `hadolint-docker` with `hadolint-py` - ([944f617](https://github.com/DeadNews/deadnews-template-go/commit/944f617e6f5ac6913739c760979ae31ce5473d82)) | ||
|
|
||
| ### ⬆️ Dependencies | ||
|
|
||
| - _(deps)_ update module github.com/stretchr/testify to v1.9.0 ([#62](https://github.com/DeadNews/deadnews-template-python/issues/62)) - ([3f2b941](https://github.com/DeadNews/deadnews-template-go/commit/3f2b9418c6f51f0622184bb5fd31a9c1a1ca7da8)) | ||
|
|
||
| ## [2.0.3](https://github.com/DeadNews/deadnews-template-go/compare/v2.0.2...v2.0.3) - 2024-01-24 | ||
|
|
||
| ### 👷 Build | ||
|
|
||
| - _(docker)_ update `Dockerfile` - ([83b98a4](https://github.com/DeadNews/deadnews-template-go/commit/83b98a41fbaa9d12745ce357c469f807cb1ba121)) | ||
| - _(docker)_ add `docker-compose` - ([fc59f04](https://github.com/DeadNews/deadnews-template-go/commit/fc59f04a8c95e230dc2157f9285a0f295ffb0cac)) | ||
| - _(goreleaser)_ update config ([#54](https://github.com/DeadNews/deadnews-template-python/issues/54)) - ([b85c149](https://github.com/DeadNews/deadnews-template-go/commit/b85c1492d90a1b2fef35f57711628c1088deba79)) | ||
|
|
||
| ### ⚙️ CI/CD | ||
|
|
||
| - _(pre-commit)_ add `checkmake` hook - ([16c1e3f](https://github.com/DeadNews/deadnews-template-go/commit/16c1e3fd97f15ef4e4b4f1344649dba56cb29090)) | ||
|
|
||
| ## [2.0.2](https://github.com/DeadNews/deadnews-template-go/compare/v2.0.1...v2.0.2) - 2024-01-07 | ||
|
|
||
| ### 📚 Documentation | ||
|
|
||
| - _(readme)_ update badges - ([6c6735a](https://github.com/DeadNews/deadnews-template-go/commit/6c6735a1d53cc4a02ae9c59de4fe3f92eeea178a)) | ||
|
|
||
| ### 👷 Build | ||
|
|
||
| - _(docker)_ update `Dockerfile` - ([1e825c5](https://github.com/DeadNews/deadnews-template-go/commit/1e825c5aa9ee4c5b8f27b5ace518c726dab848c4)) | ||
| - _(dockerfile)_ update paths - ([2ac9e66](https://github.com/DeadNews/deadnews-template-go/commit/2ac9e66809d7cf82750c0df3324408deec7d7ec5)) | ||
|
|
||
| ### ⬆️ Dependencies | ||
|
|
||
| - _(deps)_ update module github.com/labstack/echo/v4 to v4.11.4 ([#51](https://github.com/DeadNews/deadnews-template-python/issues/51)) - ([cb037ae](https://github.com/DeadNews/deadnews-template-go/commit/cb037ae81263f354fa2fe054255d6aaf7cfdef89)) | ||
| - _(deps)_ update module github.com/labstack/echo/v4 to v4.11.3 ([#45](https://github.com/DeadNews/deadnews-template-python/issues/45)) - ([d6e4a0c](https://github.com/DeadNews/deadnews-template-go/commit/d6e4a0cfbae9bac1ece6132fe66d1c57f672843f)) | ||
| - _(deps)_ update module github.com/labstack/echo/v4 to v4.11.2 ([#42](https://github.com/DeadNews/deadnews-template-python/issues/42)) - ([1bf8807](https://github.com/DeadNews/deadnews-template-go/commit/1bf8807742c84ae90578448a5f50457704b8e139)) | ||
|
|
||
| ## [2.0.1](https://github.com/DeadNews/deadnews-template-go/compare/v2.0.0...v2.0.1) - 2023-09-21 | ||
|
|
||
| ### 📚 Documentation | ||
|
|
||
| - _(readme)_ update badges - ([f5d121a](https://github.com/DeadNews/deadnews-template-go/commit/f5d121a5112a3c0308920d0bc038eb6739b2efc6)) | ||
| - _(readme)_ update badge - ([d04944b](https://github.com/DeadNews/deadnews-template-go/commit/d04944b7cd4301d7553baca3ebea3c83a49dd289)) | ||
| - _(readme)_ update badge - ([079a2af](https://github.com/DeadNews/deadnews-template-go/commit/079a2af6ab083bb992c0dad6f02fd709898a33ee)) | ||
|
|
||
| ### 👷 Build | ||
|
|
||
| - _(docker)_ use more explicit tags - ([882ca05](https://github.com/DeadNews/deadnews-template-go/commit/882ca0589a7dab7aa2f01dd295ef44bef50f8d31)) | ||
| - _(docker)_ update stage alias - ([bf55221](https://github.com/DeadNews/deadnews-template-go/commit/bf55221ff3d76404549d321c3e0355bbec73ff31)) | ||
|
|
||
| ### ⚙️ CI/CD | ||
|
|
||
| - use `reusable workflow` ([#35](https://github.com/DeadNews/deadnews-template-python/issues/35)) - ([b718e3f](https://github.com/DeadNews/deadnews-template-go/commit/b718e3ff9362fedf7ad1f2a05490243ce0b29756)) | ||
|
|
||
| ## [2.0.0](https://github.com/DeadNews/deadnews-template-go/compare/v1.0.0...v2.0.0) - 2023-09-19 | ||
|
|
||
| ### 🚀 Features | ||
|
|
||
| - change the sample application ([#33](https://github.com/DeadNews/deadnews-template-python/issues/33)) - ([c22ecdf](https://github.com/DeadNews/deadnews-template-go/commit/c22ecdf0fca8be184ddc461528334cee0fd8d39f)) | ||
|
|
||
| ### ⚙️ CI/CD | ||
|
|
||
| - _(dockerfile)_ add `label` - ([48bc20d](https://github.com/DeadNews/deadnews-template-go/commit/48bc20dfbb5301c8d02c6da7ee53b69fc43fa605)) | ||
| - updete `makefile` ([#34](https://github.com/DeadNews/deadnews-template-python/issues/34)) - ([0252d60](https://github.com/DeadNews/deadnews-template-go/commit/0252d602ef9acd17f0e99f233f05e57611a65c8c)) | ||
| - enable more linters ([#31](https://github.com/DeadNews/deadnews-template-python/issues/31)) - ([cb5b2cf](https://github.com/DeadNews/deadnews-template-go/commit/cb5b2cfae46db812d3582ddff6788e24e3e8d07b)) | ||
| - use `stable/oldstable` aliases in tests matrix ([#28](https://github.com/DeadNews/deadnews-template-python/issues/28)) - ([9938420](https://github.com/DeadNews/deadnews-template-go/commit/99384209c0b8b2247c24725b9b2a412258a0d587)) | ||
|
|
||
| ## [1.0.0](https://github.com/DeadNews/deadnews-template-go/compare/v0.0.7...v1.0.0) - 2023-07-24 | ||
|
|
||
| ### 📚 Documentation | ||
|
|
||
| - fix `workflow` name - ([19759e7](https://github.com/DeadNews/deadnews-template-go/commit/19759e7b07743ee9873ad7427d8773594d032a76)) | ||
| - fix `workflow` name - ([54ea0d4](https://github.com/DeadNews/deadnews-template-go/commit/54ea0d4c8c4180241a4286fa67b0e267b2271878)) | ||
|
|
||
| ### 🧹 Chores | ||
|
|
||
| - clean up - ([8693b3b](https://github.com/DeadNews/deadnews-template-go/commit/8693b3b2ea89cef678ca66b222b46900dacacb5f)) | ||
|
|
||
| ### ⚙️ CI/CD | ||
|
|
||
| - _(renovate)_ adjust schedule - ([4ddda1e](https://github.com/DeadNews/deadnews-template-go/commit/4ddda1e5c0670a53844145806aca62567ff92279)) | ||
| - _(renovate)_ use shared config - ([6b46c46](https://github.com/DeadNews/deadnews-template-go/commit/6b46c46320e33ce46330ae880c779a49954e66e2)) | ||
| - _(renovate)_ adjust schedule - ([41b7867](https://github.com/DeadNews/deadnews-template-go/commit/41b7867002f6f56f8085dbba4a786ebb1f81f3d2)) | ||
| - disable `codeql` schedule - ([7e56036](https://github.com/DeadNews/deadnews-template-go/commit/7e56036c15fed9972cb15c95ef4c857b13a4c946)) | ||
| - enable more linters - ([4e83528](https://github.com/DeadNews/deadnews-template-go/commit/4e83528a128ee8800672e864a0619e5540c1df61)) | ||
| - use `digest pinning` ([#23](https://github.com/DeadNews/deadnews-template-python/issues/23)) - ([79e7d5a](https://github.com/DeadNews/deadnews-template-go/commit/79e7d5a5e97d29c5f150da9e377d551fe71bb287)) | ||
| - update `workflows` ([#19](https://github.com/DeadNews/deadnews-template-python/issues/19)) - ([46d7970](https://github.com/DeadNews/deadnews-template-go/commit/46d7970a069287a5b44c06214f3dfa4f8f437993)) | ||
|
|
||
| ### ⬆️ Dependencies | ||
|
|
||
| - _(deps)_ update module github.com/stretchr/testify to v1.8.4 ([#21](https://github.com/DeadNews/deadnews-template-python/issues/21)) - ([ebb7b19](https://github.com/DeadNews/deadnews-template-go/commit/ebb7b190cd8431de541ed4df60d810db4b333729)) | ||
|
|
||
| ## [0.0.7](https://github.com/DeadNews/deadnews-template-go/compare/v0.0.6...v0.0.7) - 2023-05-04 | ||
|
|
||
| ### 🚀 Features | ||
|
|
||
| - rename project - ([e74bbef](https://github.com/DeadNews/deadnews-template-go/commit/e74bbef1c7853e88ecf1c533cee2fdd7a1d2470c)) | ||
|
|
||
| ### ⚙️ CI/CD | ||
|
|
||
| - _(pre-commit)_ comment `golangci-lint` hook - ([1554393](https://github.com/DeadNews/deadnews-template-go/commit/155439337ebe1b981e60909a528de4904bed8d96)) | ||
| - _(pre-commit)_ update hooks - ([b0f895d](https://github.com/DeadNews/deadnews-template-go/commit/b0f895dd242c68bc8453ddf96ff08c9d4252df51)) | ||
| - _(renovate)_ replace `dependabot` with `renovate` - ([7205a41](https://github.com/DeadNews/deadnews-template-go/commit/7205a41b02a937d32add946e4b5cb5a97a4261b7)) | ||
| - test `govulncheck` - ([fe39d19](https://github.com/DeadNews/deadnews-template-go/commit/fe39d1933ee84df7abf08d10f92526feac770a50)) | ||
|
|
||
| <!-- generated by git-cliff --> |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| # git-cliff ~ configuration file | ||
| # https://git-cliff.org/docs/configuration | ||
|
|
||
| [changelog] | ||
| header = """ | ||
| # Changelog\n | ||
| """ | ||
| postprocessors = [ | ||
| { pattern = '<REPO>', replace = "https://github.com/DeadNews/deadnews-template-python" }, | ||
| ] | ||
| body = """ | ||
| {%- macro remote_url() -%} | ||
| https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} | ||
| {%- endmacro -%} | ||
| {% macro print_commit(commit) -%} | ||
| - {% if commit.scope %}_({{ commit.scope }})_ {% endif %}\ | ||
| {% if commit.breaking %}[**breaking**] {% endif %}\ | ||
| {{ commit.message }} - \ | ||
| ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\ | ||
| {% endmacro -%} | ||
| {% if version %}\ | ||
| {% if previous.version %}\ | ||
| ## [{{ version | trim_start_matches(pat="v") }}]\ | ||
| ({{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} | ||
| {% else %}\ | ||
| ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} | ||
| {% endif %}\ | ||
| {% else %}\ | ||
| ## [unreleased] | ||
| {% endif %}\ | ||
| {% for group, commits in commits | group_by(attribute="group") %} | ||
| ### {{ group | striptags | trim | upper_first }} | ||
| {% for commit in commits | ||
| | filter(attribute="scope") | ||
| | sort(attribute="scope") %} | ||
| {{ self::print_commit(commit=commit) }} | ||
| {%- endfor -%} | ||
| {% raw %}\n{% endraw %}\ | ||
| {%- for commit in commits %} | ||
| {%- if not commit.scope -%} | ||
| {{ self::print_commit(commit=commit) }} | ||
| {% endif -%} | ||
| {% endfor -%} | ||
| {% endfor %}\n | ||
| """ | ||
| footer = """ | ||
| <!-- generated by git-cliff --> | ||
| """ | ||
| trim = true | ||
|
|
||
| [git] | ||
| conventional_commits = true # parse the commits based on https://www.conventionalcommits.org | ||
| filter_unconventional = true # filter out the commits that are not conventional | ||
| split_commits = false # process each line of a commit as an individual commit | ||
| commit_preprocessors = [ | ||
| { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))" }, # Replace github issue numbers | ||
| { pattern = " +", replace = " " }, # Remove multiple whitespaces | ||
| ] | ||
| commit_parsers = [ | ||
| { message = "^(ci|build|chore)\\(deps.*\\)", skip = true }, | ||
| { message = "^chore\\(release\\)", skip = true }, | ||
| { message = "^fix\\(deps.*\\)", group = "<!-- 92 -->⬆️ Dependencies" }, | ||
| { message = "^feat", group = "<!-- 0 -->🚀 Features" }, | ||
| { message = "^fix", group = "<!-- 1 -->🐛 Bug fixes" }, | ||
| { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" }, | ||
| { message = "^doc", group = "<!-- 3 -->📚 Documentation" }, | ||
| { message = "^perf", group = "<!-- 4 -->⚡ Performance" }, | ||
| { message = "^style", group = "<!-- 5 -->🎨 Styling" }, | ||
| { message = "^test", group = "<!-- 6 -->🧪 Testing" }, | ||
| { message = "^chore", group = "<!-- 7 -->🧹 Chores" }, | ||
| { body = ".*security", group = "<!-- 8 -->🛡️ Security" }, | ||
| { message = "^build", group = "<!-- 9 -->👷 Build" }, | ||
| { message = "^ci", group = "<!-- 91 -->⚙️ CI/CD" }, | ||
| { message = "^revert", group = "<!-- 93 -->◀️ Revert" }, | ||
| ] | ||
| protect_breaking_commits = true | ||
| filter_commits = false # filter out the commits that are not matched by commit parsers | ||
| tag_pattern = "v[0-9].*" # regex for matching git tags | ||
| skip_tags = "" # drop commits from the changelog | ||
| ignore_tags = "rc|beta|alpha" # include ignored commits into the next tag | ||
| topo_order = false # sort the tags topologically | ||
| sort_commits = "newest" # sort the commits inside sections by oldest/newest order |
Oops, something went wrong.