From 55cb8c0280bdb6b297574ff577a3ae5dfa8f9ff6 Mon Sep 17 00:00:00 2001 From: perzeuss <11357019+perzeuss@users.noreply.github.com> Date: Tue, 11 Mar 2025 22:27:38 +0100 Subject: [PATCH] chore: setup changelog via git cliff --- CHANGELOG.md | 65 ++++++++++++++++++++++++++++++++++++++++ cliff.toml | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 149 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 cliff.toml diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5062186 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,65 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## [0.5.1] - 2025-03-11 + +### ๐Ÿ› Bug Fixes + +- Typo in label for endpoint parameter (#6) + +### โš™๏ธ Miscellaneous Tasks + +- Update icon +- Improve README (#5) +- Add privacy file to manifest +- Extend .difyignore (#11) +- Release 0.5.1 + +## [0.5.0] - 2025-03-08 + +### ๐Ÿš€ Features + +- Add single app mode (#3) + +### ๐Ÿงช Testing + +- Add unit tests + +### โš™๏ธ Miscellaneous Tasks + +- Add badges to README.md +- Privacy policy +- Add issue templates +- Create FUNDING.yml + +## [0.4.2] - 2025-02-26 + +### ๐Ÿ› Bug Fixes + +- Error when default_middleware_json is undefined +- Query and conversation_id undefined when explicit_inputs is true + +### โš™๏ธ Miscellaneous Tasks + +- Release 0.4.2 + +## [0.4.1] - 2025-02-23 + +### ๐Ÿš€ Features + +- Initial commit +- Support webhooks without api key +- Add translations +- Support for middlewares +- Support raw json output + +### ๐Ÿ› Bug Fixes + +- Wrong parameter name + +### โš™๏ธ Miscellaneous Tasks + +- Update license + + diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..8656d82 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,84 @@ +# 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 = """ + +""" +# remove the leading and trailing s +trim = true +# postprocessors +postprocessors = [ + # { pattern = '', 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}](/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 = "๐Ÿš€ Features" }, + { message = "^fix", group = "๐Ÿ› Bug Fixes" }, + { message = "^doc", group = "๐Ÿ“š Documentation" }, + { message = "^perf", group = "โšก Performance" }, + { message = "^refactor", group = "๐Ÿšœ Refactor" }, + { message = "^style", group = "๐ŸŽจ Styling" }, + { message = "^test", group = "๐Ÿงช Testing" }, + { message = "^chore\\(release\\): prepare for", skip = true }, + { message = "^chore\\(deps.*\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^chore|^ci", group = "โš™๏ธ Miscellaneous Tasks" }, + { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, + { message = "^revert", group = "โ—€๏ธ Revert" }, + { message = ".*", group = "๐Ÿ’ผ Other" }, +] +# 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"