9 Commits

Author SHA1 Message Date
Unbound Release 3883ebe5e6 chore(release): prepare for v0.2.0 2024-11-14 08:03:20 +00:00
argoyle 42dc76f02f feat: add git-cliff configuration for changelog generation
Add a default configuration file for git-cliff to ensure 
consistent changelog generation. This configuration enables 
the use of conventional commits, filters out non-conventional 
commits, and organizes commit messages into defined groups. 
It also provides templates for the changelog header, body, 
and footer, facilitating improved documentation for notable 
changes in the project.
2024-11-14 09:00:40 +01:00
Renovate d27ad44b4d chore(deps): update golang:1.23.3 docker digest to c2d828f 2024-11-13 20:54:53 +00:00
Renovate 27fff9ee8f chore(deps): update golang:1.23.3 docker digest to 2660218 2024-11-13 11:54:07 +00:00
Renovate de064a911b chore(deps): update golang:1.23.3 docker digest to b2ca381 2024-11-13 08:54:05 +00:00
Renovate bd49e640c1 chore(deps): update golang:1.23.3 docker digest to 3694e36 2024-11-13 05:53:51 +00:00
Renovate 80085180ad chore(deps): update golang:1.23.3 docker digest to 8956c08 2024-11-12 08:53:09 +00:00
Renovate e6c8d4ee3b chore(deps): update golang docker tag to v1.23.3 2024-11-07 08:53:07 +00:00
Renovate 8d4394662f chore(deps): pin golang docker tag to ad5c126 2024-11-03 16:33:08 +00:00
3 changed files with 107 additions and 1 deletions
+26
View File
@@ -2,6 +2,22 @@
All notable changes to this project will be documented in this file.
## [0.2.0] - 2024-11-14
### 🚀 Features
- Add git-cliff configuration for changelog generation
### ⚙️ Miscellaneous Tasks
- *(deps)* Pin golang docker tag to ad5c126
- *(deps)* Update golang docker tag to v1.23.3
- *(deps)* Update golang:1.23.3 docker digest to 8956c08
- *(deps)* Update golang:1.23.3 docker digest to 3694e36
- *(deps)* Update golang:1.23.3 docker digest to b2ca381
- *(deps)* Update golang:1.23.3 docker digest to 2660218
- *(deps)* Update golang:1.23.3 docker digest to c2d828f
## [0.1.0] - 2024-10-05
### 🚀 Features
@@ -10,8 +26,15 @@ All notable changes to this project will be documented in this file.
### ⚙️ Miscellaneous Tasks
- *(deps)* Update golang docker tag to v1.22.3
- Add ruby-dev to Dockerfile
- *(deps)* Update golang docker tag to v1.22.4
- *(deps)* Update golang docker tag to v1.22.5
- *(deps)* Update golang docker tag to v1.22.6
- *(deps)* Update golang docker tag to v1.23.0
- Update golangci-lint version to v1.60.1
- *(deps)* Update golang docker tag to v1.23.1
- *(deps)* Update golang docker tag to v1.23.2
- Add release flow
## [0.0.4] - 2024-04-09
@@ -20,6 +43,9 @@ All notable changes to this project will be documented in this file.
- Add dependabot config
- Make releases handle multi-line release notes
- *(deps)* Bump golang from 1.20 to 1.21
- *(deps)* Bump golang from 1.21 to 1.22
- *(deps)* Update node.js to v20
- Remove Dependabot config
- Update to Go 1.22.2
+1 -1
View File
@@ -1,4 +1,4 @@
FROM golang:1.23.2
FROM golang:1.23.3@sha256:c2d828fd49c47ed2b9192d2dbffed83052d8a21af465056d732c3de0d756f217
ENV PATH=${PATH}:/root/.local/bin
+80
View File
@@ -0,0 +1,80 @@
# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration
#
# Lines starting with "#" are comments.
# Configuration options are organized into tables and keys.
# See documentation for more information on available options.
[changelog]
# template for the changelog header
header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | striptags | trim | upper_first }}
{% for commit in commits %}
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | upper_first }}\
{% endfor %}
{% endfor %}\n
"""
# template for the changelog footer
footer = """
<!-- generated by git-cliff -->
"""
# remove the leading and trailing s
trim = true
# postprocessors
postprocessors = [
# { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
]
# render body even when there are no releases to process
# render_always = true
# output file path
# output = "test.md"
[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# process each line of a commit as an individual commit
split_commits = false
# regex for preprocessing the commit messages
commit_preprocessors = [
# Replace issue numbers
#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
# Check spelling of the commit with https://github.com/crate-ci/typos
# If the spelling is incorrect, it will be automatically fixed.
#{ pattern = '.*', replace_command = 'typos --write-changes -' },
]
# regex for parsing and grouping commits
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
{ message = "^style", group = "<!-- 5 -->🎨 Styling" },
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
{ message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
{ body = ".*security", group = "<!-- 8 -->🛡️ Security" },
{ message = "^revert", group = "<!-- 9 -->◀️ Revert" },
]
# filter out the commits that are not matched by commit parsers
filter_commits = false
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"