Changelog

Latest updates and improvements to git-cliff

2.8.0 #

24 Jan 2025

โ›ฐ๏ธ Features
๐Ÿ› Bug Fixes
๐Ÿšœ Refactor
๐Ÿ“š Documentation
๐Ÿงช Testing
โš™๏ธ Miscellaneous Tasks

โ›ฐ๏ธ 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

2.7.0 #

20 Nov 2024

โ›ฐ๏ธ Features
๐Ÿ› Bug Fixes
๐Ÿ“š Documentation
โšก Performance
๐Ÿงช Testing
โš™๏ธ Miscellaneous Tasks
โ—€๏ธ Revert

โ›ฐ๏ธ Features

๐Ÿ› 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

  • (test) Don't create regex inside a loop (#937) - (0fabf22)

๐Ÿงช 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

2.6.1 #

27 Sep 2024

๐Ÿ› Bug Fixes
๐Ÿ“š Documentation
โš™๏ธ Miscellaneous Tasks

๐Ÿ› 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)

2.6.0 #

22 Sep 2024

โ›ฐ๏ธ Features
๐Ÿ› Bug Fixes
๐Ÿšœ Refactor
๐Ÿ“š Documentation
โš™๏ธ Miscellaneous Tasks

โ›ฐ๏ธ 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)

2.5.0 #

24 Aug 2024

โ›ฐ๏ธ Features
๐Ÿ› Bug Fixes
๐Ÿšœ Refactor
๐Ÿ“š Documentation
โšก Performance
โš™๏ธ Miscellaneous Tasks

โ›ฐ๏ธ 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

  • (changelog) Cache commit retain checks (258 times faster generation) (#772) - (8430c5c)

โš™๏ธ 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