CHANGELOG.md

2.2.2 - 2024-05-11

⛰️ Features

• (changelog) Allow adding custom context (#613) - (522bd53)

🐛 Bug Fixes

• (changelog) Ignore empty lines when using split_commits (#608) - (b8fb852)
• (parser) Allow matching empty commit body (#605) - (1d1b3b8)

📚 Documentation

• (readme) Add social media badges - (d53b905)
• (website) Add note about supported platforms for NPM - (4e4d7cd)
• (website) Add SourceHut builds example (#617) - (f636cfc)

⚙️ Miscellaneous Tasks

• (npm) Add minimum supported Node versions (#621) - (95bdf2d)
• (npm) Update yarn.lock - (adc5c5b)
• (pypi) Disable PyPi builds for x86_64-pc-windows-gnu - (f675b0b)
• (tests) Don't check last commit (#619) - (68b9839)

2.2.1 - 2024-04-10

🐛 Bug Fixes

• (npm) Include the proper files in the npm tarball (#594) - (800c896)

📚 Documentation

• (readme) Mention git-changelog-command-line tool (#589) - (d65b443)
• (website) Add GITHUB_REPO variable to GitHub action (#597) - (3b74254)
• (website) Update release date - (45132da)

⚙️ Miscellaneous Tasks

• (ci) Remove audit check - (6ba6809)

2.2.0 - 2024-03-30

⛰️ Features

• (changelog) Make rendering errors more verbose - (7ee3c86)
• (config) Support detecting config from project manifest (#571) - (9eb3d65)
• (release) Make the bump version rules configurable (#530) - (152414c)

🐛 Bug Fixes

• (changelog) Update the commit processing order (#556) - (c5ef9ab)
• (changelog) Return the last version if there is nothing to bump - (45c87f2)
• (command) Add missing environment variables for Windows (#532) - (9722784)
• (commit) Trim the text before matching with commit parser (#573) - (4971b23)
• (config) Drop extra '(' in first commit URL in github-keepachangelog (#535) - (8b3d09f)
• (npm) Fix authenticating for yarn npm publish (#574) - (5a0ce6a)
• (release) Fix typo in the installation of typos-cli (#545) - (700281a)

📚 Documentation

• (website) Add highlights for 2.2.0 (#575) - (2e81ad0)
• (website) Fix the documentation for --include-path (#567) - (4a7aa7e)
• (website) Update setup-git-cliff action documentation - (4f46396)
• (website) Add documentation for taiki-e/install-action (#563) - (85db777)

⚙️ Miscellaneous Tasks

• (ci) Temporarily disable semver checks - (f26fbe0)
• (ci) Comment on pull requests about semver checks - (ccdc152)
• (config) Skip clippy commits in changelog - (830528c)
• (github) Remove cname - (679aa46)
• (github) Update funding options - (4bedf76)
• (github) Use form based issue templates (#529) - (8f8e221)
• (npm) Publish rc version for prereleases (#528) - (16bea51)
• (pypi) Update maturin version (#539) - (10b7ab8)
• (website) Allow deploying website manually - (0b64bc0)
• (website) Only deploy website when there is a new release - (8651832)

2.1.2 - 2024-03-03

⛰️ Features

• (args) Add --tag-pattern argument (#526) - (b4e7a34)
• (npm) Add programmatic API for TypeScript (#523) - (8b33267)

🐛 Bug Fixes

• (cd) Set the correct GitHub repository URL - (7f379a9)
• (cd) Set a flag as a workaround for the NPM package - (717abce)
• (cd) Set node version to 18 for building NPM packages - (5dd0d2e)
• (cd) Explicitly set the Homebrew formula path - (8d2f1fa)
• (cd) Set the GitHub repository explicitly - (0e46500)
• (config) Fix commit parser regex in the default config - (110b9b8)
• (github) Sanitize the GitHub token in debug logs - (be34949)

🚜 Refactor

• (cd) Simplify checking pre-releases - (87a04fb)
• (changelog) Do not output to stdout when prepend is used - (8ee0da1)

📚 Documentation

• (website) Add tip about skipping commits by PR label - (6d3354c)
• (website) Add instructions for installing from WinGet (#520) - (eeaa406)

🎨 Styling

• (website) Use a short link for reporting issues - (ba83c8a)

⚙️ Miscellaneous Tasks

• (ci) Auto-bump the homebrew formula - (61d055b)
• (ci) Enable default features for windows builds - (18f4923)
• (ci) Check semver violations via CI - (a25a114)
• (fixtures) Enable verbose logging for output - (2927231)

2.0.4 - 2024-02-22

⛰️ Features

• (docker) Enable github feature for the docker image - (bc882e3)
• (github) Support overriding the GitHub API URL (#512) - (8199699)

🐛 Bug Fixes

• (cd) Do not execute commands for the release changelog - (1aaa9b2)

📚 Documentation

• (website) Add instructions for installing from conda-forge (#511) - (75a04bb)

⚙️ Miscellaneous Tasks

• (config) Add animation to the header of the changelog - (4f741a7)
• (website) Bump the version of git-cliff-action - (f255ad3)
• (website) Add announcement bar for the new release - (1d32a14)

2.0.2 - 2024-02-19

📚 Documentation

• (release) Add note about GitHub variables - (54e21de)

2.0.1 - 2024-02-19

⚙️ Miscellaneous Tasks

• (cd) Disable PyPI builds for linux-x86-glibc - (30d8e41)

2.0.0 - 2024-02-19

⛰️ Features

• (args) Add --no-exec flag for skipping command execution (#458) - (7ae77ff)
• (args) Add -x short argument for --context - (327512a)
• (args) Support initialization with built-in templates (#370) - (4bee628)
• (args) Allow returning the bumped version (#362) - (5e01e4c)
• (args) Set CHANGELOG.md as default missing value for output option (#354) - (04d149e)
• (changelog) Set the timestamp of the previous release - (d408e63)
• (changelog) Improve skipping via .cliffignore and --skip-commit (#413) - (faa00c6)
• (changelog) Support tag prefixes with --bump (#347) - (2399e57)
• (changelog) [breaking] Set tag to 0.0.1 via --bump if no tags exist - (3291eb9)
• (changelog) [breaking] Support templating in the footer (#369) - (0945fa8)
• (commit) Add merge_commit flag to the context (#389) - (dd27a9a)
• (github) [breaking] Support integration with GitHub repos (#363) - (5238326)
• (parser) Support using SHA1 of the commit (#385) - (1039f85)
• (parser) Support using regex scope values (#372) - (19e65c2)
• (template) Support using PR labels in the GitHub template (#467) - (30d15bb)
• (template) Support using PR title in the GitHub template (#418) - (6f32f33)
• (website) Add search bar to the website - (2d30491)

🐛 Bug Fixes

• (cd) Use workaround for linux-arm64-glibc maturin builds - (dc79ed5)
• (cd) Disable PyPI publish for linux-arm64-glibc - (e24af12)
• (cd) Avoid creating artifacts with the same name - (1647fd8)
• (cd) Fix embedding examples for crates.io release - (46b7d88)
• (changelog) Fix previous version links (#364) - (44c93b7)
• (changelog) Set the correct previous tag when a custom tag is given - (6203f77)
• (ci) Update cargo-msrv arguments - (131dd10)
• (cli) Fix broken pipe when stdout is interrupted (#407) - (bdce4b5)
• (commit) Trim the trailing newline from message (#403) - (514ca4b)
• (git) Sort commits in topological order (#415) - (29bf355)
• (links) Skip checking the GitHub commit URLs - (273d6dc)
• (website) Use node version 18 - (46dcce3)
• (website) Use prism-react-renderer v2 with docusaurus - (664ff9b)
• Allow version bump with a single previous release - (d65aec9)

🚜 Refactor

• (changelog) Support --bump for processed releases (#408) - (89e4c72)
• (ci) Use hardcoded workspace members for cargo-msrv command - (ec6035a)
• (ci) Simplify cargo-msrv installation - (f04bf6e)
• (config) Use postprocessors for checking the typos - (764e858)
• (config) Remove unnecessary newline from configs - (8edec7f)

📚 Documentation

• (configuration) Fix typo (#466) - (34a58e6)
• (fixtures) Add instructions for adding new fixtures - (8290769)
• (readme) Mention RustLab 2023 talk - (668a957)
• (readme) Use the raw link for the animation - (2c524b8)
• (security) Update security policy - (fcaa502)
• (website) Add highlights for 2.0.0 (#504) - (49684d0)
• (website) Improve matching gitmoji tip (#486) - (0731646)
• (website) Add tips and tricks section - (82e93c2)
• (website) Add tip about link parsers - (4bd47a6)
• (website) Add git-cliff animation to the website (#404) - (0561124)
• (website) Split the configuration section - (67486cc)
• (website) Add installation instructions for Homebrew (#357) - (b2f8091)

🎨 Styling

• (website) Add GitHub logo to the header - (1da7cac)
• (website) [breaking] Use dark theme as default - (dcc5116)

🧪 Testing

• (changelog) Use the correct version for missing tags - (0ca4cdb)
• (fixture) Update the date for example test fixture - (991a035)
• (fixture) Add test fixture for bumping version - (c94cb6a)
• (fixtures) Update the bumped value output to add prefix - (f635bae)

⚙️ Miscellaneous Tasks

• (changelog) Disable the default behavior of next-version (#343) - (4eef684)
• (changelog) Use 0.1.0 as default next release if no tag is found - (3123fd2)
• (command) Explicitly set the directory of command to current dir - (722efd6)
• (config) Skip dependabot commits for dev updates - (7f89160)
• (config) Revamp the configuration files - (9500bf8)
• (dependabot) Group the dependency updates for creating less PRs - (c6a92bf)
• (docker) Update versions in Dockerfile - (51198a5)
• (embed) Do not allow missing docs - (7754cab)
• (example) Use full links in GitHub templates (#503) - (a521891)
• (example) Remove limited commits example - (8e1e0d7)
• (github) Update templates about GitHub integration - (3f5107a)
• (mergify) Don't update PRs for the main branch - (96a220c)
• (project) Add readme to core package - (9e6bad2)
• (project) Bump MSRV to 1.74.1 - (bd5e4d2)
• (project) Update copyright years - (edc6bc0)
• (website) Fix URLs in navigation bar (#438) - (70cab99)
• (website) Rename the header for GitHub integration - (3fd9476)
• (website) Fix broken anchors - (34593dd)
• (website) Bump docusaurus to 3.1.0 - (af4482b)
• (website) Update the titles for distro installations - (ff2881b)
• (website) Add Mastodon link to the website - (2e761c9)

◀️ Revert

• (config) Use postprocessors for checking the typos - (5212cc9)

1.4.0 - 2023-10-29

⛰️ Features

• (changelog) Support bumping the semantic version via --bump (#309) - (bcfcd1f)
• (ci) Add 'typos' check (#317) - (88c34ab)
• (command) Log the output of failed external commands - (205cdbb)
• (config) [breaking] Support regex in 'tag_pattern' configuration (#318) - (3c2fb60)
• (config) Add field and value matchers to the commit parser (#312) - (04fbcb8)

📚 Documentation

• (blog) Fix the TOML format in 1.4.0 blog post - (4d691d2)
• (blog) Add blog post for 1.4.0 release - (e3f1b3b)
• (changelog) Fix typos (#316) - (edd3c30)
• (config) Update the comment for tag_pattern - (596fd4d)
• (core) Update the doc comment for commit preprocessors - (7faccc6)
• (image) Use images from the repository - (91c0cda)
• (lib) Extract feature documentation from Cargo.toml - (1f8098c)
• (lib) Add logo and favicon to docs.rs page - (32b1fe1)
• (readme) Add link to emacs package support git-cliff (#307) - (fa471c7)
• (website) Fix typos in configuration docs (#329) - (d863c94)
• (website) Add instructions for installing the latest git version - (be87608)

⚙️ Miscellaneous Tasks

• (ci) Update the link checker configuration (#315) - (32cbea8)
• (config) Update tag_pattern value for backwards compatibility - (2c621f7)
• (img) Add more images - (2792362)
• (img) Add git-cliff logo - (51f5e5b)
• (release) Update cargo-deb usage - (213f383)
• (website) Update the tracking link - (eb9f8e9)

1.3.1 - 2023-09-30

⛰️ Features

• (args) Support tilde for options (#266) - (8698bc2)
• (ci) Distribute RPM package (#159) - (baf4da8)

🐛 Bug Fixes

• (ci) Update cargo-tarpaulin arguments - (83a0371)

🚜 Refactor

• (ci) Simplify cargo-tarpaulin installation - (95f8d53)

📚 Documentation

• (installation) Update instructions for Arch Linux - (291a928)
• (installation) Add instructions for Alpine Linux - (3199bba)
• (license) Re-license under the MIT + Apache 2.0 license (#303) - (cd56344)
• Update Tera links to the new URL (#272) - (890de00)

⚙️ Miscellaneous Tasks

• Remove GPL code (#293) - (e3606ba)

◀️ Revert

• (args) Update clap and clap extras to v4 (#137) (#292) - (fb4c733)

1.3.0 - 2023-08-31

⛰️ Features

• (changelog) [breaking] Add postprocessors (#155) - (5dc5fb7)

🐛 Bug Fixes

• (cd) Do not publish release notes for pre-releases (#249) - (7a82aa1)
• (cd) Disable win32-arm64 PyPI builds - (baf34a8)
• (deps) Avoid problematic serde release - (87f74bc)
• (examples) Add missing newline (#253) - (aad4222)
• (informer) Do not inform about pre-releases (#249) - (87e47e6)
• Fix previous release references - (fbb605e)

🚜 Refactor

• (config) Use a macro for generating commit list - (c695ca3)
• (docker) Avoid copying volume inside container (#142) - (65d365c)
• (lib) Use implicit serde imports - (c8cf855)

📚 Documentation

• (blog) Add blog post for 1.3.0 release (#264) - (93d4aa4)
• (example) Update the header of configuration examples - (0bf5ebe)
• (example) Add example for generating changelog similar to cocogitto - (e1cf26e)
• (readme) Add contributors graph - (3c9ced0)

🎨 Styling

• (config) Further beautify the changelog in this repo - (fd7446c)
• (config) Apply formatting to configuration files - (e9aa991)
• Fix formatting - (14725e5)

🧪 Testing

• (changelog) Add cases for docs: prefix (#167) - (3a717e2)
• (repo) Add an informative error message to failing test - (7d7470b)
• Fix keep a changelog test case - (0a6ed62)
• Fix keep a changelog test case - (f5d3365)

⚙️ Miscellaneous Tasks

• (cargo) Update MSRV to 1.70.0 - (1068912)
• (cd) Use the latest git-cliff-action for releases - (3eb97b8)
• (cd) Support creating prereleases on GitHub - (a22426a)
• (config) Add additional parsers for default config - (b745778)
• (config) Update configuration for alpha/beta/rc releases - (7e7e5a7)
• (config) Skip dependency updates in the changelog - (b2edc23)
• (core) Make git2 optional - (5fdf39a)
• (docker) Update versions in Dockerfile - (0ccab91)
• (github) Add config for welcome bot - (a4725d4)
• (mergify) Rename mergify configuration file - (9fd1be6)
• (mergify) Add configuration file for automatic merge (#245) - (0a79aae)
• (pypi) Publish git-cliff on PyPI (#158) - (2b7a1ef)
• Check without default features - (e323621)

1.2.0 - 2023-04-28

⛰️ Features

• (args) Update clap and clap extras to v4 (#137) - (0e710c2)
• (commit) Make the fields of Signature public - (104aac9)
• (config) Add a custom configuration file for the repository - (0d4e689)
• (config) Support placing configuration inside pyproject.toml (#147) - (fe5e5b8)
• (docker) Generate SBOM/provenance for the Docker image - (2ef259e)
• (parser) Support using regex group values (#145) - (7767ace)

🐛 Bug Fixes

• (ci) Use MUSL build of cargo-tarpaulin - (98c9e00)
• (ci) Update cargo-tarpaulin installation command for CI - (3019eff)
• (config) [breaking] Nested environment config overrides (#157) - (bb9a889)
• (config) Set max of limit_commits to the number of commits (#140) - (06f6732)
• (deploy) Set the node cache dependency path - (020b02d)
• (docker) Remove target directory from .dockerignore - (c0f97bd)
• (release) Use the correct argument in release script - (b3eef4a)
• (website) Fix broken links - (77dda53)

🚜 Refactor

• (cd) Remove unnecessary config update - (e42f910)
• (ci) Test the website deployment with a different job - (2d72125)
• (lib) [breaking] Move changelog module to git-cliff-core - (2ab2c8f)
• (test) Handle errors for changelog module tests - (ed389b7)
• (website) Update header location - (72af8ac)

📚 Documentation

• (blog) Add blog post about what's new in 1.2.0 - (e0a29ef)
• (blog) Update the blog post style - (74cf47e)
• (config) Update the sections - (c402452)
• (config) Add comments to the default configuration file - (7e3adb0)
• (contributing) Mention the nightly requirement for rustfmt - (a5a78fc)
• (contributing) Update MSRV - (a824f48)
• (examples) Move examples to separate file - (db43437)
• (github) Update the pull request template about GitHub labels - (54f735a)
• (github) Update pull request template - (c261fad)
• (github) Update issue templates - (6a076ca)
• (github) Update funding options - (6e35834)
• (github) Add security policy - (823d272)
• (readme) Update README.md about documentation website - (56240fd)
• (readme) Add tj-actions/git-cliff to the list of actions (#152) - (2520dd2)
• (readme) Add discord badge - (9fa5dd4)
• (readme) Add release-plz to related projects (#151) - (f781e29)
• (readme) Fix typos in README.md - (38943e8)
• (readme) Remove unneeded word in README.md (#141) - (6f1459b)
• (readme) Add link to the Console #141 interview about git-cliff - (d057390)
• (website) Add Twitter link to banner - (ee5ea85)
• (website) Move documentation to the website (#153) - (56d3544)

🎨 Styling

• (docs) Fix the grammar for tj-actions - (53c0c1d)
• (docs) Update the formatting for python integration example - (3ee6724)
• (readme) Update the style for project name - (c41bbe0)
• (readme) Apply formatting - (a4290c7)
• (website) Update the style for environment variable section - (24ba433)

🧪 Testing

• (deploy) Test the website deployment for pull requests - (6f8a2f9)

⚙️ Miscellaneous Tasks

• (cargo) Update MSRV to 1.64.0 - (84f20f9)
• (cd) Temporarily switch back to action-rs/toolchain - (1f897e3)
• (ci) Switch to dtolnay/rust-toolchain action - (d54f72a)
• (ci) Update runner images - (07e7938)
• (docker) Update versions in Dockerfile - (95e8408)
• (docker) Bump the action versions in docker workflow - (c02538f)
• (docker) Bump build-push-action to v4 - (0c84ed8)
• (editorconfig) Fix editorconfig syntax - (e35d83d)
• (editorconfig) Update editorconfig for better code readability - (8a4f928)
• (examples) Remove EXAMPLES.md - (8038659)
• (github) Integrate Dependabot - (fe5a4dd)
• (github) Integrate bors - (1ab6f39)
• (github) Add contact links for issues - (d3cb25b)
• (website) Add workflow file for deploying the website - (f550458)
• (website) Move website to website folder - (5644d10)
• (website) Move website to docs for GitHub pages deployment - (b6e52e1)

1.1.2 - 2023-01-20

🐛 Bug Fixes

• (changelog) Allow saving context to a file (#138) - (08ea900)
• (changelog) Do not skip all tags when skip_tags is empty (#136) - (eee35ad)
• (git) Derive the tag order from commits instead of timestamp (#139) - (4df5656)

🎨 Styling

• (fmt) Update the derives in config module - (336b25f)

⚙️ Miscellaneous Tasks

• (cargo) Add metadata for cargo-binstall - (31dac34)
• (docker) Update versions in Dockerfile - (353ca62)

◀️ Revert

• (git) Use timestamp for deriving the tag order (#139) - (accfb0f)

1.1.1 - 2023-01-09

🐛 Bug Fixes

• (npm) Fix the type casting in base NPM package - (bc0807f)
• (npm) Fix the variable declaration for NPM package OS - (f40a565)
• (npm) Rename the NPM binary package for Windows - (ce1d468)

📚 Documentation

• (readme) Update README.md about the NPM package - (e0177c2)

⚙️ Miscellaneous Tasks

• (cd) Parallelize releasing on crates.io - (24c8e3e)
• (cd) Add README.md to the base NPM package - (e2e124e)
• (npm) Add more keywords to the base NPM package - (abe68a2)
• (npm) Package git-cliff for npm (#133) - (b7dd592)

1.1.0 - 2023-01-08

⛰️ Features

• (git) Support generating changelog for multiple git repositories (#13) - (8b17a1f)

🚜 Refactor

• (cd) Use the git-cliff-action output for GitHub release body - (03cf3a7)

📚 Documentation

• (readme) Update copyright years - (261ee4f)
• (readme) Disable Liquid parsing in README.md by using raw blocks - (6e8c7ed)

⚙️ Miscellaneous Tasks

• (cd) Publish binaries for more platforms/architectures - (ce1b7c3)
• (cd) Bump git-cliff-action to v2 - (1b3cba8)
• (config) Update the description in the default config - (0350bfd)
• (docker) Add Jekyll configuration to .dockerignore - (5dd1a15)
• (github) Add Jekyll theme configuration for GitHub pages - (81e5720)
• (release) Improve the release script with additional messages - (09ab59f)

1.0.0 - 2022-12-25

⛰️ Features

• (cd) Publish Debian package via release workflow (#113) - (efd827f)
• (cd) Include completions and mangen in binary releases (#115) - (9a070b2)
• (changelog) [breaking] Use current time for --tag argument (#107) - (e2cd07b)
• (changelog) Allow running with --prepend and --output (#120) - (7325be8)
• (changelog, config) [breaking] Replace --date-order by --topo-order - (77731ec)

🐛 Bug Fixes

• (fixtures) Fix test fixture failures - (29b3dd1)

📚 Documentation

• (readme) Fix GitHub badges in README.md - (acf2d52)

🎨 Styling

• (readme) Update README.md about the styling of footer field - (47a7345)

⚙️ Miscellaneous Tasks

• (cd) Remove deprecated set-output usage - (5187f02)
• (ci) Update actions/checkout to v3 - (6c37611)
• (config) Comment out custom commit preprocessor (#112) - (8f77caf)
• (fixtures) Run all test fixtures - (53c1c50)

0.10.0 - 2022-11-20

⛰️ Features

• (args) Add a short variant -d for specifying --date-order flag - (5913e24)
• (changelog) Do not skip breaking changes if configured (#114) - (1c98995)
• (config) Changelog for the last n commits (#116) - (0c7769b)

🐛 Bug Fixes

• (changelog) Warn against invalid tag range for --current flag (#124) - (e73fd9f)
• (docker) Fix syntax error in Dockerfile - (5f9b2d5)
• (docker) Use an alternative method to fetch registry - (876b13b)

🚜 Refactor

• (deps) Utilize workspace dependencies - (f2def40)
• (docker) Improve cargo-chef caching in Dockerfile - (0f38960)

📚 Documentation

• (readme) Update badge URL for Docker builds - (a8fa7f9)
• (readme) Add MacPorts install info (#111) - (f9d4b88)

⚙️ Miscellaneous Tasks

• (docker) Update versions in Dockerfile - (02e2b8e)

0.9.2 - 2022-09-24

🐛 Bug Fixes

• (docker) Remove custom user creation from the Dockerfile (#109) - (5cb991d)

⚙️ Miscellaneous Tasks

• (audit) Remove cargo-audit config - (078bdc3)
• (ci) Switch to cargo-tarpaulin for measuring code coverage (#110) - (17f3a09)

0.9.1 - 2022-09-20

🐛 Bug Fixes

• (docker) Configure git safe.directory for Docker image (#108) - (4fc2217)

🎨 Styling

• (readme) Update styling for with-commit example - (8247301)

0.9.0 - 2022-08-16

⛰️ Features

• (changelog) Support setting commit SHA while using --with-commit - (d453d4c)
• (changelog) Support splitting commits by lines (#101) - (e3eae33)
• (commit) Add commit author and committer to the context (#100) - (940065b)

🚜 Refactor

• (commit) Use a more concise conversion for string - (1b13b97)

📚 Documentation

• (readme) Add test repository link to README.md - (da484a3)

⚙️ Miscellaneous Tasks

• (build) Enable strip option for release profile - (f70fefd)
• (docker) Upgrade versions in Dockerfile - (6bb4f5b)
• (docker) Disable updating the description on Docker Hub - (cd1306c)
• (docker) Update the description on Docker Hub on push - (9c0e7a2)
• (docker) Enable building arm64 docker images - (f2968cd)
• (docker) Use an alternative method to fetch registry - (220d6e6)
• (funding) Add GitHub Sponsors option for funding - (f3fada7)
• (project) Update MSRV to 1.60.0 - (b55e678)

0.8.1 - 2022-07-12

🐛 Bug Fixes

• (cd) Set fail-fast strategy to false - (4b2ded0)

⚙️ Miscellaneous Tasks

• (cd) Update windows runners to windows-2022 - (8621a59)

0.8.0 - 2022-07-12

⛰️ Features

• (changelog) Support external commands for commit preprocessors (#86) - (7d0786c)
• (commit) [breaking] Pass footer token and separator to template (#97) - (0bf499e)
• (config) Support changing commit scope with commit_parsers (#94) - (e220768)

🐛 Bug Fixes

• (ci) Update lychee arguments to skip checking protonmail - (a5aaca1)

📚 Documentation

• (readme) Switch chronological and topological (#99) - (2289199)
• (readme) Clarify that --tag argument can be an unexisting tag - (d540f5d)

⚙️ Miscellaneous Tasks

• (docker) Disable building arm64 docker images temporarily - (175f7d7)
• (project) Set MSRV to 1.58.1 (#87) - (bfcd0d9)

0.7.0 - 2022-04-24

⛰️ Features

• (args) [breaking] Prefix environment variables with GIT_CLIFF_ (#76) - (84507dd)
• (args) Add --context flag for outputting context (#71) - (95ad55d)
• (cli) Show a message if a newer version is available (#69) - (720a7c1)
• (config) Support placing configuration inside Cargo.toml (#46) - (f48d207)
• (git) Support preprocessing commit messages using regex (#62) - (64317f2)
• (log) Print more debug information when -vv is used (#79) - (a8efffc)
• (man) Add man page generation script (#35) - (03d55c8)

🐛 Bug Fixes

• (build) Pin the Rust nightly version - (97c3044)
• (changelog) Allow custom commit range while prepending (#68) - (1bacc7f)
• (ci) Pin the Rust nightly version - (1b04dbf)
• (fixtures) Update expected changelog date - (2b484f0)
• (log) Remove redundant logging while using --context (#71) - (efd40e0)

🚜 Refactor

• (cli) Make update-informer opt-out via feature flag (#69) - (cddb4d4)
• (completions) Use implicit Result type in completions script - (fa2639a)

📚 Documentation

• (readme) Update the title of projects section - (4f4a82c)
• (readme) Add cliff-jumper to similar projects (#83) - (2a21890)
• (readme) Update GitHub Actions reference link in README.md - (9801963)
• (readme) Add more regex examples for commit_preprocessors - (9b83518)

🎨 Styling

• (release) Update the changelog template for tag message - (72544b1)

⚙️ Miscellaneous Tasks

• (cd) Include man page in the release assets - (a5ddf75)
• (ci) Return to nightly builds (#73) - (312b654)
• (docker) Strip the binaries in Docker image - (aca4ccf)
• (docker) Disable default features for the Docker image - (e6fb20d)
• (docker) Build Docker images for arm64 - (8475e1f)
• (docker) Upgrade versions in Dockerfile - (3aa9a1a)

0.6.1 - 2022-03-13

🐛 Bug Fixes

• (changelog) Use root commit when --latest and there is only one tag (#59) - (3ccec7f)
• (changelog) Do not skip all tags when skip_tags is empty (#63) - (ff1d981)
• (example) Fix keepachangelog config example (#66) - (9b5f0bb)
• (project) Use the correct branch for codecov (#65) - (8f3325e)

📚 Documentation

• (core) Document timestamp format of Release struct (#67) - (d68eb12)
• (readme) Add another option of GitHub Actions (#64) - (db7edf5)

0.6.0 - 2022-02-12

⛰️ Features

• (changelog) [breaking] Use conventional commit body to check against commit parsers - (e1da611)
• (changelog) Add link_parsers for parsing/extracting links (#42) - (b88e7d3)
• (changelog, config) [breaking] Replace --topo-order by --date-order (#58) - (a3980f4)
• (config) Make the changelog section optional (#45) - (e02ae0b)
• (config) Make the git section optional (#45) - (8202e37)

🐛 Bug Fixes

• (changelog) Set the previous release when using --unreleased (#47) - (2be04f8)
• (changelog) Only drop previous releases if skipped (#44) - (943c23f)
• (ci) Update grcov download command - (5bfb454)
• (ci) Use the correct tar command for extracting grcov archive - (a3f3aa6)
• (ci) Update the download link of latest grcov release - (c47133a)
• (ci) Run clippy from nightly toolchain - (7d766d7)
• (config) Lower the priority of global configuration file (#51) - (2595952)
• (test) Update tests about optional config values - (8bb48b0)
• (tests) Update custom error tests - (58165c7)

🚜 Refactor

• (config) [breaking] Change the default value of trim to true - (3b3ef7e)
• (lib) Unify serde and serde_derive using derive feature (#57) - (bedabc9)

📚 Documentation

• (config) Add minimal example - (848d8a5)
• (readme) Update copyright years - (0a3c56c)
• (readme) Update template contexts about link_parsers - (dce09d7)

🎨 Styling

• (changelog) Comply with MD022 and fix minor typos (#61) - (0293b28)
• (readme) Update the styling - (dcb3141)

⚙️ Miscellaneous Tasks

• (args) Update arg parsing to clap v3 (#49) - (d961b53)
• (cd) Update the runner to macos-11 - (960cb4a)
• (ci) Run cargo-audit for checking vulnerabilities - (cfe41fe)
• (docker) Bump the Rust version in Dockerfile - (d4cbb85)

0.5.0 - 2021-12-15

⛰️ Features

• (args) Add --with-commit argument for including custom commit messages in changelog - (e4c60b2)
• (args) Add --current flag for processing the current tag (#37) - (02a6187)
• (args) Add --exclude-path argument for excluding related commits - (25a1d49)
• (args) Support multiple values for --commit-path argument - (edb343a)
• (args) Accept glob patterns for --commit-path argument - (ad11cbf)
• (changelog) Support having both conventional and unconventional commits in the changelog - (8445313)
• (changelog) Add --topo-order flag for sorting tags (#29) - (cc09d63)
• (config) Add ignore_tags option (#40) - (de11cce)
• (config) Support specifying the sorting methods in config (#31) - (4eb334d)
• (template) Use more explanatory error messages about templates - (1a9c3e3)

🐛 Bug Fixes

• (args) Override the sort related config if args are present (#39) - (ef63727)
• (changelog) Drop the skipped releases from 'previous' field - (7f867ae)
• (fixtures) Strip the carriage return on fixtures while comparing - (d7e8ce2)
• (fixtures) Update the multi line docker command - (c8d288c)
• (fixtures) Use the defined configuration file for fixtures - (bbc58d7)
• (fixtures) Checkout the repository before running fixtures - (cb412a9)
• (tests) Update log test about exclude path - (9d213f5)

🚜 Refactor

• (config) Rename the config value for commit order - (6cec37d)

📚 Documentation

• (readme) Update --with-commit example in README.md - (47d124a)

🎨 Styling

• (args) [breaking] Rename --commit-path argument to --include-path - (7b000ad)

⚙️ Miscellaneous Tasks

• (config) Indicate the breaking changes via default config - (316c11b)
• (fixtures) Run test fixtures on ubuntu-latest - (dea65f2)
• (fixtures) Improve the workflow for test fixtures - (92a54d6)

0.4.2 - 2021-10-22

🐛 Bug Fixes

• (cd) Install the Rust toolchain explicitly for crates.io releases - (2cee3bf)

0.4.1 - 2021-10-22

🐛 Bug Fixes

• (changelog) Add support for special characters in scopes (#26) - (10771f4)

🚜 Refactor

• (git) Use a better error message for invalid repo path - (f447cc2)

📚 Documentation

• (readme) Update GitLab CI/CD section - (2925340)
• (readme) Add GitLab CI/CD section to README.md (#24) - (90a87c5)

⚙️ Miscellaneous Tasks

• (ci) Run CI workflows periodically - (627d4ef)
• (docker) Bump the Rust version in Dockerfile - (fc33efd)
• (project) Migrate to Rust 2021 edition - (0000000)
• (project) Remove unnecessary Cargo.lock entry from .gitignore - (481713c)

0.4.0 - 2021-10-01

⛰️ Features

• (changelog) Add --sort argument for sorting commits (#15) - (2950a41)

🐛 Bug Fixes

• (ci) Update lychee arguments to skip checking files - (ba3f1ca)
• (config) Remove only the leading "v" from tags (#18) - (e444615)
• (docker) Remove tags from the base image names - (ece0481)

📚 Documentation

• (config) Add scope-sorted example (#16) - (05584b6)
• (readme) Add "build from source" section to README.md - (b193f42)
• (readme) Mention the signing key for binary releases (#17) - (9022af5)
• (readme) Add packaging status badge to installation section - (5409e06)
• (readme) Add raw/rendered output for scoped-sorted example - (f64459d)

🎨 Styling

• (config) Fix the newline issues in scoped-sorted example - (428d407)

⚙️ Miscellaneous Tasks

• (docker) Use docker.yml workflow for CI/CD - (7756266)
• (docker) Use explicit image name for docker automated builds - (777375f)
• (docker) Specify the latest tag explicitly - (6bafc5d)
• (docker) Rename the GHCR package due to legacy reasons - (71b8846)
• (docker) Extend the tags for docker meta - (dff2e62)
• (docker) Use docker meta for tagging for GHCR - (081b2d2)
• (docker) Use cache for docker builds - (d3140ed)
• (workflow) Update the runner to ubuntu-20.04 - (5069594)
• (workflow) Set a version for the checkout action - (b323e60)

0.3.0 - 2021-09-10

⛰️ Features

• (changelog) Support generating a changelog scoped to a directory (#11) - (0bb7c91)
• (changelog) Support parsing the missing scopes with default_scope (#8) - (b5df656)

🐛 Bug Fixes

• (config) Fix default regexes and references in docs (#7) - (8a18e4d)

📚 Documentation

• (config) Update the default regex in scoped config example - (0d793ad)
• (readme) Update example regexes - (f420a5a)
• (readme) Add badge for joining the Matrix chat - (b5edfc2)
• (readme) Update installation instructions for Arch Linux - (8fb18b7)

0.2.6 - 2021-09-04

🐛 Bug Fixes

• (docker) Pin the cargo-chef version in Dockerfile - (af1851c)

📚 Documentation

• (readme) Update docker commands to only mount the .git directory - (4398828)

⚙️ Miscellaneous Tasks

• (docker) Bump cargo-chef version in Dockerfile - (612192b)

0.2.5 - 2021-08-20

⛰️ Features

• (template) Add breaking_description to the template context (#4) - (e0f6ca1)

📚 Documentation

• (readme) Update template examples to mention how to contribute - (4c6e64b)
• (readme) Mention breaking changes for templating - (6fa5d28)

⚙️ Miscellaneous Tasks

• (release) Show the committed changes before creating a tag - (59ffe53)

0.2.4 - 2021-08-20

🐛 Bug Fixes

• (cd) Change the config file location for crates.io release - (a9b286c)

0.2.3 - 2021-08-18

🐛 Bug Fixes

• (cd) Fetch the dependencies before copying the file to embed - (9e29c95)

0.2.2 - 2021-08-18

🐛 Bug Fixes

• (cd) Copy the config file into registry to resolve it for embed - (48ea157)

0.2.1 - 2021-08-18

🐛 Bug Fixes

• (cd) Copy the configuration file to embed into package - (68dda36)

0.2.0 - 2021-08-18

⛰️ Features

• (config) Support a global location for configuration file (#2) - (210b634)
• (config) Add --init flag for creating the default config - (183481b)
• (config) Embed the default configuration file into the binary - (e5148e3)

🐛 Bug Fixes

• (config) Use custom error type for UTF-8 errors - (45889c0)

🚜 Refactor

• (lib) Update the log message for unprocessed tags - (6f154ce)
• (lib) Create a constant for default configuration file - (c478f2c)

📚 Documentation

• (changelog) Update the doc comment of prepend - (e7ae5a0)

🎨 Styling

• (args) Update the message of --init flag - (927776b)

⚙️ Miscellaneous Tasks

• (config) Move cliff.toml to config/ - (acda195)

0.1.2 - 2021-08-14

🐛 Bug Fixes

• (cd) Use the correct name of completions binary - (3ae64f4)

📚 Documentation

• (completions) Update the example completion command - (f1fd88a)

0.1.1 - 2021-08-14

🐛 Bug Fixes

• (changelog) Set the previous release when using --latest (#3) - (29db41a)

📚 Documentation

• (readme) Add installation instructions for the AUR - (f1b495d)

⚡ Performance

• (changelog) Optimize the release vector size - (7e84797)
• (changelog) Process only the last 'previous' release - (f859747)

⚙️ Miscellaneous Tasks

• (project) Rename the shell completions binary - (718f535)

[0.1.0] - 2021-08-12

⛰️ Features

• (args) Add --output argument - (e0cda23)
• (args) Add --workdir argument - (de439be)
• (changelog) Support setting the body template via args - (9fc08f4)
• (logs) Show the processed commit message - (45dccf7)

🐛 Bug Fixes

• (cd) Wait for core library to update on crates.io before publish - (e795460)
• (cd) Wait between publishing crates - (777b3e5)
• (cd) Generate changelog on a dedicated/different job - (2f16dd5)
• (cd) Fix the syntax of publish step arguments - (6414789)
• (cd) Use a separate step for setting the changelog body - (f038054)
• (cd) Publish the cargo workspace members separately - (acc1d34)
• (cd) Strip the changelog header before escaping - (6b97c2d)
• (cd) Use printf to prevent field splitting the variable - (92a4b0d)
• (cd) Double quote the environment variable - (85aa1cd)
• (changelog) Return error if there is not a latest tag to process - (8232111)
• (changelog) Use footers field as an array for the context - (3e5c23d)
• (ci) Update lychee arguments to exclude invalid links - (e1d604c)
• (config) Update the environment variable parsing settings - (9984abf)
• (config) Update config to skip release commits - (2e5f30a)
• (config) Update commit parsers to match the commit type - (24b9068)
• (example) Remove symbolic link - (ed010be)
• (example) Update symbolic link to the default config - (ee377cc)
• (git) Sort the commits in topological order - (a1b4b5b)
• (git) Return tags by their creation order - (000a67c)
• (release) Fix the character escape in release script - (5d616ee)
• (release) Specify the committer email in release script - (381c941)
• (release) Strip the unreleased title from tag message - (c7f08fe)
• (template) Use 7 digits for short SHA - (1f85263)
• (test) Use default tag_pattern for tests - (e6fb8de)

🚜 Refactor

• (args) Rename changelog argument to prepend - (5a5a042)
• (args) Update value names and description - (c697b17)
• (args) Update the value name for --strip - (e8a3c35)
• (config) Make tag_pattern optional - (3a27a3e)
• (error) Use custom error message for GroupError - (1be66ee)
• (logs) Improve logging - (5333453)

📚 Documentation

• (bin) Update the doc comment for completions script - (c056196)
• (contributing) Add CONTRIBUTING.md - (0fe28b3)
• (readme) Add preview image to README.md - (6e6bdde)
• (readme) Update detailed template example - (441ed4d)
• (readme) Add examples for templating - (a406158)
• (readme) Add examples for CLI usage - (32f837e)
• (readme) Update README.md about template and examples - (2f2b2fc)
• (readme) Update README.md about usage - (7f4a9c2)
• (readme) Add usage section - (c87fbbe)
• (release) Add RELEASE.md - (ce2246b)
• (release) Add link to the signer key of the tag - (59b7c6e)

🎨 Styling

• (config) Update the order of entries in config - (9f84fe5)
• (readme) Remove quotes from rendered output - (dfab978)
• (readme) Wrap table of contents into summary - (fa6a38b)
• (readme) Remove comments from template context - (1cf1ac7)
• (readme) Update the comments in template context - (3749490)
• (readme) Center the badges - (f08ff0c)

🧪 Testing

• (config) Add tests - (11a7a7e)
• (git) Update repository tests about getting the latest tag - (9cf9ac1)

⚙️ Miscellaneous Tasks

• (cargo) Update project details - (22f0a7e)
• (cd) Enable crates.io releases - (31ecfd8)
• (cd) Use only one step for uploading releases - (42a714f)
• (cd) Use separate steps for uploading releases - (0182533)
• (cd) Remove the custom changelog template - (d826b9d)
• (cd) Override the changelog template - (41053fb)
• (cd) Set the release body on linux - (7623977)
• (cd) Fix setting the release body - (62403be)
• (cd) Set the changelog as release body - (66dfbf4)
• (cd) Set the release name explicitly - (0e5a7b1)
• (config) Update template to include commit ids - (e3d3482)
• (config) Update the skip_tags regex - (28171f0)
• (docker) Bump the rust version - (a2df26f)
• (docker) Rename the docker automated builds action - (ad3126e)
• (docker) Remove user directive from Dockerfile - (076fc85)
• (git) Remove etc directory from .gitignore - (8881083)
• (project) Update .editorconfig about shell scripts - (c898912)
• (project) Update the release script about arguments - (098c6ad)
• (project) Add release script - (d76bb9b)
• (release) Indicate which versions are managed by the script - (f481081)
• (release) Verify the created tag after creation - (99f2f07)
• (release) Set the new version in release script - (6619c38)
• (release) Include the commit id in the custom template - (5677281)
• (release) Set a custom changelog for the tag message - (c4df0fa)
• (release) Add release title to the tag message - (6099b2d)
• (release) Strip the markdown format from tag message - (3cb6761)

◀️ Revert

• Chore(config): update template to include commit ids - (f95fca9)