diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 05b51b7..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,35 +0,0 @@ -Gst Client changelog -=========================== - -All user visible changes to this project will be documented in this file. This project uses [Semantic Versioning 2.0.0]. - - - - - - - - - -## [Unreleased] - ReleaseDate - -[Unreleased]: /../../tree/HEAD - - - -## [0.1.2] - 2022-08-31 - -[0.1.2]: /../../tree/v0.1.2 - -### Implemented - -- Supported the [GStD HTTP API] spec; -- Documentation for base use case. - - - - - -[Semantic Versioning 2.0.0]: https://semver.org -[GStremaer]: https://gstreamer.freedesktop.org/ -[GStD HTTP API]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Daemon_-_HTTP_API diff --git a/Cargo.toml b/Cargo.toml index 69d5a78..fc6e8f3 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -14,14 +14,10 @@ categories = ["web-programming::http-client"] [package.metadata.release] allow-branch = ["master"] +pre-release-hook = ["git-cliff", "-o", "CHANGELOG.md", "--tag", "{{version}}"] pre-release-replacements = [ {file="README.md", search="v[0-9]+\\.[0-9]+\\.[0-9]+", replace="v{{version}}"}, {file="README.md", search="v[0-9]+\\.[0-9]+\\.[0-9]+\\]\\(https://github\\.com/InnovateAndBuild/gst-client/tree/master\\)", replace="v{{version}}](https://github.com/InnovateAndBuild/gst-client/tree/v{{version}})"}, - {file="CHANGELOG.md", search="Unreleased", replace="{{version}}", min=1}, - {file="CHANGELOG.md", search="...HEAD", replace="...{{tag_name}}", exactly=1}, - {file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}", min=1}, - {file="CHANGELOG.md", search="", replace="\n## [Unreleased] - ReleaseDate\n", exactly=1}, - {file="CHANGELOG.md", search="", replace="\n[Unreleased]: /../../tree/HEAD", exactly=1}, ] [dependencies] diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..0ccbebf --- /dev/null +++ b/cliff.toml @@ -0,0 +1,99 @@ +# 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 footer +header = """ +Gst Client 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") }} +[{{ version | trim_start_matches(pat="v") }}]: /../../tree/{{ version }} + + [Diff](/../../compare/{{ previous.version }}...{{ version }}) +{% else %}\ + ## [unreleased]: /../../tree/HEAD +{% 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 }} ([{{ commit.id | truncate(length=7, end="") }}])\ + {% endfor %} +{% endfor %}\n + +{% for commit in commits %}[{{ commit.id | truncate(length=7, end="") }}]: /../../commit/{{ commit.id }}\n{% endfor %} +""" +# template for the changelog footer +footer = """ + +[Semantic Versioning 2.0.0]: https://semver.org +[GStremaer]: https://gstreamer.freedesktop.org/ +[GStD HTTP API]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Daemon_-_HTTP_APIยช + +""" +# remove the leading and trailing s +trim = true +# postprocessors +postprocessors = [ + # { pattern = '', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL +] + +[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" }, +] +# protect breaking changes from being skipped due to matching a skipping commit_parser +protect_breaking_commits = false +# filter out the commits that are not matched by commit parsers +filter_commits = false +# regex for matching git tags +# tag_pattern = "v[0-9].*" +# regex for skipping tags +# skip_tags = "" +# 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" +# limit the number of commits included in the changelog. +# limit_commits = 42