ci: added configuration for changelog generation

.github/workflows/release.yml

@@ -43,8 +43,7 @@ jobs:
       - name: "Create release"
         uses: "taiki-e/create-gh-release-action@v1"
         with:
-          # (optional) Path to changelog.
-          # changelog: CHANGELOG.md
+          changelog: CHANGELOG.md
           branch: "master"
           ref: refs/tags/v${{ needs.get-tag.outputs.pkg-version }}
           token: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,133 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 🚧 [unreleased] 🚧
+
+### ✨ Features
+
+- Added SN field to make queries more efficient
+- First migration
+- Added logging directory settings
+- Implemented file logging
+- Implemented logging
+- Implemented settings loading from file
+- Added commandline arguments
+
+### 🐛 Bug Fixes
+
+- Fixed gs not adding SN data when present.
+- Fixed migration crashing if the column already existed
+
+### 📚 Documentation
+
+- Updated readme to reflect latest changes
+
+### 🔧 Chores
+
+- Preparing for sqlx migrations integration
+- Added config file to docker-compose.yml sample
+
+### 🔨 Refactor
+
+- Removed types module
+
+## [0.1.3-a] - 2023-11-20
+
+### 🐛 Bug Fixes
+
+- Fixed server not being able to connect in docker network
+
+## [0.1.3] - 2023-11-20
+
+### Build
+
+- Temporarily disabled asset uploading
+
+### 🐛 Bug Fixes
+
+- Added more debug information when a connection cannot be established.
+
+### 🔧 Chores
+
+- Bump version
+
+## [0.1.2-a] - 2023-11-19
+
+### Build
+
+- Fixed semver
+
+## [0.1.2a] - 2023-11-19
+
+### 👷 Continuous Integration
+
+- Made release include assets
+- Fixed sqlx within dockerfile
+
+## [0.1.2] - 2023-11-19
+
+### 👷 Continuous Integration
+
+- Removed musl release target
+- Fixed wrong branch being used
+- Fixed wrong version number being used
+
+## [0.1.20.7.2] - 2023-11-19
+
+### Build
+
+- Ignored dead code in utils
+
+### ✨ Features
+
+- Implemented basic database persistence
+- Implemented basic decoding
+- Implemented better cancellation
+
+### 🐛 Bug Fixes
+
+- Fixed compile errors
+- Fixed server not listening for all the stop signals needed
+- Fixed dockerfile not building
+- Removed special characters from strings
+
+### 👷 Continuous Integration
+
+- Fixed access for gh actions bot
+- Updated actions files to work
+- Updated actions files to work
+- Fixed ci deprecated actions
+- New actions for releases and docker hub publishing.
+- Fixed sqlx offline mode not being used for tests
+- Fixed sqlx offline mode not being used
+- Create rust.yml
+- First version of dockerfile
+
+### 💎 Styling
+
+- More style fixes from fmt
+- Applied style suggestions from fmt and clippy
+- First try with fmt
+
+### 📚 Documentation
+
+- Added shield for build GH Action
+- Added license and readme
+
+### 🔧 Chores
+
+- Moved data4 behavior to separate struct
+- Moved utility functions to separate module
+- Added units
+- Added all fields available for v6 inverters
+- Growatt v6 protocol
+- Simplified unscrambling
+- First commit
+
+### 🔨 Refactor
+
+- Cleanup
+- Using cancellation token instead
+
+<!-- generated by git-cliff -->

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "growatt_server"
-version = "0.2.0"
+version = "0.1.3-a"
 edition = "2021"
 authors = ["Stefano Vittorio Porta <[email protected]>"]
 description = "Server that listens for Growatt inverters and copies the data before relaying it to remote."

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]
+# 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 | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.breaking %}[⚠️ **BREAKING** ⚠️] {% endif %}{{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# postprocessors
+postprocessors = [
+   { pattern = '<REPO>', replace = "https://github.com/stefa168/growatt_server" }, # 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 = [
+   { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, # replace issue numbers
+]
+# 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 = "^ci", group = "👷 Continuous Integration"},
+  { message = "^chore|ci", group = "🔧 Chores" },
+  { body = ".*security", group = "🚨 Security" },
+  { message = "^revert", group = "🪃 Revert" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = true
+# 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 = "v0.1.0-beta.1"
+# regex for ignoring tags
+ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "newest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42