git-cliff

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

• (clippy) Apply clippy suggestions - (4c09759)
• (clippy) Apply clippy suggestions - (a814bbe)
• (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

Read detailed information about this release: https://git-cliff.org/blog/git-cliff-1.2.0

⛰️ Features

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

🐛 Bug Fixes

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

🚜 Refactor

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

📚 Documentation

• (blog) Add blog post about what's new in 1.2.0
• (blog) Update the blog post style
• (config) Update the sections
• (config) Add comments to the default configuration file
• (contributing) Mention the nightly requirement for rustfmt
• (contributing) Update MSRV
• (examples) Move examples to separate file
• (github) Update the pull request template about GitHub labels
• (github) Update pull request template
• (github) Update issue templates
• (github) Update funding options
• (github) Add security policy
• (readme) Update README.md about documentation website
• (readme) Add tj-actions/git-cliff to the list of actions (#152)
• (readme) Add discord badge
• (readme) Add release-plz to related projects (#151)
• (readme) Fix typos in README.md
• (readme) Remove unneeded word in README.md (#141)
• (readme) Add link to the Console #141 interview about git-cliff
• (website) Add Twitter link to banner
• (website) Move documentation to the website (#153)

🎨 Styling

• (docs) Fix the grammar for tj-actions
• (docs) Update the formatting for python integration example
• (readme) Update the style for project name
• (readme) Apply formatting
• (website) Update the style for environment variable section

🧪 Testing

• (deploy) Test the website deployment for pull requests

⚙️ Miscellaneous Tasks

• (cargo) Update MSRV to 1.64.0
• (cd) Temporarily switch back to action-rs/toolchain
• (ci) Switch to dtolnay/rust-toolchain action
• (ci) Update runner images
• (deps) Bump actions/configure-pages from 1 to 3
• (deps) Bump actions/deploy-pages from 1 to 2
• (deps) Upgrade transitive dependencies
• (deps) Update clap dependencies
• (deps) Upgrade workspace dependencies
• (deps) Upgrade core dependencies
• (docker) Update versions in Dockerfile
• (docker) Bump the action versions in docker workflow
• (docker) Bump build-push-action to v4
• (editorconfig) Fix editorconfig syntax
• (editorconfig) Update editorconfig for better code readability
• (examples) Remove EXAMPLES.md
• (github) Integrate Dependabot
• (github) Integrate bors
• (github) Add contact links for issues
• (website) Add workflow file for deploying the website
• (website) Move website to website folder
• (website) Move website to docs for GitHub pages deployment

[1.1.2] - 2023-01-20

Bug Fixes

• Do not skip all tags when skip_tags is empty (#136)
• Allow saving context to a file (#138)
• Derive the tag order from commits instead of timestamp (#139)

Miscellaneous Tasks

• Add metadata for cargo-binstall
• Upgrade core dependencies
• Update versions in Dockerfile

Styling

• Update the derives in config module

Revert

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

git-cliff is now available on NPM!

Install and run via:

npx git-cliff@latest

See the documentation for more information.

[1.1.1] - 2023-01-09

Documentation

• Update README.md about the NPM package

[1.1.1-rc.4] - 2023-01-09

Bug Fixes

• Fix the type casting in base NPM package

[1.1.1-rc.3] - 2023-01-09

Bug Fixes

• Fix the variable declaration for NPM package OS

Miscellaneous Tasks

• Parallelize releasing on crates.io

[1.1.1-rc.2] - 2023-01-09

Bug Fixes

• Rename the NPM binary package for Windows

Miscellaneous Tasks

• Add more keywords to the base NPM package
• Add README.md to the base NPM package

[1.1.1-rc.1] - 2023-01-09

Miscellaneous Tasks

• Package git-cliff for npm (#133)

[1.1.0] - 2023-01-08

Documentation

• Disable Liquid parsing in README.md by using raw blocks
• Update copyright years

Features

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

Miscellaneous Tasks

• Bump git-cliff-action to v2
• Add Jekyll theme configuration for GitHub pages
• Add Jekyll configuration to .dockerignore
• Bump git-conventional dependency (#130)
• Publish binaries for more platforms/architectures
• Upgrade dependencies
• Update the description in the default config
• Improve the release script with additional messages

Refactor

• Use the git-cliff-action output for GitHub release body

This is a milestone release that marks version 1.0.0 of git-cliff. It means that the API is somewhat stabilized and development will take a route in improving the existing functionality and adding new features rather than changing the internals. There are a couple of breaking changes in this release (such as the removal of --date-order) so the major version is increased.

Bug Fixes

• Fix test fixture failures

Documentation

• Fix GitHub badges in README.md

Features

• [breaking] Replace --date-order by --topo-order
• Allow running with --prepend and --output (#120)
• [breaking] Use current time for --tag argument (#107)
• Include completions and mangen in binary releases (#115)
• Publish Debian package via release workflow (#113)

Miscellaneous Tasks

• Run all test fixtures
• Remove deprecated set-output usage
• Update actions/checkout to v3
• Comment out custom commit preprocessor (#112)

Refactor

• Apply clippy suggestions

Styling

• Update README.md about the styling of footer field

Bug Fixes

• Warn against invalid tag range for --current flag (#124)
• Use an alternative method to fetch registry
• Fix syntax error in Dockerfile

Documentation

• Add MacPorts install info (#111)
• Update badge URL for Docker builds

Features

• Do not skip breaking changes if configured (#114)
• Changelog for the last n commits (#116)
• Add a short variant -d for specifying --date-order flag

Miscellaneous Tasks

• Update versions in Dockerfile
• Upgrade core dependencies

Refactor

• Improve cargo-chef caching in Dockerfile
• Utilize workspace dependencies

Bug Fixes

• Remove custom user creation from the Dockerfile (#109)

Miscellaneous Tasks

• Remove cargo-audit config
• Switch to cargo-tarpaulin for measuring code coverage (#110)
• Upgrade dependencies

Bug Fixes

• Configure git safe.directory for Docker image (#108)

Miscellaneous Tasks

• Remove ansi_term dependency for fixing RUSTSEC-2021-0139
• Upgrade dependencies

Refactor

• Apply clippy suggestions

Styling

• Update styling for with-commit example

Documentation

• Add test repository link to README.md

Features

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

Miscellaneous Tasks

• Use an alternative method to fetch registry
• Enable building arm64 docker images
• Update the description on Docker Hub on push
• Disable updating the description on Docker Hub
• Add GitHub Sponsors option for funding
• Upgrade dependencies
• Update MSRV to 1.60.0
• Upgrade versions in Dockerfile
• Enable strip option for release profile

Refactor

• Run clippy for tests
• Use a more concise conversion for string

Bug Fixes

• Set fail-fast strategy to false

Miscellaneous Tasks

• Update windows runners to windows-2022

[0.8.0] - 2022-07-12

Bug Fixes

• Update lychee arguments to skip checking protonmail

Documentation

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

Features

• Support external commands for commit preprocessors (#86)
• Support changing commit scope with commit_parsers (#94)
• [breaking] Pass footer token and separator to template (#97)

Miscellaneous Tasks

• Set MSRV to 1.58.1 (#87)
• Update tera to 1.16.0 (#70)
• Disable building arm64 docker images temporarily
• Upgrade dependencies

Refactor

• Apply clippy suggestions
• Apply clippy suggestions

Bug Fixes

• Pin the Rust nightly version
• Pin the Rust nightly version
• Allow custom commit range while prepending (fixes #68)
• Remove redundant logging while using --context (#71)
• Update expected changelog date

Documentation

• Add more regex examples for commit_preprocessors
• Update GitHub Actions reference link in README.md
• Add cliff-jumper to similar projects (#83)
• Update the title of projects section

Features

• Show a message if a newer version is available (#69)
• Add --context flag for outputting context (#71)
• Support placing configuration inside Cargo.toml (#46)
• [breaking] Prefix environment variables with GIT_CLIFF_ (#76)
• Print more debug information when -vv is used (#79)
• Support preprocessing commit messages using regex (#62)
• Add man page generation script (#35)

Miscellaneous Tasks

• Return to nightly builds (#73)
• Include man page in the release assets
• Upgrade git-conventional dependency (#82)
• Upgrade versions in Dockerfile
• Build Docker images for arm64
• Disable default features for the Docker image
• Strip the binaries in Docker image
• Upgrade dependencies

Refactor

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

Styling

• Update the changelog template for tag message

Bug Fixes

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

Documentation

• Add another option of GitHub Actions (#64)
• Document timestamp format of Release struct (#67)

Miscellaneous Tasks

• Upgrade regex dependency to fix CVE-2022-24713
• Upgrade dependencies