CHANGELOG.md

@@ -0,0 +1,88 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### 🚀 Features
+
+- *(ci)* Generate package size report
+- Add git-cliff to generate changelogs
+
+### 🐛 Bug Fixes
+
+- *(webnsupdate)* Reduce binary size
+
+### ⚙️ Miscellaneous Tasks
+
+- *(flake.lock)* Update inputs
+- Cargo update
+
+## [0.3.2] - 2024-11-23
+
+### 🚀 Features
+
+- *(ci)* Check depends on build
+- Upgrade clap_verbosity_flag
+- Replace axum-auth with tower_http
+- Release new version
+
+### 🐛 Bug Fixes
+
+- *(clippy)* Enable more lints and fix issues
+
+### 🚜 Refactor
+
+- Reorganize main.rs
+
+### ⚙️ Miscellaneous Tasks
+
+- Cargo update
+- Update flake inputs
+
+## [0.3.1] - 2024-10-28
+
+### 🐛 Bug Fixes
+
+- Overlay was broken T-T
+
+### ⚙️ Miscellaneous Tasks
+
+- Next dev version
+
+## [0.3.0] - 2024-10-28
+
+### 🚀 Features
+
+- *(ci)* Auto-update rust deps
+- Refactor and add ip saving
+- Add -v verbosity flag
+- Use treefmt-nix and split up flake.nix
+- Add NixOS VM tests
+- Switch to crane
+
+### 🐛 Bug Fixes
+
+- *(fmt)* Use nixfmt-rfc-style
+- *(default.nix)* Small issues here and there
+- *(ci)* Do not use a name when logging in
+
+### 🚜 Refactor
+
+- *(flake)* Use flake-parts
+
+### ⚙️ Miscellaneous Tasks
+
+- Updarte deps
+- *(flake.lock)* Update inputs
+- Cargo update
+- Cargo update
+- Cargo update
+
+## [0.2.0] - 2024-06-02
+
+### 💼 Other
+
+- Init at version 0.1.0
+
+<!-- generated by git-cliff -->

cliff.toml

@@ -0,0 +1,85 @@
+# 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 = """
+<!-- 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
+]
+# 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}](<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: bump version", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
+  { message = ".*", group = "<!-- 10 -->💼 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"

flake-modules/default.nix

@@ -22,10 +22,11 @@
       };
 
       devShells.default = pkgs.mkShellNoCC {
-        packages = [
-          pkgs.cargo-insta
-          pkgs.cargo-udeps
-          pkgs.mold
+        packages = with pkgs; [
+          cargo-insta
+          cargo-udeps
+          mold
+          git-cliff
         ];
       };
     };

flake-modules/package.nix

@@ -62,6 +62,7 @@
 
       packages = {
         inherit webnsupdate;
+        inherit (pkgs) git-cliff;
         default = webnsupdate;
         cargo-update = pkgs.writeShellApplication {
           name = "cargo-update-lockfile";