Releases: orhun/git-cliff
Releases · orhun/git-cliff
Release v2.10.0
2.10.0 - 2025-07-27
⛰️ Features
- (config) Support using include and exclude paths in the config (#1173) - (7c2f922)
- (parser) Support regex matching on JSON arrays with scalar elements (#1163) - (dc458ea)
- (template) Support adding commit statistics to the changelog (#1151) - (05a50d7)
🐛 Bug Fixes
- (config) [breaking] Use empty header and footer as default (#1161) (#1172) - (3e9311e)
- (config) Check if commit.footers is defined in detailed example (#1170) - (078545f)
- (fixtures) Update expected.md after config change (#1176) - (76d3e81)
- (generation) Ensure skip_tags condition is evaluated first (#1190) - (318be66)
- (repo) Use the correct order while diffing paths (#1188) - (ff6c310)
🚜 Refactor
- (ci) Apply security best practices (#1180) - (a32deca)
- (config) Implement FromStr instead of Config::parse_from_str() (#1185) - (692345e)
- (test) Standardize unit tests for commit module (#1147) - (0446d6a)
📚 Documentation
- (context) Add example usage for statistics (#1162) - (4f7379a)
- (quickstart) Remove repetitive words (#1200) - (434f9ee)
- (readme) Fix twitter badge (#1164) - (68bd85e)
- (readme) Polish badges (#1159) - (941cc2b)
- (remote) Fix inconsistency in remote integration documentation (#1165) - (deb29dc)
- (website) Add highlights for 2.10.0 (#1225) - (a3fe8c9)
- (website) Add installation instructions for gentoo-linux (#1203) - (07fe6bf)
🎨 Styling
🧪 Testing
⚙️ Miscellaneous Tasks
- (build) Bump MSRV to 1.85.1 - (d8279d4)
- (cd) Use macos-15 runner - (c156fc5)
- (cd) Re-enable sccache for maturin - (871c3c9)
- (crate) Remove Rust nightly requirement - (4f3e5af)
- (fixture) Update test-regex-json-array fixture (#1178) - (95f4056)
- (format) Format module imports for readability (#1183) - (6db7d49)
- (git) Add .git-blame-ignore-revs - (5b64131)
- (npm) Bump git-cliff to 2.9.1 (#1156) - (e13b158)
- (website) Update the node version - (566c2a1)
New Contributors ❤️
- @Nick2bad4u made their first contribution in #1180
- @aspann made their first contribution in #1203
- @muzimuzhi made their first contribution in #1200
- @j-g00da made their first contribution in #1188
- @Kriskras99 made their first contribution in #1173
- @wetneb made their first contribution in #1165
- @gmeligio made their first contribution in #1170
- @LitoMore made their first contribution in #1164
Pre-release v2.10.0-rc.0
Release v2.10.0-rc.0 Bug Fixes - Check if commit.footers is defined in detailed example (#1170) (078545f) - (breaking) Use empty header and footer as default (#1161) (#1172) (3e9311e) - Update expected.md after config change (#1176) (76d3e81) - Use the correct order while diffing paths (#1188) (ff6c310) - Ensure skip_tags condition is evaluated first (#1190) (318be66) Documentation - Polish badges (#1159) (941cc2b) - Fix twitter badge (#1164) (68bd85e) - Fix inconsistency in remote integration documentation (#1165) (deb29dc) - Add example usage for statistics (#1162) (4f7379a) - Remove repetitive words (#1200) (434f9ee) - Add installation instructions for gentoo-linux (#1203) (07fe6bf) - Add highlights for 2.10.0 (#1225) (a3fe8c9) Features - Support regex matching on JSON arrays with scalar elements (#1163) (dc458ea) - Support using include and exclude paths in the config (#1173) (7c2f922) - Support adding commit statistics to the changelog (#1151) (05a50d7) Miscellaneous Tasks - Bump git-cliff to 2.9.1 (#1156) (e13b158) - Re-enable sccache for maturin (871c3c9) - Update test-regex-json-array fixture (#1178) (95f4056) - Format module imports for readability (#1183) (6db7d49) - Use macos-15 runner (c156fc5) - Update the node version (566c2a1) - Remove Rust nightly requirement (4f3e5af) - Bump MSRV to 1.85.1 (d8279d4) - Add .git-blame-ignore-revs (5b64131) Refactor - Standardize unit tests for commit module (#1147) (0446d6a) - Resolve mismatched lifetime syntax warnings (#1167) (9970402) - Implement FromStr instead of Config::parse_from_str() (#1185) (692345e) - Apply security best practices (#1180) (a32deca) Styling - Use spaces instead of tabs (#1184) (0027300) Testing - Add test fixture for overriding the conventional scope (#1166) (cb84a08)
Release v2.9.1
Release v2.9.0
2.9.0 - 2025-06-02
⛰️ Features
- (changelog) Support recursing into submodules (#1082) - (4a3c0c0)
- (config) Support configuring with a remote URL (#1083) - (eb9b6bd)
- (config) Add
require_conventional
option (#1061) - (bf50336) - (context) Add release commit range (#1138) - (3dab0d1)
- (git) Support disabling sorting commits topologically (#804) (#1121) - (c3e25c3)
- (remote) Fetch commits from non-default branches using remotes (#1086) - (aec41be)
🐛 Bug Fixes
- (bump) Check the next version against tag_pattern regex (#1070) - (c4f0d28)
- (bump) Accept lowercase values for bump_type config (#1101) - (77632b2)
- (deps) Make glob dependency mandatory (#1035) - (0f653bf)
- (fixtures) Evaluate the rc of git-cliff correctly (#1104) - (fa54a6a)
- (fixtures) Use the correct syntax while checking fixture results (#1099) - (51af66e)
- (git) Handle worktrees while retrieving the path of repository (#1054) - (fab02b0)
- (remote) Fix detection of GitLab merge request sha if commits were squashed (#1043) - (5f3a3d0)
- (submodules) Fix submodules handling when using custom range (#1136) - (451a694)
- (template) Correctly serialize JSON for the commit fields (#1145) - (e981e1d)
🚜 Refactor
- (config) Initialize config structs with default values (#1090) - (9e4bd07)
- (lint) Apply clippy suggestions - (4d3b2d5)
- (lint) Use IOError::other (#1074) - (30e8193)
📚 Documentation
- (config) Fix typo on commit.links (#1132) - (cbeca6d)
- (config) Update comments for all configuration options (#1057) - (63129ce)
- (quickstart) Clarify git-cliff command (#1051) - (cd26bb2)
- (readme) Add blog posts from the community (#1102) - (f302e43)
- (release) Fix Docker Hub URL - (9babe06)
- (security) Extend security policy (#1142) - (4c3c946)
- (website) Add highlights for 2.9.0 (#1153) - (d7f9cf5)
- (website) Remove references of tj-actions (#1097) - (729aa47)
⚙️ Miscellaneous Tasks
- (dependabot) Make dependency updates less noisy - (cdce20f)
- (dependabot) Check dependency updates weekly - (b8be055)
- (docs) Fix some typos (#1149) - (7148b2d)
- (project) Migrate to Rust 2024 edition (#1128) - (4445f06)
New Contributors ❤️
- @vardbabayan made their first contribution in #1149
- @ognis1205 made their first contribution in #1145
- @janderssonse made their first contribution in #1142
- @jdrst made their first contribution in #1138
- @lehmanju made their first contribution in #1136
- @Jean-Beru made their first contribution in #1132
- @william-stacken made their first contribution in #1086
- @SebClapie made their first contribution in #1121
- @okydk made their first contribution in #1051
Release v2.8.0
2.8.0 - 2025-01-24
⛰️ Features
- (cli) Support initializing config with a custom filename (#992) - (76bf9cf)
- (config) Discover the configuration file when run in a sub directory - (a23eeb4)
- (git) Improve the set commit range error (#990) - (f29e815)
- (monorepo) Automatically set include-path for current directory - (ceda1f7)
- (remote) Support enabling native TLS (#1021) - (fe7c464)
- (repo) Allow running from sub directories (#975) - (98453b3)
🐛 Bug Fixes
- (config) Allow environment overwrites when using builtin config (#961) - (7ba3b55)
- (docker) Use the correct Debian runner - (36ad993)
- (fixtures) Update the arguments for custom GitLab API fixture test - (e522f8d)
- (monorepo) Do not set include-path if workdir is set (#1022) - (20483be)
- (remote) Fix detection of GitLab merge request sha (#968) - (1297655)
🚜 Refactor
- (lib) Add changelog modifier callback to run function (#922) - (2321882)
- (lint) Use a shared lint config for the workspace - (bfc1d4f)
- (lint) Apply clippy suggestions - (299a1c7)
📚 Documentation
- (docker) Fix typo in comment (#959) - (dbda091)
- (highlights) Add link to the Nix flake - (c449229)
- (jujutsu) Update links to the upstream documentation - (ed6b646)
- (lib) Allow doc lint - (62a6d3e)
- (license) Update copyright years - (8178c9b)
- (tips) Extend the merge commit filter example (#963) - (09c0f90)
- (website) Add highlights for 2.8.0 (#1023) - (32dc15e)
🧪 Testing
- (fixture) Add fixture for include-path - (e85888f)
⚙️ Miscellaneous Tasks
- (build) Bump MSRV to 1.83.0 - (37598c2)
- (docker) Bump the Rust version in Docker image - (729f433)
- (funding) Add wellKnown directory - (8704518)
- (lint) Allow false positive lint - (1b779a6)
- (nix) Update flakes - (22fbe9d)
New Contributors ❤️
- @xsadia made their first contribution in #992
- @chenrui333 made their first contribution in #1002
- @hackenbergstefan made their first contribution in #968
- @paul-uz made their first contribution in #963
- @jmartens made their first contribution in #959
Release v2.7.0
2.7.0 - 2024-11-20
⛰️ Features
- (args) Add color to the help text (#897) - (f423484)
- (ci) Add Nix CI (#939) - (d0848ff)
- (config) Allow overriding the remote API URL via config (#896) - (6d86e2c)
- (docker) Build arm64 images again (#879) (#919) - (84771f6)
- (jujutsu) Add jujustu support (#930) - (ab95626)
- (nix) Add a basic Nix environment (#918) - (6b17736)
- (website) Add user testimonials (#895) - (ef2374c)
🐛 Bug Fixes
- (bitbucket) Match PR and release metadata correctly (#907) - (e936ed5)
- (changelog) Fix missing commit fields in context (#837) (#920) - (f8641ee)
- (changelog) Include the root commit when
--latest
is used with one tag (#901) - (508a97e) - (remote) Preserve first time contributors (#925) - (99b78b5)
📚 Documentation
- (git) Improve docs for commit_preprocessors and commit_parsers (#928) - (c1f1215)
- (readme) Add blog post about git-cliff - (82b10ac)
- (website) Add highlights for 2.7.0 (#955) - (b6b5449)
- (website) Add more testimonials - (bfe9beb)
- (website) Update sourcehut (#894) - (bcc32ca)
⚡ Performance
🧪 Testing
- (git) Find upstream remote when using ssh (#926) - (2e65a72)
- (repo) Expand unit tests of the repo module (#909) - (da1cb61)
⚙️ Miscellaneous Tasks
- (config) Add the 'other' parser to the default config - (12cb1df)
- (docker) Upgrade Rust and libc version in Dockerfile - (8bd0607)
- (docker) Bump the Rust version in Docker image - (c28121c)
- (integration) Remove experimental feature disclaimer - (237c327)
- (log) Add trace log about which command is being run - (a9b2690)
- (nix) Update flakes - (7654e67)
- (website) Add new testimonials - (0c207d6)
◀️ Revert
- (docker) Bump the Rust version in Docker image - (fc142e4)
New Contributors ❤️
- @pauliyobo made their first contribution in #896
- @blackheaven made their first contribution in #939
- @Muhammad-Owais-Warsi made their first contribution in #928
- @kemitix made their first contribution in #930
- @mcwarman made their first contribution in #925
- @LtdSauce made their first contribution in #919
- @dqkqd made their first contribution in #920
- @gsquire made their first contribution in #909
- @rarescosma made their first contribution in #901
- @vsn4ik made their first contribution in #894
Release v2.6.1
2.6.1 - 2024-09-27
🐛 Bug Fixes
- (npm) Add missing
--use-branch-tags
flag to TS options (#874) - (e21fb1d) - (remote) Avoid setting multiple remotes (#885) - (a344c68)
📚 Documentation
- (website) Add conversion to pdf to tips-and-tricks (#889) - (58dc108)
- (website) Add get_env filter example for GitLab CI - (dfe4459)
⚙️ Miscellaneous Tasks
- (ci) Update pedantic lint command (#890) - (8d10edb)
- (docker) Disable building arm64 docker images temporarily (#879) - (cde2a8e)
- (fixtures) Build binaries using dev profile (#886) - (a394f88)
New Contributors ❤️
Release v2.6.0
2.6.0 - 2024-09-22
⛰️ Features
- (changelog) Support generating changelog for different branches (#808) - (2a581a8)
- (config) Add changelog.render_always option (#859) - (ad039d5)
- (config) Allow configuring output file from config (#829) - (c2db791)
- (core) Add
remote
to commit and deprecate fields (#822) - (87e2c1d) - (npm) Add missing options and document all options with tsdoc comments - (2eae2f1)
- (npm) Add possibility for
skipCommit
to take an array of values - (a6e3b78)
🐛 Bug Fixes
- (args) Support using use_branch_tags from both config and args (#848) - (35b7fd8)
- (bump) Suppress template warning when
--bumped-version
is used (#855) - (8bebbf9) - (changelog) Do not change the tag date if tag already exists (#861) - (fbb643b)
- (changelog) Correctly set the tag message for the latest release (#854) - (e41e8dd)
- (changelog) Don't change the context when provided via
--from-context
(#820) - (ff72406) - (commit) Trim the trailing newline for git2 commits (#872) - (1cdbbf6)
- (core) Avoid the unnecessary loop when no remote feature is activated - (1d8a2fe)
- (template) Resolve parsing issues with
raw
/endraw
in Jinja (#824) - (63bf5b7)
🚜 Refactor
- (template) [breaking] Add name parameter to the constructor - (e577113)
📚 Documentation
- (args) Fix copy-paste mistake where gitea mentioned gitlab - (c41eacb)
- (contributing) Mention fetching the tags for running tests successfully (#850) - (a82dac3)
- (website) Add highlights for 2.6.0 (#873) - (050fb55)
- (website) Clarify comment about tag argument - (e56cd8d)
⚙️ Miscellaneous Tasks
- (ci) Check pedantic lints (#853) - (c77420c)
- (examples) Improve example templates (#835) - (08e761c)
- (lib) Fix typos in code comments - (81854d2)
- (npm) Bump dev dependencies - (61b86f1)
New Contributors ❤️
- @nejcgalof made their first contribution in #853
- @pplmx made their first contribution in #824
Release v2.5.0
2.5.0 - 2024-08-24
⛰️ Features
- (args) Allow GitLab groups with
--gitlab-repo
(#807) - (6fbfdb5) - (bump) Support bumping to a specific semver type (#744) - (9dbf47b)
- (changelog) Support count_tags option (#599) - (b8045e9)
- (changelog) Skip ssh and x509 signatures in tag messages (#748) - (ecbabbf)
- (cli) Generate changelog from JSON context (#784) - (3b6156d)
- (parser) Allow whole commit context to be used in commit parsers (#758) - (ccf2ab7)
- (profiler) Support performance profiling via pprof (#768) - (35dc1e4)
- (remote) Activate integration if remote is set manually (#782) - (4b33e7e)
🐛 Bug Fixes
- (changelog) Allow using
--bumped-version
without conventional commits (#806) - (e74080c) - (config) Allow using environment variables without config file present (#783) - (2471745)
- (fixture) Fix fetching repository for gitlab integration test - (72847c6)
- (gitlab) URL-encode the owner in remote requests for GitLab (#742) - (e3e7c07)
- (template) Include for-loop arguments in template variables (#812) - (9a6430b)
🚜 Refactor
- (config) Make example templates more user-friendly - (6f8ea19)
- (gitlab) Clean up url encoding for GitLab - (c791418)
- (lib) Clean up some code (#709) - (4b0c0eb)
📚 Documentation
- (config) Fix typo in comment of default config file (#776) - (e2fb043)
- (readme) Remove underscored spaces between badges (#809) - (1956c83)
- (readme) Add git-changelog to similar projects section (#774) - (c208a97)
- (readme) Add KaiCode Open Source Festival link - (58b729c)
- (website) Add highlights for 2.5.0 (#815) - (49df8cb)
- (website) Clarify authentication with GitHub token (#787) - (85bfa95)
- (website) Correct inverted consequences of configuration value (#760) - (dc144dd)
- (website) Add header to 2.4.0 blog post - (227a307)
⚡ Performance
⚙️ Miscellaneous Tasks
- (cd) Remove unnecessary git-cliff-action output file (#738) - (9f39bcb)
- (config) Include new contributors in repository changelog - (5474978)
- (config) Check for null commit_id in detailed template (#786) - (388b007)
- (config) Fix comment for changelog header template - (35b886e)
- (config) Update keepachangelog.toml comment (#779) - (f9e500e)
- (website) Remove v2 announcement - (a71649b)
- (website) Add discord button to navbar - (565b9c8)
New Contributors ❤️
- @weichweich made their first contribution in #807
- @janbuchar made their first contribution in #784
- @oberrich made their first contribution in #809
- @tisonkun made their first contribution in #599
- @DerTiedemann made their first contribution in #758
- @DaniPopes made their first contribution in #709
- @artrz made their first contribution in #779
- @braineo made their first contribution in #744
- @myl7 made their first contribution in #776
- @pawamoy made their first contribution in #774
- @tonybutt made their first contribution in #742
- @PigeonF made their first contribution in #748
Release v2.4.0
2.4.0 - 2024-06-26
⛰️ Features
- (args) Add
--ignore-tags
argument (#696) - (94891c2) - (bump) Support bumping based on configurable custom pattern (#725) - (8e03356)
- (bump) Support setting the
initial_tag
(#701) - (7341500) - (changelog) Add tag message to release context (#713) - (3eb828e)
- (changelog) Make
changelog.header
a template (#698) - (9fc12bb) - (changelog) Support parsing commits by footer (#569) - (50c240c)
- (changelog) Make remote data available in context (#703) - (d14774a)
- (codeberg) Add Gitea support (#680) - (403d3dc)
- (context) Add repository path to template context (#721) - (e7807e1)
🐛 Bug Fixes
- (fixture) Support running fixtures on mingw64 (#708) - (dabe716)
- (website) Update dependencies to fix search issue - (8a9f9f4)
🚜 Refactor
- (bump) Add documentation and simplify implementation - (bea4916)
📚 Documentation
- (website) Add highlights for 2.4.0 (#729) - (5558cc5)
- (website) Add more context about
ignore_tags
matching commits (#710) - (854b411) - (website) Fix link to github-keepachangelog template (#694) - (eac2195)
- (website) Add information about
--bump
withtag prefixes
(#695) - (4cd18c2)