From e5191334dde309a5d2ee4d87d6b5f14bb5e80131 Mon Sep 17 00:00:00 2001 From: Jeff Dickey <216188+jdx@users.noreply.github.com> Date: Fri, 29 Mar 2024 17:31:18 -0500 Subject: [PATCH] doc: improve CHANGELOG --- CHANGELOG.md | 137 +++++++++++++++++++++++++++++++++++++-------------- Cargo.lock | 88 +++++++++++++++------------------ cliff.toml | 92 ++++++++++++++++++++-------------- 3 files changed, 193 insertions(+), 124 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 822819fb..2e572a00 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,64 +1,125 @@ # Changelog -All notable changes to this project will be documented in this file. +--- +## [0.1.17](https://github.com/jdx/usage/compare/v0.1.16..v0.1.17) - 2024-03-17 + +### โš™๏ธ Miscellaneous Tasks + +- ensure we publish the CLI by [@jdx](https://github.com/jdx) in [8b1f379](https://github.com/jdx/usage/commit/8b1f379ed94b5e85429846d0e3d1b0198a1449d1) +- bump release by [@jdx](https://github.com/jdx) in [3fa016a](https://github.com/jdx/usage/commit/3fa016a266753e9e5ebeb81eed61c74ced46e5cb) --- -## [unreleased] +## [0.1.16](https://github.com/jdx/usage/compare/v0.1.9..v0.1.16) - 2024-03-17 + +### ๐Ÿ› Bug Fixes + +- **(completions)** add newline before error message by [@jdx](https://github.com/jdx) in [bbbafad](https://github.com/jdx/usage/commit/bbbafad126889ccc415e586b7601f7bb97c6f5a8) +- bug fix for release tagging by [@jdx](https://github.com/jdx) in [2c4832f](https://github.com/jdx/usage/commit/2c4832f7c7c67d8d5c477a11e56a49b487f574b8) + +### ๐Ÿ“ฆ๏ธ Dependency Updates + +- update rust crate heck to v0.5.0 (#30) by [@renovate[bot]](https://github.com/renovate[bot]) in [#30](https://github.com/jdx/usage/pull/30) +- update dependency vitepress to v1.0.0-rc.45 (#28) by [@renovate[bot]](https://github.com/renovate[bot]) in [b4b8054](https://github.com/jdx/usage/commit/b4b8054d74d9df6826e2c44b051ec4823b646c0b) + +### ๐Ÿ” Other Changes + +- added author field by [@jdx](https://github.com/jdx) in [b0e815a](https://github.com/jdx/usage/commit/b0e815a72bf4bfad6659a909a058cd86b7f9d56d) +- snapshots by [@jdx](https://github.com/jdx) in [3f0f16c](https://github.com/jdx/usage/commit/3f0f16c9b4fc2ff346a97644e97878916c1fa630) +- added brew tap to gh actions by [@jdx](https://github.com/jdx) in [e79f386](https://github.com/jdx/usage/commit/e79f386ff75bea7d35f3c90f0060a94656169c51) + +### ๐Ÿšœ Refactor + +- move usage-lib into its own dir by [@jdx](https://github.com/jdx) in [37e2379](https://github.com/jdx/usage/commit/37e2379122f123a85c4888e6efa1f62c631ac013) + +### ๐Ÿงช Testing + +- **(markdown-link-check)** ignore placeholder urls by [@jdx](https://github.com/jdx) in [6744453](https://github.com/jdx/usage/commit/67444538f25a11c09f842e20a5baa30fc3f41fae) +- **(markdown-link-check)** ignore placeholder urls by [@jdx](https://github.com/jdx) in [940dfb7](https://github.com/jdx/usage/commit/940dfb7cd5d1dbc8d2f1bab3029c1c4ba786f6ee) +- fix snapshots by [@jdx](https://github.com/jdx) in [0ea3d8b](https://github.com/jdx/usage/commit/0ea3d8b6ae7e3343c71c6d23b9e2b5d0f648a575) +- fix deprecation warnings by [@jdx](https://github.com/jdx) in [be8d6d5](https://github.com/jdx/usage/commit/be8d6d5b9090103d5596ff6a038ad63e538c1722) ### โš™๏ธ Miscellaneous Tasks -- **(release-plz)** add all cargo files - ([6bc237d](https://github.com/jdx/mise/commit/6bc237d1babee025a0b4737781a6a742d93b7f4a)) - jdx -- switch to dtolnay/rust-toolchain - ([d96d2a3](https://github.com/jdx/mise/commit/d96d2a37ff801d10868db265f26c10cf42181a11)) - jdx +- **(release-plz)** autopublish tag/gh release by [@jdx](https://github.com/jdx) in [5f78550](https://github.com/jdx/usage/commit/5f7855048912adda5ebfa6cfd2375cf5e5ccb79b) +- **(release-plz)** remove old logic by [@jdx](https://github.com/jdx) in [9ac8a0e](https://github.com/jdx/usage/commit/9ac8a0e95ae51398633486365a45a447bd8664e5) +- **(release-plz)** prefix versions with "v" by [@jdx](https://github.com/jdx) in [964503c](https://github.com/jdx/usage/commit/964503c57d8960abec4d6655257c1b904e585eba) +- added git-cliff by [@jdx](https://github.com/jdx) in [6cca2bb](https://github.com/jdx/usage/commit/6cca2bbc77e459c45838e1957bc35eb42601a727) +- added release-please by [@jdx](https://github.com/jdx) in [e60127f](https://github.com/jdx/usage/commit/e60127f63a48a841b9aadfa04c9c4df045167dde) +- attempt to fix mega-linter by [@jdx](https://github.com/jdx) in [25a35e0](https://github.com/jdx/usage/commit/25a35e064c2ca29771d1c6b1ac5d2bea2b03b530) +- bootstrap release-please (#31) by [@jdx](https://github.com/jdx) in [b6a7584](https://github.com/jdx/usage/commit/b6a758421231e33582c9571aa3690936faa1e59b) +- release-plz by [@jdx](https://github.com/jdx) in [b7aa490](https://github.com/jdx/usage/commit/b7aa490d7b401d86ac11569aae824951ab4de27c) +- cargo update by [@jdx](https://github.com/jdx) in [0aa872c](https://github.com/jdx/usage/commit/0aa872ca68822d32d9fa8a5228525124ed076abb) +- remove markdown link checker since it keeps failing by [@jdx](https://github.com/jdx) in [0668a1f](https://github.com/jdx/usage/commit/0668a1f6dae63bd3ea916939ab0a4c9c58fd0c13) +- release (#39) by [@mise-en-dev](https://github.com/mise-en-dev) in [#39](https://github.com/jdx/usage/pull/39) +- fixing cargo metadata by [@jdx](https://github.com/jdx) in [64f19d7](https://github.com/jdx/usage/commit/64f19d7d40de0f897ccd22c07cd72e74b98b435f) +- use custom release-plz logic by [@jdx](https://github.com/jdx) in [bf4c151](https://github.com/jdx/usage/commit/bf4c151205d0560eefbf7a64cefd2524c57813db) +- bump version to try another release by [@jdx](https://github.com/jdx) in [badf251](https://github.com/jdx/usage/commit/badf251feb7fe86d763e4458261060b81f85fe7e) +- set metadata for usage-lib dependency by [@jdx](https://github.com/jdx) in [7e3538a](https://github.com/jdx/usage/commit/7e3538a304372c8d010386e22d39c02c9319d297) +- added git-cliff dependency by [@jdx](https://github.com/jdx) in [afd74d0](https://github.com/jdx/usage/commit/afd74d020d86fd77fe9b0696ae63863237297009) +- bump version to try another release by [@jdx](https://github.com/jdx) in [032f686](https://github.com/jdx/usage/commit/032f6860f569874e8ca2928f7db367191a8e69b3) +- bump release by [@jdx](https://github.com/jdx) in [4f3e3ea](https://github.com/jdx/usage/commit/4f3e3ea284968006e677402bd78afd3c592698b4) +- release on tags by [@jdx](https://github.com/jdx) in [6fd60be](https://github.com/jdx/usage/commit/6fd60be73ed06d62520fd2d39f175857243ec6e7) +- bump release by [@jdx](https://github.com/jdx) in [58be1c4](https://github.com/jdx/usage/commit/58be1c40f45fa86d1d8c6c6e58cbec85451c0d40) +- bump release by [@jdx](https://github.com/jdx) in [cd92e36](https://github.com/jdx/usage/commit/cd92e366ee60d9ea2cc6b43f9dadc7f27c0dd63e) + +### New Contributors + +* @mise-en-dev made their first contribution in [#39](https://github.com/jdx/usage/pull/39) --- -## [0.1.17](https://github.com/jdx/mise/compare/v0.1.16..v0.1.17) - 2024-03-17 +## [0.1.9](https://github.com/jdx/usage/compare/v0.1.8..v0.1.9) - 2024-02-13 + +### ๐Ÿ› Bug Fixes + +- fix actionlint by [@jdx](https://github.com/jdx) in [725bcf9](https://github.com/jdx/usage/commit/725bcf96055aafc9f0a58e0c8affe2c0ac7f3ba9) + +### ๐Ÿ” Other Changes + +- improve error by [@jdx](https://github.com/jdx) in [4621457](https://github.com/jdx/usage/commit/4621457b6cccde7f01ba60afe6c33870201975be) ### โš™๏ธ Miscellaneous Tasks -- ensure we publish the CLI - ([8b1f379](https://github.com/jdx/mise/commit/8b1f379ed94b5e85429846d0e3d1b0198a1449d1)) - jdx -- bump release - ([3fa016a](https://github.com/jdx/mise/commit/3fa016a266753e9e5ebeb81eed61c74ced46e5cb)) - jdx +- Release by [@jdx](https://github.com/jdx) in [1a10e64](https://github.com/jdx/usage/commit/1a10e641aa7803f6cc9fea98fea959e7e29b8430) --- -## [0.1.16](https://github.com/jdx/mise/compare/v0.1.9..v0.1.16) - 2024-03-17 +## [0.1.8](https://github.com/jdx/usage/compare/v0.1.7..v0.1.8) - 2024-02-10 ### ๐Ÿ› Bug Fixes -- **(completions)** add newline before error message - ([bbbafad](https://github.com/jdx/mise/commit/bbbafad126889ccc415e586b7601f7bb97c6f5a8)) - jdx -- bug fix for release tagging - ([2c4832f](https://github.com/jdx/mise/commit/2c4832f7c7c67d8d5c477a11e56a49b487f574b8)) - jdx +- fix binstall by [@jdx](https://github.com/jdx) in [a3b4513](https://github.com/jdx/usage/commit/a3b45132dd4b9f6b4d7a1ae224de455f28de75dd) -### ๐Ÿšœ Refactor +### ๐Ÿ“ฆ๏ธ Dependency Updates -- move usage-lib into its own dir - ([37e2379](https://github.com/jdx/mise/commit/37e2379122f123a85c4888e6efa1f62c631ac013)) - jdx +- update stefanzweifel/git-auto-commit-action action to v5 (#25) by [@renovate[bot]](https://github.com/renovate[bot]) in [#25](https://github.com/jdx/usage/pull/25) -### ๐Ÿงช Testing +### โš™๏ธ Miscellaneous Tasks + +- Release by [@jdx](https://github.com/jdx) in [258b63b](https://github.com/jdx/usage/commit/258b63b4bbfd4e20846d55ac40add4ac5d0ac28f) + +--- +## [0.1.7](https://github.com/jdx/usage/compare/v0.1.6..v0.1.7) - 2024-02-10 + +### ๐Ÿ› Bug Fixes + +- fix apple urls for binstall by [@jdx](https://github.com/jdx) in [06261f0](https://github.com/jdx/usage/commit/06261f0174bc0a95f216a9b22f85b0955f8c4a26) + +### โš™๏ธ Miscellaneous Tasks + +- Release by [@jdx](https://github.com/jdx) in [2c07616](https://github.com/jdx/usage/commit/2c07616e0fda38fe589873c9c6674941b8ebd214) + +--- +## [0.1.6] - 2024-02-10 + +### ๐Ÿ“ฆ๏ธ Dependency Updates + +- update actions/checkout action to v4 (#23) by [@renovate[bot]](https://github.com/renovate[bot]) in [#23](https://github.com/jdx/usage/pull/23) + +### ๐Ÿ” Other Changes -- **(markdown-link-check)** ignore placeholder urls - ([6744453](https://github.com/jdx/mise/commit/67444538f25a11c09f842e20a5baa30fc3f41fae)) - jdx -- **(markdown-link-check)** ignore placeholder urls - ([940dfb7](https://github.com/jdx/mise/commit/940dfb7cd5d1dbc8d2f1bab3029c1c4ba786f6ee)) - jdx -- fix snapshots - ([0ea3d8b](https://github.com/jdx/mise/commit/0ea3d8b6ae7e3343c71c6d23b9e2b5d0f648a575)) - jdx -- fix deprecation warnings - ([be8d6d5](https://github.com/jdx/mise/commit/be8d6d5b9090103d5596ff6a038ad63e538c1722)) - jdx +- add config for cargo-binstall by [@jdx](https://github.com/jdx) in [9711365](https://github.com/jdx/usage/commit/9711365fbfe1b39df03597af93caf9ca1b0e1b62) ### โš™๏ธ Miscellaneous Tasks -- **(release-plz)** autopublish tag/gh release - ([5f78550](https://github.com/jdx/mise/commit/5f7855048912adda5ebfa6cfd2375cf5e5ccb79b)) - jdx -- **(release-plz)** remove old logic - ([9ac8a0e](https://github.com/jdx/mise/commit/9ac8a0e95ae51398633486365a45a447bd8664e5)) - jdx -- **(release-plz)** prefix versions with "v" - ([964503c](https://github.com/jdx/mise/commit/964503c57d8960abec4d6655257c1b904e585eba)) - jdx -- added git-cliff - ([6cca2bb](https://github.com/jdx/mise/commit/6cca2bbc77e459c45838e1957bc35eb42601a727)) - jdx -- added release-please - ([e60127f](https://github.com/jdx/mise/commit/e60127f63a48a841b9aadfa04c9c4df045167dde)) - jdx -- attempt to fix mega-linter - ([25a35e0](https://github.com/jdx/mise/commit/25a35e064c2ca29771d1c6b1ac5d2bea2b03b530)) - jdx -- bootstrap release-please (#31) - ([b6a7584](https://github.com/jdx/mise/commit/b6a758421231e33582c9571aa3690936faa1e59b)) - jdx -- release-plz - ([b7aa490](https://github.com/jdx/mise/commit/b7aa490d7b401d86ac11569aae824951ab4de27c)) - jdx -- cargo update - ([0aa872c](https://github.com/jdx/mise/commit/0aa872ca68822d32d9fa8a5228525124ed076abb)) - jdx -- remove markdown link checker since it keeps failing - ([0668a1f](https://github.com/jdx/mise/commit/0668a1f6dae63bd3ea916939ab0a4c9c58fd0c13)) - jdx -- release (#39) - ([c88d57e](https://github.com/jdx/mise/commit/c88d57ed40974bea0a9370c76f79536805c4679c)) - mise-en-dev -- fixing cargo metadata - ([64f19d7](https://github.com/jdx/mise/commit/64f19d7d40de0f897ccd22c07cd72e74b98b435f)) - jdx -- use custom release-plz logic - ([bf4c151](https://github.com/jdx/mise/commit/bf4c151205d0560eefbf7a64cefd2524c57813db)) - jdx -- bump version to try another release - ([badf251](https://github.com/jdx/mise/commit/badf251feb7fe86d763e4458261060b81f85fe7e)) - jdx -- set metadata for usage-lib dependency - ([7e3538a](https://github.com/jdx/mise/commit/7e3538a304372c8d010386e22d39c02c9319d297)) - jdx -- added git-cliff dependency - ([afd74d0](https://github.com/jdx/mise/commit/afd74d020d86fd77fe9b0696ae63863237297009)) - jdx -- bump version to try another release - ([032f686](https://github.com/jdx/mise/commit/032f6860f569874e8ca2928f7db367191a8e69b3)) - jdx -- bump release - ([4f3e3ea](https://github.com/jdx/mise/commit/4f3e3ea284968006e677402bd78afd3c592698b4)) - jdx -- release on tags - ([6fd60be](https://github.com/jdx/mise/commit/6fd60be73ed06d62520fd2d39f175857243ec6e7)) - jdx -- bump release - ([58be1c4](https://github.com/jdx/mise/commit/58be1c40f45fa86d1d8c6c6e58cbec85451c0d40)) - jdx -- bump release - ([cd92e36](https://github.com/jdx/mise/commit/cd92e366ee60d9ea2cc6b43f9dadc7f27c0dd63e)) - jdx +- Release by [@jdx](https://github.com/jdx) in [72c5834](https://github.com/jdx/usage/commit/72c58342396ff8f479043b7465526eb0fa735644) diff --git a/Cargo.lock b/Cargo.lock index 66c14754..c5864197 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -19,9 +19,9 @@ checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe" [[package]] name = "aho-corasick" -version = "1.1.2" +version = "1.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b2969dcb958b36655471fc61f7e416fa76033bdd4bfed0678d8fee1e2d07a1f0" +checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916" dependencies = [ "memchr", ] @@ -107,15 +107,15 @@ dependencies = [ [[package]] name = "autocfg" -version = "1.1.0" +version = "1.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" +checksum = "f1fdabc7756949593fe60f30ec81974b613357de856987752631dea1e3394c80" [[package]] name = "backtrace" -version = "0.3.69" +version = "0.3.71" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2089b7e3f35b9dd2d0ed921ead4f6d318c27680d4a5bd167b3ee120edb105837" +checksum = "26b05800d2e817c8b3b4b54abd461726265fa9789ae34330622f2db9ee696f9d" dependencies = [ "addr2line", "cc", @@ -181,9 +181,9 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" [[package]] name = "chrono" -version = "0.4.35" +version = "0.4.37" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8eaf5903dcbc0a39312feb77df2ff4c76387d591b9fc7b04a238dcf8bb62639a" +checksum = "8a0d04d43504c61aa6c7531f1871dd0d418d91130162063b789da00fd7057a5e" dependencies = [ "android-tzdata", "iana-time-zone", @@ -215,9 +215,9 @@ dependencies = [ [[package]] name = "clap" -version = "4.5.3" +version = "4.5.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "949626d00e063efc93b6dca932419ceb5432f99769911c0b995f7e884c778813" +checksum = "90bc066a67923782aa8515dbaea16946c5bcc5addbd668bb80af688e53e548a0" dependencies = [ "clap_builder", "clap_derive", @@ -237,14 +237,14 @@ dependencies = [ [[package]] name = "clap_derive" -version = "4.5.3" +version = "4.5.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "90239a040c80f5e14809ca132ddc4176ab33d5e17e49691793296e3fcb34d72f" +checksum = "528131438037fd55894f62d6e9f068b8f45ac57ffa77517819645d10aed04f64" dependencies = [ "heck 0.5.0", "proc-macro2", "quote", - "syn 2.0.53", + "syn 2.0.55", ] [[package]] @@ -339,7 +339,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ad291aa74992b9b7a7e88c38acbbf6ad7e107f1d90ee8775b7bc1fc3394f485c" dependencies = [ "quote", - "syn 2.0.53", + "syn 2.0.55", ] [[package]] @@ -582,9 +582,9 @@ dependencies = [ [[package]] name = "indexmap" -version = "2.2.5" +version = "2.2.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7b0b929d511467233429c45a44ac1dcaa21ba0f5ba11e4879e6ed28ddb4f9df4" +checksum = "168fb715dda47215e360912c096649d23d58bf392ac62f73919e831745e40f26" dependencies = [ "equivalent", "hashbrown", @@ -593,15 +593,14 @@ dependencies = [ [[package]] name = "insta" -version = "1.36.1" +version = "1.38.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0a7c22c4d34ef4788c351e971c52bfdfe7ea2766f8c5466bc175dd46e52ac22e" +checksum = "3eab73f58e59ca6526037208f0e98851159ec1633cf17b6cd2e1f2c3fd5d53cc" dependencies = [ "console", "lazy_static", "linked-hash-map", "similar", - "yaml-rust", ] [[package]] @@ -632,9 +631,9 @@ dependencies = [ [[package]] name = "itoa" -version = "1.0.10" +version = "1.0.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b1a46d1a171d865aa5f83f92695765caa047a9b4cbae2cbf37dbd613a793fd4c" +checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b" [[package]] name = "js-sys" @@ -688,9 +687,9 @@ checksum = "90ed8c1e510134f979dbc4f070f87d4313098b704861a105fe34231c70a3901c" [[package]] name = "memchr" -version = "2.7.1" +version = "2.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "523dc4f511e55ab87b694dc30d0f820d60906ef06413f93d4d7a1385599cc149" +checksum = "6c8640c5d730cb13ebd907d8d04b52f55ac9a2eec55b440c8892f40d56c76c1d" [[package]] name = "miette" @@ -721,7 +720,7 @@ checksum = "49e7bc1560b95a3c4a25d03de42fe76ca718ab92d1a22a55b9b4cf67b3ae635c" dependencies = [ "proc-macro2", "quote", - "syn 2.0.53", + "syn 2.0.55", ] [[package]] @@ -831,7 +830,7 @@ dependencies = [ "pest_meta", "proc-macro2", "quote", - "syn 2.0.53", + "syn 2.0.55", ] [[package]] @@ -969,9 +968,9 @@ dependencies = [ [[package]] name = "regex" -version = "1.10.3" +version = "1.10.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b62dbe01f0b06f9d8dc7d49e05a0785f153b00b2c227856282f671e0318c9b15" +checksum = "c117dbdfde9c8308975b6a18d71f3f385c89461f7b3fb054288ecf2a2058ba4c" dependencies = [ "aho-corasick", "memchr", @@ -992,9 +991,9 @@ dependencies = [ [[package]] name = "regex-syntax" -version = "0.8.2" +version = "0.8.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c08c74e62047bb2de4ff487b251e4a92e24f48745648451635cec7d591162d9f" +checksum = "adad44e29e4c806119491a7f06f03de4d1af22c3a680dd47f1e6e179439d1f56" [[package]] name = "rustc-demangle" @@ -1040,14 +1039,14 @@ checksum = "7eb0b34b42edc17f6b7cac84a52a1c5f0e1bb2227e997ca9011ea3dd34e8610b" dependencies = [ "proc-macro2", "quote", - "syn 2.0.53", + "syn 2.0.55", ] [[package]] name = "serde_json" -version = "1.0.114" +version = "1.0.115" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c5f09b1bd632ef549eaa9f60a1f8de742bdbc698e6cee2095fc84dde5f549ae0" +checksum = "12dc5c46daa8e9fdf4f5e71b6cf9a53f2487da0e86e55808e2d35539666497dd" dependencies = [ "itoa", "ryu", @@ -1073,9 +1072,9 @@ checksum = "45bb67a18fa91266cc7807181f62f9178a6873bfad7dc788c42e6430db40184f" [[package]] name = "similar" -version = "2.4.0" +version = "2.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "32fea41aca09ee824cc9724996433064c89f7777e60762749a4170a14abbfa21" +checksum = "fa42c91313f1d05da9b26f267f931cf178d4aba455b4c4622dd7355eb80c6640" [[package]] name = "siphasher" @@ -1124,7 +1123,7 @@ dependencies = [ "proc-macro2", "quote", "rustversion", - "syn 2.0.53", + "syn 2.0.55", ] [[package]] @@ -1168,9 +1167,9 @@ dependencies = [ [[package]] name = "syn" -version = "2.0.53" +version = "2.0.55" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7383cd0e49fff4b6b90ca5670bfd3e9d6a733b3f90c686605aa7eec8c4996032" +checksum = "002a1b3dbf967edfafc32655d0f377ab0bb7b994aa1d32c8cc7e9b8bf3ebb8f0" dependencies = [ "proc-macro2", "quote", @@ -1243,7 +1242,7 @@ checksum = "c61f3ba182994efc43764a46c018c347bc492c79f024e705f46567b418f6d4f7" dependencies = [ "proc-macro2", "quote", - "syn 2.0.53", + "syn 2.0.55", ] [[package]] @@ -1432,7 +1431,7 @@ dependencies = [ "once_cell", "proc-macro2", "quote", - "syn 2.0.53", + "syn 2.0.55", "wasm-bindgen-shared", ] @@ -1454,7 +1453,7 @@ checksum = "e94f17b526d0a461a191c78ea52bbce64071ed5c04c9ffe424dcb38f74171bb7" dependencies = [ "proc-macro2", "quote", - "syn 2.0.53", + "syn 2.0.55", "wasm-bindgen-backend", "wasm-bindgen-shared", ] @@ -1582,12 +1581,3 @@ dependencies = [ "regex", "thiserror", ] - -[[package]] -name = "yaml-rust" -version = "0.4.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "56c1936c4cc7a1c9ab21a1ebb602eb942ba868cbd44a99cb7cdc5892335e1c85" -dependencies = [ - "linked-hash-map", -] diff --git a/cliff.toml b/cliff.toml index cfbfb91f..c3829f93 100644 --- a/cliff.toml +++ b/cliff.toml @@ -9,7 +9,6 @@ # 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 @@ -26,74 +25,93 @@ 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 }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.github.username | default(value=commit.author.name) }} - {%- endfor -%} - {% raw %}\n{% endraw %}\ - {%- for commit in commits %} - {%- if commit.scope -%} + | sort(attribute="scope") -%} + {% if commit.scope -%} + - {{self::commit(commit=commit)}}\ + {% endif -%} + {% endfor -%} + {% for commit in commits -%} + {% if commit.scope -%} {% else -%} - - {% if commit.breaking %} [**breaking**]{% endif %}\ - {{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.github.username | default(value=commit.author.name) }} + - {{self::commit(commit=commit)}}\ {% endif -%} {% endfor -%} -{% endfor %}\n +{% endfor %} +{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 -%} +### New Contributors +{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} + * @{{ contributor.username }} made their first contribution + {%- if contributor.pr_number %} in \ + [#{{ contributor.pr_number }}]($REPO/pull/{{ contributor.pr_number }}) + {% endif -%} +{% endfor %} +{% endif -%} +{% macro commit(commit) -%} +{% if commit.scope %}**({{commit.scope}})** {% endif -%} +{% if commit.breaking %}**breaking** {% endif -%} +{{ commit.message | split(pat="\n") | first | trim }} by \ +{% if commit.github.username %}[@{{commit.github.username}}](https://github.com/{{commit.github.username}})\ +{% else %}{{commit.author.name}}{% endif %} in \ +{% if commit.github.pr_number %}[#{{ commit.github.pr_number }}]($REPO/pull/{{ commit.github.pr_number }})\ +{% else %}[{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})\ +{%- endif %} +{% endmacro commit -%} """ # template for the changelog footer footer = """ """ -# remove the leading and trailing s +# remove the leading and trailing whitespace from the template trim = true postprocessors = [ - { pattern = '\$REPO', replace = "https://github.com/jdx/mise" }, + { pattern = '\$REPO', replace = "https://github.com/jdx/usage" }, ] [git] # parse the commits based on https://www.conventionalcommits.org conventional_commits = true # filter out the commits that are not conventional -filter_unconventional = 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 = [ - # Replace issue numbers - #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](/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 -' }, + # remove issue numbers from commits + #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" }, + # 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\\(deps\\)", skip = true }, - { 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 = "^chore: Release", skip = true }, - { message = "^chore|^ci", group = "โš™๏ธ Miscellaneous Tasks" }, - { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, - { message = "^revert", group = "โ—€๏ธ Revert" }, + { message = '^(chore|fix)\(deps\):', group = "๐Ÿ“ฆ๏ธ Dependency Updates", scope = "" }, + { 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\(pr\)', skip = true }, + { message = '^chore\(pull\)', skip = true }, + { message = '^chore: Release usage', skip = true }, + { message = '^chore|^ci', group = "โš™๏ธ Miscellaneous Tasks" }, + { body = '.*security', group = "๐Ÿ›ก๏ธ Security" }, + { message = '^revert', group = "โ—€๏ธ Revert" }, + { message = '.', group = "๐Ÿ” Other Changes" }, ] # 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 # regex for matching git tags -tag_pattern = 'v\d+\.\d+\.\d+' +tag_pattern = '^v\d+\.\d+\.\d+$' # regex for skipping tags -skip_tags = '^v(1|2023)\.' +skip_tags = '^v0.1.5$' # regex for ignoring tags # ignore_tags = "" # sort the tags topologically