From d49b19881d04adb1ba968bc473956011795e87c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?c=C4=83t=C4=83lin?= Date: Wed, 5 Oct 2022 18:10:00 +0200 Subject: [PATCH] chore: update CHANGELOG --- CHANGELOG | 20 +++++++++++++++++ cliff.toml | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+) create mode 100644 CHANGELOG create mode 100644 cliff.toml diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..d0513b8 --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,20 @@ +# Changelog +All notable changes to this project will be documented in this file. + +## [0.1.0] - 2022-10-05 + +### Bug Fixes + +- Remove py39 as default python from pre-commit's config file + +### Continuous Integration + +- Add base jobs +- Add `linux-header` alpine dep @ install_deps job +- Install cargo before installing pre-commimt hooks + +### Features + +- Add basefiles + + diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..97963c6 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,64 @@ +# configuration file for git-cliff (0.1.0) + +[changelog] +# changelog header +header = """ +# Changelog +All notable changes to this project will be documented in this file.\n +""" +# template for the changelog body +# https://tera.netlify.app/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 | upper_first }} + {% for commit in commits %} + - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\ + {% endfor %} +{% endfor %}\n +""" +# remove the leading and trailing whitespaces from the template +trim = true +# changelog footer +footer = """ + +""" + +[git] +# parse the commits based on https://www.conventionalcommits.org +conventional_commits = true +# filter out the commits that are not conventional +filter_unconventional = true +# regex for parsing and grouping commits +commit_parsers = [ + { message = "^feat", group = "Features" }, + { message = "^fix", group = "Bug Fixes" }, + { message = "^doc", group = "Documentation" }, + { message = "^perf", group = "Performance" }, + { message = "^refactor", group = "Refactor" }, + { message = "^refactor\\(release\\)", skip = true }, + { message = "^style", group = "Styling" }, + { message = "^test", group = "Testing" }, + { message = "^chore\\(release\\): prepare for", skip = true }, + { message = "^chore", skip = true }, + { message = "^ci", group = "Continuous Integration" }, + { message = "^WIP", skip = true }, + { message = "^BREAKING", group = "Breaking Changes" }, + { body = ".*security", group = "Security" }, +] +# filter out the commits that are not matched by commit parsers +filter_commits = true +# glob pattern for matching git tags +tag_pattern = "v[0-9]*" +# regex for skipping tags +skip_tags = "v[0-9].[0-9].[0-9][a-zA-Z][0-9]" +# regex for ignoring tags +ignore_tags = "" +# sort the tags topologically +topo_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "oldest"