Release 0.2.3

CHANGELOG.md

@@ -2,48 +2,57 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.2.2] - 2024-04-30
+## [0.2.3] - 2024-09-02
 
-### Build configuration
+### 🚀 Features
 
-- Update dependencies and Cargo metadata
-- Add `native-certs` feature flag
+- Add support for listening on Unix domain sockets
 
-### CI configuration
+### 📚 Documentation
 
-- Test building with optional features enabled
+- Fix Markdown list formatting
 
-### Documentation
+### 🛠️ Build
 
-- Document the new `native-certs` feature flag
+- Update dependencies and Cargo metadata
 
-### Features
+### ⚙️ Miscellaneous Tasks
+
+- Update git-cliff config file
+
+## [0.2.2] - 2024-04-30
+
+### 🚀 Features
 
 - Add HTTP client `User-Agent` header
 
-## [0.2.1] - 2024-02-19
+### 📚 Documentation
 
-### Build configuration
+- Document the new `native-certs` feature flag
+
+### 🛠️ Build
 
 - Update dependencies and Cargo metadata
+- Add `native-certs` feature flag
 
-### Features
+### ⚙️ Miscellaneous Tasks
 
-- Store the cached index entry mtime in files
-- Recover from index connection failures
+- Test building with optional features enabled
 
-## [0.2.0] - 2023-08-09
+## [0.2.1] - 2024-02-19
 
-### Build configuration
+### 🚀 Features
 
-- [**breaking**] Rewrite using `tiny_http` directly
-- Update the crate description and dependencies
+- Store the cached index entry mtime in files
+- Recover from index connection failures
 
-### Documentation
+### 🛠️ Build
 
-- Update crate docs and README for v0.2
+- Update dependencies and Cargo metadata
+
+## [0.2.0] - 2023-08-09
 
-### Features
+### 🚀 Features
 
 - Add initial support for the sparse registry
 - Forward sparse index entry get requests
@@ -52,59 +61,65 @@ All notable changes to this project will be documented in this file.
 - Add memory cache for index entry metadata
 - Implement index metadata cache invalidation
 
-### Refactor
+### 🚜 Refactor
 
 - Move file cache functions into a submodule
 
-### Styling
+### 📚 Documentation
+
+- Update crate docs and README for v0.2
+
+### 🎨 Styling
 
 - *(changelog)* Group log entries by scope
 
+### 🛠️ Build
+
+- [**breaking**] Rewrite using `tiny_http` directly
+- Update the crate description and dependencies
+
 ## [0.1.4] - 2023-07-02
 
-### Build configuration
+### 🛠️ Build
 
 - Update dependencies and Cargo metadata
 
-### CI configuration
+### ⚙️ Miscellaneous Tasks
 
 - Add container build check job
 - Publish tagged versions to crates.io
 
 ## [0.1.3] - 2023-02-23
 
-### Build configuration
+### 🚜 Refactor
+
+- Fix Clippy warnings
+
+### 🛠️ Build
 
 - Update build dependencies
 - Use Cargo build profile for stripping
 
-### CI configuration
+### ⚙️ Miscellaneous Tasks
 
 - Build versioned Docker images
 
-### Refactor
+## [0.1.2] - 2022-11-15
 
-- Fix Clippy warnings
+### 🚜 Refactor
 
-## [0.1.2] - 2022-11-15
+- Box `ureq::Error` to reduce the returned enum size
 
-### Build configuration
+### 🛠️ Build
 
 - Update dependencies and bump to v0.1.2
 
-### CI configuration
+### ⚙️ Miscellaneous Tasks
 
 - Add a basic .gitlab.yml config file.
 - Add a GitHub workflow for Rust build checks
 - Add a GitHub workflow for publishing Docker images
-
-### Miscellaneous Tasks
-
 - Add `git-cliff` config file
 - Add a change log file
 
-### Refactor
-
-- Box `ureq::Error` to reduce the returned enum size
-
 <!-- generated by git-cliff -->

cliff.toml

@@ -1,13 +1,18 @@
-# configuration file for git-cliff (0.1.0)
+# 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
+# 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://tera.netlify.app/docs/#introduction
+# https://keats.github.io/tera/docs/#introduction
 body = """
 {% if version %}\
     ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
@@ -16,28 +21,23 @@ body = """
 {% endif %}\
 {% for group, commits in commits | group_by(attribute="group") %}
     ### {{ group | striptags | trim | upper_first }}
-    {% for commit in commits
-    | filter(attribute="scope")
-    | sort(attribute="scope") %}
-        - *({{commit.scope}})*{% if commit.breaking %} [**breaking**]{% endif %} \
-            {{ commit.message | upper_first }}
-    {%- endfor -%}
-    {% raw %}\n{% endraw %}\
-    {%- for commit in commits %}
-        {%- if commit.scope -%}
-        {% else -%}
-            - {% if commit.breaking %}[**breaking**] {% endif %}\
-                {{ commit.message | upper_first }}
-        {% endif -%}
-    {% endfor -%}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% 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
+# 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/ravenexp/crates-io-proxy/" },
+]
 
 [git]
 # parse the commits based on https://www.conventionalcommits.org
@@ -48,34 +48,32 @@ filter_unconventional = true
 split_commits = false
 # regex for preprocessing the commit messages
 commit_preprocessors = [
-    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/ravenexp/crates-io-proxy/issues/${2}))"},
+  # 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 = "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\\(build\\):", skip = true},
-    { message = "^chore", group = "Miscellaneous Tasks"},
-    { message = "^build", group = "Build configuration"},
-    { message = "^ci", group = "CI configuration"},
-    { body = ".*security", group = "Security"},
+  { 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 = "^build", group = "<!-- 7 -->🛠️ Build" },
+  { 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 = "<!-- 8 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 9 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 10 -->◀️ 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
-# glob pattern 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