chore: Update release script and readme

.github/release.sh

@@ -8,20 +8,28 @@ if [ "$#" -ne 1 ]; then
 fi
 new_version=$1
 
-# Update version in Cargo.toml
+echo ""
+echo "  ⏫ Update version in Cargo.toml"
+echo ""
 sed -i "s/^version = \"[0-9]*\.[0-9]*\.[0-9]*\"\$/version = \"$new_version\"/" "Cargo.toml"
 git add Cargo.toml
 git commit -S -m "chore: Bump version to $new_version"
 git push
 
-# Create and push tag
+echo ""
+echo "  🏷️  Create and push tag"
+echo ""
 git tag -a v$new_version -m "v$new_version"
 git push origin v$new_version
 
 # Update changelog
+echo ""
+echo "  🏔️ Update changelog"
+echo ""
 git cliff -o CHANGELOG.md
 git add CHANGELOG.md
 git commit -S -m "chore: Update changelog"
 git push
 
-echo "🎉 $new_version released"
+echo ""
+echo "  🎉 Version $new_version released"

README.md

@@ -103,10 +103,16 @@ The `serde` feature adds Serde `Serialize` and `Deserialize` traits to the `Trie
 ptrie = { version = "0.5", features = ["serde"] }
 ```
 
+> ⚠️ Feature not yet tested
+
 ## 🛠️ Contributing
 
 Contributions are welcome, checkout the [`CONTRIBUTING.md`](https://github.com/vemonet/ptrie/blob/main/CONTRIBUTING.md) for instructions to run the project in development.
 
-## 📜 License
+## 📜 Changelog
+
+Changelog available in the [`CHANGELOG.md`](https://github.com/vemonet/ptrie/blob/main/CHANGELOG.md).
+
+## ⚖️ License
 
 [MIT License](https://opensource.org/licenses/MIT)

cliff.toml

@@ -26,18 +26,14 @@ footer = """
 <!-- generated by git-cliff -->
 """
 postprocessors = [
-  { pattern = '<REPO>', replace = "https://github.com/vemonet/ptrie" }, # replace repository URL
+  { pattern = '<REPO>', replace = "https://github.com/vemonet/ptrie" },
 ]
 [git]
-# parse the commits based on https://www.conventionalcommits.org
+# parse the commits basegitd on https://www.conventionalcommits.org
 conventional_commits = true
 filter_unconventional = false
 # 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" },
@@ -72,3 +68,7 @@ sort_commits = "oldest"
 # ignore_tags = ""
 # limit the number of commits included in the changelog.
 # limit_commits = 42
+# regex for preprocessing the commit messages
+# commit_preprocessors = [
+#   # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, # replace issue numbers
+# ]