fix(changelog): better template, less redundant, fix broken links

filter out merge commits, release messages, fix links to pr/issues better temlate all round finally! Signed-off-by: gacallea <3269984+gacallea@users.noreply.github.com>
andreacfromtheapp · Aug 9, 2024 · d2512ae · d2512ae
1 parent c708197
commit d2512ae
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 60 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,159 +13,104 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Single git tag and tag template - ([aa1a051](https://github.com/gacallea/freesound-credits/commit/aa1a051824c405c06fb4677e9786f69a106d301a)) by gacallea
 
-
 ### ⚙️ Miscellaneous Tasks
 
-- Release v0.2.11 (#16) - ([4a56702](https://github.com/gacallea/freesound-credits/commit/4a56702d40e16615bfc053fbd2fd5d5d38c5c530)) by Andrea C
-
-- Release - ([8250e43](https://github.com/gacallea/freesound-credits/commit/8250e43dc0fefb786cd9326529b39fcb6db91e20)) by Andrea C
-
-- Improve release-plz config (#15) - ([b942acd](https://github.com/gacallea/freesound-credits/commit/b942acdc5595dad560017d1f3cafdf7ef88404ca)) by Andrea C
-
 - Binstall name var - ([5d3977e](https://github.com/gacallea/freesound-credits/commit/5d3977e081cda505f0998356abaee716f5e297d4)) by gacallea
-
 - Remove configs with default values - ([d5b0e9e](https://github.com/gacallea/freesound-credits/commit/d5b0e9eb7ff69b23b0ce12ceada8010532cf8134)) by gacallea
 
-
 ## [0.2.10](https://github.com/gacallea/freesound-credits/compare/v0.2.9..v0.2.10)
 
 ### 🐛 Bug Fixes
 
-- Remove git-cliff altogether (#13) - ([04de822](https://github.com/gacallea/freesound-credits/commit/04de8223600530d9c9488142e6accf29d4b5b5c5)) by Andrea C
-
 - Removed cliff altogether - ([4184fae](https://github.com/gacallea/freesound-credits/commit/4184fae2bb61b4bcae32df55404ac28fbb38cf9c)) by gacallea
-
-- Trying to switch to keep a changelog (#12) - ([8847a1c](https://github.com/gacallea/freesound-credits/commit/8847a1c6ba5f564ac5043e330aee4096d0687651)) by Andrea C
-
 - Trying to switch to keep a changelog - ([0c432c6](https://github.com/gacallea/freesound-credits/commit/0c432c6557f379ba11b04484656d3e84ab803284)) by gacallea
 
-
 ### ⚙️ Miscellaneous Tasks
 
-- Release v0.2.10 (#14) - ([f774cc5](https://github.com/gacallea/freesound-credits/commit/f774cc573c35fb67d29b4968b2444298541beb9b)) by Andrea C
-
-- Release - ([1612ea1](https://github.com/gacallea/freesound-credits/commit/1612ea1b4b2f9948781091f8a80011ca54c0b3f5)) by Andrea C
-
 - Empty the changelog - ([e675890](https://github.com/gacallea/freesound-credits/commit/e6758909169f591c42f22007b3d6d7c2fa0cf7f6)) by gacallea
 
-
 ## [0.2.9](https://github.com/gacallea/freesound-credits/compare/v0.2.8..v0.2.9)
 
 ### ⚙️ Miscellaneous Tasks
 
-- Release v0.2.9 (#11) - ([64bef43](https://github.com/gacallea/freesound-credits/commit/64bef439a5b39a79f568fb3f87b80323b773ddea)) by Andrea C
-
-- Fixing git cliff and changelog -- adding clarify for some license (#10) - ([fdbb853](https://github.com/gacallea/freesound-credits/commit/fdbb853dd1c2a73f10ae5d74e909f8a10a425423)) by Andrea C
-
+- Fixing git cliff and changelog -- adding clarify for some license ([#10](https://github.com/gacallea/freesound-credits/issues/10)) - ([fdbb853](https://github.com/gacallea/freesound-credits/commit/fdbb853dd1c2a73f10ae5d74e909f8a10a425423)) by Andrea C
 
 ## [0.2.8](https://github.com/gacallea/freesound-credits/compare/v0.2.7..v0.2.8)
 
 ### ⚙️ Miscellaneous Tasks
 
-- Release v0.2.8 (#9) - ([2f4a74c](https://github.com/gacallea/freesound-credits/commit/2f4a74cc6b5ed7b19691b53b3dcb262353e008e6)) by Andrea C
-
-- Improvements for deny assist pre-commit and plz (#8) - ([9c9b2a2](https://github.com/gacallea/freesound-credits/commit/9c9b2a212846aef18559dfda00550d9d901c2297)) by Andrea C
-
+- Improvements for deny assist pre-commit and plz ([#8](https://github.com/gacallea/freesound-credits/issues/8)) - ([9c9b2a2](https://github.com/gacallea/freesound-credits/commit/9c9b2a212846aef18559dfda00550d9d901c2297)) by Andrea C
 
 ## [0.2.7](https://github.com/gacallea/freesound-credits/compare/v0.2.6..v0.2.7)
 
 ### ⚙️ Miscellaneous Tasks
 
-- Release v0.2.7 (#7) - ([4f17315](https://github.com/gacallea/freesound-credits/commit/4f1731527441bbede6a8fb91fe79b0e5070087c1)) by Andrea C
-
-- Adding empty chagelog file cause cargo-dist needs it. (#6) - ([cc0e118](https://github.com/gacallea/freesound-credits/commit/cc0e118c1ffcf57af6d01456d6cfced3bbfbe83f)) by Andrea C
-
+- Adding emtpy chagelog file cause cargo-dist needs it. ([#6](https://github.com/gacallea/freesound-credits/issues/6)) - ([cc0e118](https://github.com/gacallea/freesound-credits/commit/cc0e118c1ffcf57af6d01456d6cfced3bbfbe83f)) by Andrea C
 
 ## [0.2.6](https://github.com/gacallea/freesound-credits/compare/v0.2.5..v0.2.6)
 
 ### ⚙️ Miscellaneous Tasks
 
-- Path bump for ci improvements (#5) - ([9181092](https://github.com/gacallea/freesound-credits/commit/9181092e24499ea91b23def027cbff0e5fc54a77)) by Andrea C
-
 - Path bump for ci improvements - ([1be859a](https://github.com/gacallea/freesound-credits/commit/1be859a751359d4114fda6002cf33409d2597448)) by gacallea
-
 - Fix cliff toml - ([f541cee](https://github.com/gacallea/freesound-credits/commit/f541cee669415cbfab3db0c198ec83148fb92690)) by gacallea
-
 - Added cargo-assist - ([f0c0005](https://github.com/gacallea/freesound-credits/commit/f0c0005f42ae8d853c0ba2be72b1cee787ac9e0f)) by gacallea
-
 - Change dependabot to less aggressive schedule - ([4cdcf61](https://github.com/gacallea/freesound-credits/commit/4cdcf612e6a11f66f5ec29981f92aa7027f387cb)) by gacallea
 
-
 ## [0.2.5](https://github.com/gacallea/freesound-credits/compare/v0.2.4..v0.2.5)
 
 ### ⛰️  Features
 
 - Added musl - ([f30644d](https://github.com/gacallea/freesound-credits/commit/f30644d070dd8b9472905b8da1c1b4d10283bb7c)) by gacallea
-
 - Added homebrew - ([d10839f](https://github.com/gacallea/freesound-credits/commit/d10839fe941eff7348926c2ac962b1da4f406410)) by gacallea
 
-
 ### 🐛 Bug Fixes
 
 - Change run mode to upload - ([22d288c](https://github.com/gacallea/freesound-credits/commit/22d288c0fc6c4d74a8a83ef09f0b72b3642d2be7)) by gacallea
 
-
 ### ⚙️ Miscellaneous Tasks
 
-- Release (#4) - ([f3dd43e](https://github.com/gacallea/freesound-credits/commit/f3dd43ec5a057f6eafe2fff01d8fc0f6e5f346f3)) by Andrea C
-
 - Chronological order for badges - ([f1a4f68](https://github.com/gacallea/freesound-credits/commit/f1a4f68a2939cb6da3d581640f4739c88f559095)) by gacallea
 
-
 ## [0.2.4](https://github.com/gacallea/freesound-credits/compare/v0.2.3..v0.2.4)
 
 ### ⚙️ Miscellaneous Tasks
 
 - Bump version to be on track with release-plz and crates - ([667af7f](https://github.com/gacallea/freesound-credits/commit/667af7f8979586f19653e6f69f142a9e0f174b33)) by gacallea
-
 - Fix badge name for deployment - ([ca31d63](https://github.com/gacallea/freesound-credits/commit/ca31d6337ac6812f16661c0bbd64e87b244d717b)) by gacallea
 
-
 ## [0.2.3](https://github.com/gacallea/freesound-credits/compare/v0.2.2..v0.2.3)
 
 ### ⚙️ Miscellaneous Tasks
 
-- Release - ([f1896b3](https://github.com/gacallea/freesound-credits/commit/f1896b3e55b7f04a06f41c65af9f6e5c232f9956)) by Andrea C
-
 - Automated CI/CD improved - ([4c93d95](https://github.com/gacallea/freesound-credits/commit/4c93d9528189655a75d18b72d9192cbc67526a45)) by gacallea
-
 - Add/fix templates emojis - ([2dbe1d7](https://github.com/gacallea/freesound-credits/commit/2dbe1d746a34399b8d405568ea7391c781ed344c)) by gacallea
-
 - Delete leftover script dir - ([dedf877](https://github.com/gacallea/freesound-credits/commit/dedf8777f5f8a5209bd8b7ccb5c4b0a59d126304)) by gacallea
 
-
 ## [0.2.2](https://github.com/gacallea/freesound-credits/compare/v0.2.1..v0.2.2)
 
 ### ⚙️ Miscellaneous Tasks
 
 - Wow shiny new cargo-dist CI! - ([8c76d66](https://github.com/gacallea/freesound-credits/commit/8c76d6682c05a8bd5200abb6d71d68941b19ec99)) by gacallea
 
-
 ## [0.2.1](https://github.com/gacallea/freesound-credits/compare/v0.2.0..v0.2.1)
 
 ### 🐛 Bug Fixes
 
 - *(rewadme)* Cargo version bump to fix install mistake - ([c8ef775](https://github.com/gacallea/freesound-credits/commit/c8ef775ea3527920b2df8c9a78eb37421e76c421)) by gacallea
 
-
 ## [0.2.0](https://github.com/gacallea/freesound-credits/compare/v0.1.2..v0.2.0)
 
 ### ⛰️  Features
 
 - *(issue)* Add feature request template - ([d10b225](https://github.com/gacallea/freesound-credits/commit/d10b225da2e5d2e287cf546c34e0b1cb7ad7d555)) by gacallea
-
 - *(issue)* Add bug report template - ([52ce50d](https://github.com/gacallea/freesound-credits/commit/52ce50d795dd765805a7b8683901b2b6f3ab89f7)) by gacallea
-
 - *(issue)* Adding DAW request template - ([05c5a36](https://github.com/gacallea/freesound-credits/commit/05c5a36eec0cfb98146e04d367679b57ae9c7910)) by gacallea
 
-
 ### 🐛 Bug Fixes
 
 - *(readme)* Added cc section and link to contribute - ([15145ee](https://github.com/gacallea/freesound-credits/commit/15145ee337c1d63e70a28add8caa7fbbb1ecac29)) by gacallea
 
-
 ### 📚 Documentation
 
 - *(contributing)* Adding contributing - ([f60b2e6](https://github.com/gacallea/freesound-credits/commit/f60b2e64844de98f61eea81a4967a4a06846baba)) by gacallea
 
-
diff --git a/release-plz.toml b/release-plz.toml
@@ -56,7 +56,10 @@ body = """
     {% endif %}\
 {% endif %}\
 
-{% for group, commits in commits | group_by(attribute="group") %}
+{% for group, commits in commits
+| filter(attribute="merge_commit", value=false)
+| unique(attribute="message")
+| group_by(attribute="group") %}
     ### {{ group | striptags | trim | upper_first }}
     {% for commit in commits
     | filter(attribute="scope")
@@ -81,7 +84,8 @@ commit_parsers = [
   { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
   { message = "^style", group = "<!-- 5 -->🎨 Styling" },
   { message = "^test", group = "<!-- 6 -->🧪 Testing" },
-  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(release\\):", skip = true },
+  { message = "^chore: release", skip = true },
   { message = "^chore\\(deps.*\\)", skip = true },
   { message = "^chore\\(pr\\)", skip = true },
   { message = "^chore\\(pull\\)", skip = true },
@@ -90,3 +94,12 @@ commit_parsers = [
   { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
   { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
 ]
+
+link_parsers = [
+  # Extract all GitLab issues and PRs and generate URLs linking to them.
+  # The link text will be the matching pattern.
+  { pattern = "#(\\d+)", href = "https://github.com/gacallea/freesound-credits/issues/$1" },
+  # Extract mentions of IETF RFCs and generate URLs linking to them.
+  # It also rewrites the text as "ietf-rfc...".
+  { pattern = "RFC(\\d+)", text = "ietf-rfc$1", href = "https://datatracker.ietf.org/doc/html/rfc$1" },
+]