chore: add auto changelog generation

CHANGELOG.md

@@ -1,35 +1,81 @@
 Gst Client changelog
 ===========================
 
-All user visible changes to this project will be documented in this file. This project uses [Semantic Versioning 2.0.0].
+All notable changes to this project will be documented in this file.
 
+## [Unreleased]: /../../tree/HEAD
 
 
-<!-- next-header -->
+### 🚀 Features
 
-<!-- next-url -->
+- Allow to create GstClient from Url ([6cf5178])
+- Reexport gstd_types::Response ([5dda4ef])
+- Show error description from gstd ([6dd49e3])
 
+### 🐛 Bug Fixes
 
+- Delete pipeline endpoint ([2fa3beb])
+- Incomplete set of properties ([77ad7e8])
+- Pipeline().stop() fails due to incorrect parameters ([f5c63f6])
 
-## [Unreleased] - ReleaseDate
+### 🧪 Testing
 
-[Unreleased]: /../../tree/HEAD
+- Update tests ([8abcd98])
 
+### ⚙️ Miscellaneous Tasks
 
+- Add versions auto update ([3e46734])
+- Run all check with `make check` & `make` commands ([f43338e])
+- Add test run ([e7660ec])
+- Improve version update in README ([c8db347])
+- Add auto changelog generation ([50f6e8a])
 
-## [0.1.2] - 2022-08-31
 
+
+[3e46734]: /../../commit/3e4673451aceee11d307777b8e501d1bb6ce863d
+[6cf5178]: /../../commit/6cf51786aabee1be07bd16d199ae6eb922d03803
+[f43338e]: /../../commit/f43338ef7e0f8bccdb3971537afd313c06029875
+[5dda4ef]: /../../commit/5dda4ef4374448347e5af9e452c21449f48d714f
+[2fa3beb]: /../../commit/2fa3beb31927cce419ceeffe3d9afce794c21c92
+[8abcd98]: /../../commit/8abcd98710be424b1df52b81ede98c018e36ff54
+[77ad7e8]: /../../commit/77ad7e80248434bfb80c9ab1ea479086dfef57ec
+[f5c63f6]: /../../commit/f5c63f623f54723ce854bace7515c1af41e59233
+[6dd49e3]: /../../commit/6dd49e390ba2a0c990561c67e2604a49c8acaa1c
+[e7660ec]: /../../commit/e7660ec678951fb4901e57d6ef4f121c91b3929b
+[c8db347]: /../../commit/c8db347f470ed78e257da1e00271ab7e95b54527
+[50f6e8a]: /../../commit/50f6e8a348581fad502b5b8e1a80e57103f557d7
+
+
+
+
+## [0.1.2] · 2022-08-30
 [0.1.2]: /../../tree/v0.1.2
 
-### Implemented
+[Diff](/../../compare/v0.1.1...v0.1.2)
+
+### 🚀 Features
+
+- Accept all variation of String ([4221481])
+
+### 📚 Documentation
+
+- Improve docs ([48839d4])
+
+### ⚙️ Miscellaneous Tasks
+
+- Update lint and add another check on CI ([468f5bc])
+
+
 
-- Supported the [GStD HTTP API] spec;
-- Documentation for base use case.
+[48839d4]: /../../commit/48839d4c8e691587ce6f028d424a6feba3bce60a
+[468f5bc]: /../../commit/468f5bc2cbf6e870a88163780a17b55428fef840
+[4221481]: /../../commit/4221481ca1c7b9a02049eedabce960d860a1e67b
 
 
 
 
 
 [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
+[GStD HTTP API]: https://developer.ridgerun.com/wiki/index.php/GStreamer_Daemon_-_HTTP_APIª
+<!-- generated by git-cliff -->

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="<!-- next-header -->", replace="<!-- next-header -->\n## [Unreleased] - ReleaseDate\n", exactly=1},
-    {file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: /../../tree/HEAD", exactly=1},
 ]
 
 [dependencies]

cliff.toml

@@ -0,0 +1,103 @@
+# 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ª
+<!-- 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
+]
+
+[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\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 9 -->◀️ 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