Blog | git-cliff

What's new in 2.7.0? 🆕

November 20, 2024 · 5 min read

Author of git-cliff

git-cliff is a command-line tool (written in Rust) that provides a highly customizable way to generate changelogs from git history.

It supports using custom regular expressions to alter changelogs which are mostly based on conventional commits. With a single configuration file, a wide variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired template engine.

More information and examples can be found in the GitHub repository.

What's new? ⛰️

The full changelog can be found here.

🥋 Jujutsu Support

git-cliff now supports opening a repository that has been cloned using Jujutsu!

For example:

$ jj git clone --colocate https://github.com/orhun/git-cliff

$ cd git-cliff

$ git cliff # works!

caution

This works differently with colocated and non-colocated repositories. See the documentation for more information.

tip

Watch my first live reaction to Jujutsu on this stream: Learning Jujutsu (a version control system)

☘️ Add missing fields to context

A bug causing some fields such as footer to be missing in the context JSON has been fixed.

This means that the following command now yields an identical result with git-cliff:

# hey look, a snake eating its own tail! 🐍
git cliff --context | git cliff --from-context

--context: prints the changelog context as JSON
--from-context: generates a changelog from the context JSON

📩 Raw message in context

The context now contains the raw/unprocessed full commit message in the raw_message field. For example:

{
  "version": "v0.1.0-rc.21",
  "message": "The annotated tag message for the release",
  "commits": [
    {
      "raw_message": "<type>[scope]: <description>\n[body]\n[footer(s)]"
    }
  ]
}

You can use it like so:

{% for commit in commits %}
  {{ commit.raw_message }}
{% endfor %}

⚙️ Remote API URL configuration

In addition to the command-line/environment variables, you can now override the remote API URL in the configuration file as follows:

[remote.gitlab]
owner = "archlinux"
repo = "arch-repro-status"
api_url = "https://gitlab.archlinux.org/api/v4" # new!

This is useful when you have a self-hosted Git service and want to use the API for fetching metadata.

See the remote configuration for more information.

✨ Preserve first time contributors

There was a bug causing the first time contributors to be removed from the changelog when there was a new release. This has been fixed and now the first time contributors are preserved in the changelog.

So if you run git cliff now, you might get new names in the changelog! Don't be surprised.

See this pull request for more details.

🐋 ARM Docker images

We brought back the Docker images for ARM64! 🎉 See them here.

docker run --platform linux/arm64 -t -v "$(pwd)":/app/ "orhunp/git-cliff:${TAG:-latest}"

There was a problem building these images due to the timeouts in the GitHub Actions workflow. This turned out to be a problem related to needlessly fetching the Rust toolchain in the build step of cargo-chef and is now fixed in this pull request.

See the related discussion here.

❄️ Nix environment

We now have a basic and reproducible dev environment using Nix along with CI checks for it.

Here is the Nix flake and you can use it by running nix build and nix run commands.

🎨 Colored help

A small cosmetic change, but the output of git cliff --help is now colorful!

Try it for yourself :)

💖 User testimonials

Do you like git-cliff? Spread the word on social media and let me know your thoughts! I will be featuring your testimonials.

I collected the testimonials that I could find so far and added them to the website. It picks one randomly on each page load.

Shoutout to those amazing people!

🚀 Stabilize remote integration

The remote integration with GitHub/GitLab/Gitea/Bitbucket has been stabilized and now works as expected (apart from a couple of bugs that come and go occasionally).

🧰 Other

(log) Add trace log about which command is being run - (a9b2690)
(bitbucket) Match PR and release metadata correctly (#907) - (e936ed5)
(changelog) Include the root commit when --latest is used with one tag (#901) - (508a97e)
(config) Add the 'other' parser to the default config - (12cb1df)
(git) Improve docs for commit_preprocessors and commit_parsers (#928) - (c1f1215)

Contributions 👥

@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

Any contribution is highly appreciated! See the contribution guidelines for getting started.

Feel free to submit issues and join our Discord / Matrix for discussion!

Follow git-cliff on Twitter & Mastodon to not miss any news!

Support 🌟

If you liked git-cliff and/or my other projects on GitHub, consider donating to support my open source endeavors.

💖 GitHub Sponsors: @orhun
☕ Buy Me A Coffee: https://www.buymeacoffee.com/orhun

Have a fantastic day! ⛰️

What's new in 2.6.0?

September 22, 2024 · 3 min read

Orhun Parmaksız

Author of git-cliff

git-cliff is a command-line tool (written in Rust) that provides a highly customizable way to generate changelogs from git history.

It supports using custom regular expressions to alter changelogs which are mostly based on conventional commits. With a single configuration file, a wide variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired template engine.

More information and examples can be found in the GitHub repository.

What's new? ⛰️

The full changelog can be found here.

🛠️ Deprecated integration fields

The following fields are deprecated and will be removed in the next releases:

commit.github, commit.gitea, commit.gitlab, commit.bitbucket

You can now use the commit.remote field instead. For example:

-{% if commit.github.username %}
+{% if commit.remote.username %}

🌲 Better branch support

If you have diverged branches for your project and want to changelog for each branch, you can now use the --use-branch-tags option.

$ git cliff --use-branch-tags

The generated changelog above will only include the tags from the current branch.

Also, you can use it from the configuration file:

[git]
use_branch_tags  = true

info

See the implementation for more explanation and the coolest hand-drawn diagram ever!

♾️ Render always

Do you want to always render the changelog even if there are no changes? Boom, now you can now use the render_always option:

[changelog]
render_always = true

📤 Output from configuration

This is pretty self-explanatory:

[changelog]
output = "CHANGELOG.md"

This option does not take precedence over command-line arguments which means you can override it with the --output option.

📦 Improve Typescript API

We added the missing options and documented all options with tsdoc comments.

Also, we improved the skipCommit option to accept an array of values.

info

See the implementation for more information.

✂️ Trim commit messages

We now remove the trailing newline for commits, which means you can use $ anchor in your regular expressions:

[git]
commit_preprocessors = [
  # remove the issue number at the end of the commit message (e.g. #123)
  { pattern = ' #\d+$', replace = ""}
]

🌟 Better example templates

The example templates are now more intuitive and conventionally correct. We removed the non-beginner-friendly options and changed the defaults to be easier to start with. Weheee!

🧰 Other

(template) [breaking/core] Add name parameter to the constructor - (e577113)
(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)

Contributions 👥

@nejcgalof made their first contribution in #853
@pplmx made their first contribution in #824

Any contribution is highly appreciated! See the contribution guidelines for getting started.

Feel free to submit issues and join our Discord / Matrix for discussion!

Follow git-cliff on Twitter & Mastodon to not miss any news!

Support 🌟

If you liked git-cliff and/or my other projects on GitHub, consider donating to support my open source endeavors.

💖 GitHub Sponsors: @orhun
☕ Buy Me A Coffee: https://www.buymeacoffee.com/orhun

Have a fantastic day! ⛰️

What's new in 2.5.0?

August 24, 2024 · 6 min read

Orhun Parmaksız

Author of git-cliff

git-cliff is a command-line tool (written in Rust) that provides a highly customizable way to generate changelogs from git history.

It supports using custom regular expressions to alter changelogs which are mostly based on conventional commits. With a single configuration file, a wide variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired template engine.

More information and examples can be found in the GitHub repository.

What's new? ⛰️

The full changelog can be found here.

🔥 Generate changelog from context

Meet our powerful new command-line argument: --from-context.

# create a context
$ git cliff --context -o context.json

# generate changelog from context
$ git cliff --from-context context.json

This new extension point allows transformations on the context and can be especially useful when preprocessor/postprocessor/linkprocessor capabilities are limited.

One example use case is:

Print context
Modify it with an external tool
Pipe it back into git-cliff

If you need additional data in the changelog, you can also use the newly added extra free-form metadata in the context:

{
  "id": "5061081d6272b1da2146fab49d803c193db309d9",
  "message": "commit message",
  "extra": {
    "note": "this can be anything"
  }
}

🧩 Grouping by arbitrary fields

git-cliff now supports grouping commits by arbitrary context fields instead of just a limited set. This means that you can use any context field for commit_parsers as field.

For example, to group by GitHub PR labels:

[git]
commit_parsers = [
  { field = "github.pr_labels", pattern = "breaking-change", group = "<!-- 0 --> 🏗️ Breaking changes" },
  { field = "github.pr_labels", pattern = "type/enhancement", group = "<!-- 1 --> 🚀 Features" },
  { field = "github.pr_labels", pattern = "type/bug", group = "<!-- 2 --> 🐛 Fixes" },
  { field = "github.pr_labels", pattern = "type/update", group = "<!-- 3 --> 🧪 Dependencies" },
  { field = "github.pr_labels", pattern = "type/refactor", group = "<!-- 4 --> 🏭 Refactor" },
  { field = "github.pr_labels", pattern = "area/documentation", group = "<!-- 5 --> 📝 Documentation" },
  { field = "github.pr_labels", pattern = ".*", group = "<!-- 6 --> 🌀 Miscellaneous" },
]

See the commit_parsers documentation for more information.

⬆️ Bump specific versions

Now you can specify the semver type while using --bump:

$ git cliff --bump [major|minor|patch]

See the bump documentation for more information.

⚡ Gotta go fast

git-cliff now runs 258x faster for --include-path/--exclude-path arguments thanks to caching the commit retain checks.

Now: 0.080 s
Before: 20.633 s

We also improved handling of include/exclude patterns (e.g., by considering the first commit).

See the implementation for cool flamegraphs and more!

💯 Performance profiling

git-cliff now supports building with performance profiling instrumentation, which helps identify bottlenecks.

To create a flame graph SVG:

$ cargo run --profile=bench --features=profiler

See the documentation for more information.

⚗️ Better integration activation

Before this change, the only way to activate a remote integration (and fetch remote data) was by incorporating the related variables in a template.

This meant that the changelog context wouldn't contain GitHub-related fields unless you used something like github.contributors in your template.

Now we’ve added support for enabling the remote integration in the following cases:

If the [remote] table is configured.
If the remote is set via command-line arguments (e.g., --github-repo).

So, the following output will contain GitHub variables even with the default template (since the remote is set):

$ git cliff --context --github-repo orhun/git-cliff

Additionally, we fixed a bug where some of the GitHub-related variables were not recognized in the template.

🔢 `count_tags`

A new configuration option has been added to the [git] section!

[git]
count_tags = "v.*-beta.*"

info

count_tags works like an inverted version of ignore_tags, including all the commits but only counting the specific tags.

See the implementation for more details and an example use case.

🏆 KaiCode: Open Source Festival

git-cliff won a prize for finishing second place in the KaiCode Open Source Festival!

The orhun/git-cliff project (8.3K★), a customizable changelog generator, impressed us with its excellent easy-to-read source code, build pipeline organization, integration testing, and active issue triaging. However, code coverage is rather low, some functions are too long, there is a lack of peer reviews, and a lack of clarity in the repository structure. $1024 was the reward.

🦊 GitLab integration fixes

(gitlab) URL-encode the owner in remote requests for GitLab (#742) - (e3e7c07)
(args) Allow GitLab groups with --gitlab-repo (#807) - (6fbfdb5)

🧰 Other

(changelog) Skip ssh and x509 signatures in tag messages (#748) - (ecbabbf)
(changelog) Allow using --bumped-version without conventional commits (#806) - (e74080c)
(config) Allow using environment variables without config file present (#783) - (2471745)
(config) Make example templates more user-friendly - (6f8ea19)
(lib) Clean up some code (#709) - (4b0c0eb)

Contributions 👥

@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
@janbuchar made their first contribution in #784
@weichweich made their first contribution in #807

Any contribution is highly appreciated! See the contribution guidelines for getting started.

Feel free to submit issues and join our Discord / Matrix for discussion!

Follow git-cliff on Twitter & Mastodon to not miss any news!

Support 🌟

If you liked git-cliff and/or my other projects on GitHub, consider donating to support my open source endeavors.

💖 GitHub Sponsors: @orhun
☕ Buy Me A Coffee: https://www.buymeacoffee.com/orhun

Have a fantastic day! ⛰️

What's new in 2.4.0?

June 26, 2024 · 6 min read

Orhun Parmaksız

Author of git-cliff

git-cliff is a command-line tool (written in Rust) that provides a highly customizable way to generate changelogs from git history.

It supports using custom regular expressions to alter changelogs which are mostly based on conventional commits. With a single configuration file, a wide variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired template engine.

More information and examples can be found in the GitHub repository.

What's new? ⛰️

The full changelog can be found here.

🍵 Gitea Integration

git-cliff now supports integrating with repositories hosted on Gitea (e.g. Codeberg or your own instance!)

This means that you can now use the following variables in your changelog:

Usernames (${{ commit.gitea.username }} or ${{ contributor.username }})
Contributors list (${{ gitea.contributors }})
Pull requests (${{ commit.gitea.pr_number }} or ${{ contributor.pr_number }})

This means you can generate changelog entries like the following:

## What's Changed

- feat(commit): add merge_commit flag to the context by @orhun in #389
- test(fixture): add test fixture for bumping version by @orhun in #360

## New Contributors

- @someone made their first contribution in #360
- @cliffjumper made their first contribution in #389

<!-- generated by git-cliff -->

To set up git-cliff for your project, simply:

Check out the quickstart guide for installation / initialization.
Set up the Git remote for your GitLab project.
Update the changelog configuration to use the template variables.

tip

See the Gitea integration for detailed documentation and usage examples. It works very similar to the GitHub integration.

📤 Bump based on pattern

The --bump argument works as follows:

"fix:" -> increments PATCH

"feat:" -> increments MINOR

"scope!" (breaking changes) -> increments MAJOR

But what happens let's say you want to bump the major if the commit starts with "abc" instead?

Good news, git-cliff now supports bumping based on configurable custom patterns! Simply configure the following values in your configuration:

[bump]
custom_major_increment_regex = "abc"
custom_minor_increment_regex = "minor|more"

So with this commit history:

(HEAD -> main) abc: 1
(tag: 0.1.0) initial commit

The major will be bumped due to "abc" (0.1.0 -> 1.0.0)

$ git-cliff --bumped-version

1.0.0

⬆️ Set initial tag for bump

When using --bump, if there are no initial tags are found then the default used to be hardcoded as 0.1.0.

Now you can configure this value in the configuration file as follows:

[bump]
initial_tag = "1.0.0"

You can also override this value from the command line as follows:

$ git-cliff --bump --tag=1.0.0

⚙️ `--ignore-tags` argument

The value of [git.ignore_tags] can now be overridden by the newly added --ignore-tags argument:

$ git-cliff --ignore-tags "rc|v2.1.0|v2.1.1"

is the equivalent of:

[git]
# regex for ignoring tags
ignore_tags = "rc|v2.1.0|v2.1.1"

📝 Header template

[changelog.header] is now a template similar to body and footer. It used to be a raw string value that is added to the top of the changelog but now you can use the template variables and functions in it!

For example:

[changelog]
# template for the changelog footer
header = """
# Changelog
{% for release in releases %}\
    {% if release.version %}\
        {% if release.previous.version %}\
            <!--{{ release.previous.version }}..{{ release.version }}-->
        {% endif %}\
    {% else %}\
        <!--{{ release.previous.version }}..HEAD-->
    {% endif %}\
{% endfor %}\
"""

Will result in:

# Changelog

<!--v3.0.0..HEAD-->
<!--v0.2.0..v3.0.0-->
<!--v0.1.0..v0.2.0-->

^{There is a pending issue that needs fixing for --prepend to work with header template.}

You can now parse the commits by their footer value!

Let's say you want to skip this commit:

git commit -m "test: add more tests" -m "changelog: ignore"

This is now possible:

[git]
# regex for parsing and grouping commits
commit_parsers = [
    { footer = "^changelog: ?ignore", skip = true },
]

📩 Support tag messages

You can now include the tag messages (of release tags) in your changelog!

This can be useful for having "headlines" for a release like so:

## [1.0.1] - 2021-07-18

This is the release-tag message

The message is available in the context of the template as the {{ message }} variable:

{% if message %}
    {{ message }}
{% endif %}\

You can also override the tag message for the unreleased changes via --with-tag-message argument as follows:

$ git cliff --bump --unreleased --with-tag-message "This is the release-tag message"

The recommended way of setting tag messages is to use annotated tags in your project:

$ git tag v1.0.0 -m "This is the release-tag message"

📂 Repository path in context

You can now use {{ repository }} variable in the template to get the repository path:

## Release [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }} - {{ repository }}

This is especially useful when you use git-cliff with multiple repositories. (e.g. git-cliff -r repo1 -r repo2)

📡 Remote data in context

We updated the changelog processing order to make remote data (e.g. GitHub commits, pull requests, etc.) available in the context.

For example:

$ git cliff --github-repo orhun/git-cliff -c examples/github.toml --no-exec -u -x

This command will now contain the GitHub data such as:

 "github": {
      "contributors": [
        {
          "username": "bukowa",
          "pr_title": "style(lint): fix formatting",
          "pr_number": 702,
          "pr_labels": [],
          "is_first_time": true
        },
    ],
}

🧰 Other

(website) Add information about --bump with tag prefixes (#695) - (4cd18c2)
(fixture) Support running fixtures on mingw64 (#708) - (dabe716)

Contributions 👥

@MeitarR made their first contribution in #713
@bukowa made their first contribution in #696
@Cyclonit made their first contribution in #698
@jan-ferdinand made their first contribution in #569
@Theta-Dev made their first contribution in #680
@tcarmet made their first contribution in #694

Any contribution is highly appreciated! See the contribution guidelines for getting started.

Feel free to submit issues and join our Discord / Matrix for discussion!

Follow git-cliff on Twitter & Mastodon to not miss any news!

Support 🌟

If you liked git-cliff and/or my other projects on GitHub, consider donating to support my open source endeavors.

💖 GitHub Sponsors: @orhun
☕ Buy Me A Coffee: https://www.buymeacoffee.com/orhun

Have a fantastic day! ⛰️

What's new in 2.3.0?

June 3, 2024 · 3 min read

Orhun Parmaksız

Author of git-cliff

git-cliff is a command-line tool (written in Rust) that provides a highly customizable way to generate changelogs from git history.

It supports using custom regular expressions to alter changelogs which are mostly based on conventional commits. With a single configuration file, a wide variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired template engine.

More information and examples can be found in the GitHub repository.

What's new? ⛰️

The full changelog can be found here.

🦊 GitLab Integration

git-cliff now supports integrating with repositories hosted on GitLab (gitlab.com or your own instance)!

This means that you can now use the following variables in your changelog:

GitLab usernames (${{ commit.gitlab.username }} or ${{ contributor.username }})
Contributors list (${{ gitlab.contributors }})
Pull requests (${{ commit.gitlab.pr_number }} or ${{ contributor.pr_number }})

Which means you can generate a changelog entries like the following:

## What's Changed

- feat(commit): add merge_commit flag to the context by @orhun in !389
- test(fixture): add test fixture for bumping version by @orhun in !360

## New Contributors

- @someone made their first contribution in !360
- @cliffjumper made their first contribution in !389

<!-- generated by git-cliff -->

To set up git-cliff for your project, simply:

Check out the quickstart guide for installation / initialization.
Set up the Git remote for your GitLab project.
Update the changelog configuration to use the template variables.

tip

See the GitLab integration for detailed documentation and usage examples. It works very similar to the GitHub integration.

Big thanks to dark0dave for the contribution!

📘 Bitbucket Integration

git-cliff now supports integrating with repositories hosted on Bitbucket!

It works similarly with GitHub and GitLab integrations. See the documentation for details and usage examples.

Big thanks to dark0dave for the contribution!

📤 Output to stdout

Using - for stdout is common among CLI tools and git-cliff now supports this!

$ git-cliff -o -

You can simply use - instead instead of -o /dev/stdout. It can also be used in conjunction with -p argument as mentioned in this issue.

🧰 Other

(nix) Add installation instructions for Nix (#669) - (63c8ad4)
(website) Add more git range examples (#655) - (d451252)
(args) Allow -o and -p together if they point to different files (#653) - (076f859)
(example) Allow using github template without github variables (#672) - (6a9feba)

Contributions 👥

@R11baka made their first contribution in #672
@0x61nas made their first contribution in #669
@dark0dave made their first contribution in #663
@antonengelhardt made their first contribution in #653

Any contribution is highly appreciated! See the contribution guidelines for getting started.

Feel free to submit issues and join our Discord / Matrix for discussion!

Follow git-cliff on Twitter & Mastodon to not miss any news!

Support 🌟

If you liked git-cliff and/or my other projects on GitHub, consider donating to support my open source endeavors.

💖 GitHub Sponsors: @orhun
☕ Buy Me A Coffee: https://www.buymeacoffee.com/orhun

Have a fantastic day! ⛰️

What's new in 2.2.0?

March 30, 2024 · 4 min read

Orhun Parmaksız

Author of git-cliff

git-cliff is a command-line tool (written in Rust) that provides a highly customizable way to generate changelogs from git history.

It supports using custom regular expressions to alter changelogs which are mostly based on conventional commits. With a single configuration file, a wide variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired template engine.

More information and examples can be found in the GitHub repository.

What's new? ⛰️

The full changelog can be found here.

🎈 Configurable Bump Rules

If you are a frequent user of --bump/--bumped-version flags then this new feature is for you!

git-cliff now supports customizing the behavior of version bumps.

Add the following section to your cliff.toml for configuration:

[bump]
# Configures automatic minor version increments for feature changes.
#
# When true, a feature will always trigger a minor version update.
#
# When false, a feature will trigger:
# - a patch version update if the major version is 0.
# - a minor version update otherwise.
features_always_bump_minor = true

# Configures 0 -> 1 major version increments for breaking changes.
#
# When true, a breaking change commit will always trigger a major version update
# (including the transition from version 0 to 1)
#
# When false, a breaking change commit will trigger:
# - a minor version update if the major version is 0.
# - a major version update otherwise.
breaking_always_bump_major = true

🛠️ Better Template Errors

Template rendering errors are now more verbose!

For example, let's throw an error in the template with using throw function:

[changelog]
body = """
{{ throw(message="something happened!") }}
"""

When you run git-cliff:

 ERROR git_cliff > Template render error:
Function call 'throw' failed
something happened!

🤖 Auto Detecting Config

If you configured git-cliff from Cargo.toml via metadata table ([workspace.metadata.git-cliff.changelog]), running git cliff is now simply enough!

$ git cliff

# is same as
$ git cliff --config Cargo.toml

We also updated the config detection mechanism to support the following cases:

`cliff.toml`	project manifest (e.g. `Cargo.toml`)	use config from:
✅	✅	`cliff.toml`
✅	❌	`cliff.toml`
❌	✅	`Cargo.toml`
❌	❌	builtin

See Rust & Python integration for more information.

🚦 Commit Processing Order

The order of commit processing is changed from:

Split commits
Process commits

To:

Process commits
Split commits (and process the split commits)

This makes it possible to e.g. preprocess commits, split them by newline and then process each line as conventional commit.

See #555 for an example.

✂️ Trim Text

We changed the commit parser behavior to always trim the text (commit message, body, etc.) before matching it with a regex.

This means that you will be able to use $ in the regex for matching until the end.

For example:

[git]
commit_parsers = [
  { message = '^(fix|feat|setup|doc|refactor|test|optimization)\([A-Za-z0-9_-]+?\))+(:\ .*)$', group = "test"},
]

🚀 Quick Installation in CI

You can now install git-cliff in your GitHub Actions CI easily with taiki-e/install-action!

- name: Check out repository
  uses: actions/checkout@v3
  with:
    fetch-depth: 0

- name: Install git-cliff
  uses: taiki-e/install-action@git-cliff

- name: Generate changelog
  run: git-cliff

🧰 Other

(changelog) Return the last version if there is nothing to bump - (45c87f2)
(command) Add missing environment variables for Windows (#532) - (9722784)
(npm) Publish rc version for prereleases (#528) - (16bea51)
(pypi) Update maturin version (#539) - (10b7ab8)

Contributions 👥

Any contribution is highly appreciated! See the contribution guidelines for getting started.

Feel free to submit issues and join our Discord / Matrix for discussion!

Follow git-cliff on Twitter & Mastodon to not miss any news!

Support 🌟

If you liked git-cliff and/or my other projects on GitHub, consider donating to support my open source endeavors.

💖 GitHub Sponsors: @orhun
☕ Buy Me A Coffee: https://www.buymeacoffee.com/orhun

Have a fantastic day! ⛰️

What's new in 2.0.0?

February 19, 2024 · 7 min read

Orhun Parmaksız

Author of git-cliff

git-cliff is a command-line tool (written in Rust) that provides a highly customizable way to generate changelogs from git history.

It supports using custom regular expressions to alter changelogs which are mostly based on conventional commits. With a single configuration file, a wide variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired template engine.

More information and examples can be found in the GitHub repository.

What's new? ⛰️

The full changelog can be found here.

🚀 GitHub Integration

This highly requested feature is now experimentally available with the 2.0.0 version of git-cliff!

For repositories hosted on GitHub, you can now use the following variables in your changelog:

GitHub usernames (${{ commit.github.username }} or ${{ contributor.username }})
Contributors list (${{ github.contributors }})
Pull requests (${{ commit.github.pr_number }} or ${{ contributor.pr_number }})

To quickly set things up for your project, you can use the built-in GitHub template:

# creates cliff.toml
$ git cliff --init github

And simply run git cliff to generate a changelog like the following:

## What's Changed

- feat(commit): add merge_commit flag to the context by @orhun in #389
- test(fixture): add test fixture for bumping version by @orhun in #360

## New Contributors

- @someone made their first contribution in #360
- @cliffjumper made their first contribution in #389

<!-- generated by git-cliff -->

tip

For detailed documentation and usage examples, check out the GitHub integration!

🦀 RustLab 2023

I gave a talk about git-cliff at RustLab 2023 - you can watch the recording here:

📋 Built-in Templates

As briefly mentioned, the example templates are now embedded into the binary which means you can quickly initialize git-cliff or generate a changelog using one of them.

# creates cliff.toml with keepachangelog template
$ git cliff --init keepachangelog

# generates a changelog in keepachangelog format
$ git cliff --config keepachangelog

Here is the full list of supported templates as of now:

keepachangelog.toml: changelog in Keep a Changelog format.
github.toml: changelog in the GitHub's format.
github-keepachangelog.toml: combination of the previous two formats.
detailed.toml: changelog that contains links to the commits.
minimal.toml: minimal changelog.
scoped.toml: changelog with commits are grouped by their scopes.
scopesorted.toml: changelog with commits grouped by their scopes and sorted by group.
cocogitto.toml: changelog similar to cocogitto's format.
unconventional.toml: changelog for unconventional commits.

Now you can use a template in [changelog.footer] as well!

Before:

# changelog footer
footer = """
<!-- generated by git-cliff -->
"""

After:

# template for the changelog footer
footer = """
<!-- generated by git-cliff at {{ now() | date(format="%Y-%m-%d") }} -->
"""

For example, keepachangelog.toml uses this for adding links to the end of the changelog.

# template for the changelog footer
footer = """
{% for release in releases -%}
    {% if release.version -%}
        {% if release.previous.version -%}
            [{{ release.version | trim_start_matches(pat="v") }}]: \
                https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
                    /compare/{{ release.previous.version }}..{{ release.version }}
        {% endif -%}
    {% else -%}
        [unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
            /compare/{{ release.previous.version }}..HEAD
    {% endif -%}
{% endfor %}
<!-- generated by git-cliff -->
"""

Results in:

[unreleased]: https://github.com/orhun/git-cliff/compare/v1.4.0..HEAD
[1.4.0]: https://github.com/orhun/git-cliff/compare/v1.3.1..v1.4.0
[1.3.1]: https://github.com/orhun/git-cliff/compare/v1.3.1-rc.0..v1.3.1
[1.3.1-rc.0]: https://github.com/orhun/git-cliff/compare/v1.3.0..v1.3.1-rc.0

🧶 Improve Skipping

Do you want to skip erroneous commits in the changelog? We now support two comfortable ways of doing that.

1. `.cliffignore`

You can now add a .cliffignore file at the root of your repository for listing the commits that will be skipped:

# skip commits by their SHA1

4f88dda8c746173ea59f920b7579b7f6c74bd6c8
10c3194381f2cc4f93eb97404369568882ed8677

2. `--skip-commit`

You can skip commits by using this argument as follows:

$ git cliff --skip-commit 10c3194381f2cc4f93eb97404369568882ed8677 \
            --skip-commit 4f88dda8c746173ea59f920b7579b7f6c74bd6c8

🖨️ Print Bumped Version

If you want to use the --bump option but are only interested in the bumped version instead of the entire changelog, you can simply use the newly added --bumped-version flag!

# print the next semantic version
$ git cliff --bumped-version

v2.0.0

🚫 Disable Command Execution

If you are using external commands (e.g. via replace_command) in your configuration, you can now entirely skip executing those commands with --no-exec flag.

$ git cliff --no-exec

For example, this is useful in the cases where the execution takes time.

🔄 Filter Merge Commits

The template context has a new field called merge_commit (bool) which can be used to filter out merge commits.

For example, you can use filter(attribute="merge_commit", value=false) as follows:

{% for group, commits in commits |
  filter(attribute="merge_commit", value=false) |
  group_by(attribute="group") %}
    ### {{ group | upper_first }}
    {% for commit in commits %}
        - {{ commit.message | upper_first }}\
    {% endfor %}
{% endfor %}\n

🔍 Match by commit SHA

It is now possible to use the SHA1 of a commit with commit_parsers.

For example, to skip a specific commit:

commit_parsers = [
    { sha = "f6f2472bdf0bbb5f9fcaf2d72c1fa9f98f772bb2", skip = true }
]

To override the group of a specific commit:

commit_parsers = [
    { sha = "f6f2472bdf0bbb5f9fcaf2d72c1fa9f98f772bb2", group = "Stuff" }
]

🔠 Regex Scope Values

It is now possible to use regex-replace for the scope value in commit_parsers:

[git]
# regex for parsing and grouping commits
commit_parsers = [
  { message = "^\\[(.*)\\]", group = "Changes to ${1}", scope = "${1}" },
]

In this example, [codebase]: rewrite everything in Rust will appear in the changelog as:

### Changes to codebase

- (codebase) Rewrite everything in Rust

📈 Bump Improvements

There was some love towards --bump flag to improve its behavior:

Tag prefixes are now supported!
- This means that for example if you have testing/v1.0.0-beta.1 as the current version and if you run git cliff --bump, you will see testing/v1.0.0-beta.2 in your changelog.
If no tags exist, --bump will yield 0.1.0 as default.
Other behavioral fixes!

📚 Documentation Improvements

Added Tips And Tricks!
Added installation instructions for Homebrew

brew install git-cliff

Added instructions for adding new test fixtures

🌐 Website Improvements

Made dark theme default (sorry moths)
Added a search bar

🧰 Other

There were a lot of bug fixes and improvements in this release but mainly:

(changelog) Fix previous version links (#364)
(cli) Fix broken pipe when stdout is interrupted (#407)
(commit) Trim the trailing newline from message (#403)
(git) Sort commits in topological order (#415)
(args) Set CHANGELOG.md as default missing value for output option (#354)
(changelog) Disable the default behavior of next-version (#343)

Contributions 👥

Any contribution is highly appreciated! See the contribution guidelines for getting started.

Feel free to submit issues and join our Discord / Matrix for discussion!

Follow git-cliff on Twitter & Mastodon to not miss any news!

Support 🌟

If you liked git-cliff and/or my other projects on GitHub, consider donating to support my open source endeavors.

💖 GitHub Sponsors: @orhun
☕ Buy Me A Coffee: https://www.buymeacoffee.com/orhun

Have a fantastic day! ⛰️

What's new in 1.4.0?

October 29, 2023 · 4 min read

Orhun Parmaksız

Author of git-cliff

git-cliff is a command-line tool (written in Rust) that provides a highly customizable way to generate changelogs from git history. It supports using custom regular expressions to alter changelogs which are mostly based on conventional commits. With a single configuration file, a wide variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired template engine. More information and examples can be found in the GitHub repository.

What's new?

The full changelog can be found here.

Bump version 🆙

git-cliff can calculate the next version based on conventional commits and bump the version for the unreleased changes for you!

--bump: Bumps the version for unreleased changes

For example, if you have 1.0.0 and committed "feat: xyz", git-cliff --bump --unreleased will create a changelog for 1.1.0.

How it works is that for a semantic versioning such as <MAJOR>.<MINOR>.<PATCH>:

"fix:" -> increments PATCH
"feat:" -> increments MINOR
"scope!" (breaking changes) -> increments MAJOR

Better grouping 👥

Now you can group commits by their attributes, i.e. name of the author, email, etc.

For example, to group the commits that belong to Dependabot under "Dependency Updates" in the changelog:

[git]
# regex for parsing and grouping commits
commit_parsers = [
  { field = "author.name", pattern = "dependabot\\[bot\\]", group = "Dependency Updates"},
]

This will result in:

### Dependency Updates

- _(deps)_ Bump regex from 1.9.6 to 1.10.0
- _(deps)_ Bump toml from 0.8.1 to 0.8.2
- _(deps)_ Bump regex from 1.9.5 to 1.9.6

The supported commit attributes (fields) are:

id
message
body
author.name
author.email
committer.email
committer.name

Glob -> Regex 🧶

[git].tag_pattern was only supporting glob patterns for matching (mostly due to the underlying support of such glob by git2), now it directly supports regular expressions:

[git]
- # glob pattern for matching git tags
+ # regex for matching git tags
- tag_pattern = "v[0-9]*"
+ tag_pattern = "v[0-9].*"

Auto-fix typos ✍️

Here is a git-cliff configuration for automatically fixing the typos in the commit messages before they appear in the changelog:

# regex for preprocessing the commit messages
commit_preprocessors = [
  # 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 -' },
]

This configuration was added to the git-cliff's repository config (not default) in #316 and runs typos for each commit. There is also a good first issue to improve this.

Emacs support 😈

Check out git-cliff.el to generate, update and release changelog in Emacs.

RustLab 2023 📢

I'm happy to announce that I will be talking about git-cliff at RustLab 2023! 🎉

rustlab2023

https://rustlab.it/talks/turning-git-commits-into-changelog-with-git-cliff

In this talk, I will be sharing the story behind git-cliff, implementation details with certain design choices, and most importantly how to work with Git objects using Rust. Also, I will be sharing examples of how to use git-cliff and integrate it with your project.

Additionally, I will be giving tips on creating a successful command-line tool in Rust and publishing it as open source.

Dates: November 19th -> November 21th
Location: Florence, Italy
Tickets: https://rustlab.it/tickets

Contributions

Any contribution is highly appreciated! There are contribution guidelines for getting started.

Feel free to submit issues and join Discord / Matrix!

Donate

If you liked git-cliff and/or my other projects on GitHub, consider donating to support my open source endeavors.

💖 https://donate.orhun.dev

Have a fantastic day! ⛰️

What's new in 1.3.0?

August 30, 2023 · 4 min read

Orhun Parmaksız

Author of git-cliff

git-cliff is a command-line tool (written in Rust) that provides a highly customizable way to generate changelogs from git history. It supports using custom regular expressions to alter changelogs which are mostly based on conventional commits. With a single configuration file, a wide variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired template engine. More information and examples can be found in the GitHub repository.

What's new?

The full changelog can be found here.

Fancier changelog 🍬

The changelog of git-cliff is looking more fancy now!

For example:

## [1.3.0-rc.1](https://github.com/orhun/git-cliff/compare/v1.2.0..v1.3.0-rc.1) - 2023-08-24

### ⛰️ Features

- _(changelog)_ [**breaking**] Add postprocessors ([#155](https://github.com/orhun/git-cliff/issues/155)) - ([5dc5fb7](https://github.com/orhun/git-cliff/commit/5dc5fb786db922322faacf928cc571a2d785cab2))

### 🐛 Bug Fixes

- _(cd)_ Do not publish release notes for pre-releases ([#249](https://github.com/orhun/git-cliff/issues/249)) - ([7a82aa1](https://github.com/orhun/git-cliff/commit/7a82aa1a769b2170ea7563d7df3c59da5a134201))

The title now has links to the compare changes page on GitHub
Each entry shows the issue/PR number and related commit
Emojis!

Configuration: https://github.com/orhun/git-cliff/blob/main/cliff.toml

Postprocessors ⚙️

Now you can post-process the changelog after generation:

An array of commit postprocessors for manipulating the changelog before outputting. Can e.g. be used for replacing commit author with GitHub usernames.

For example:

[changelog]
postprocessors = [{ pattern = "foo", replace = "bar"}]

A practical example is present in the default configuration:

[changelog]
# <REPO> will be replaced via postprocessors
body = """
## [{{ version }}](<REPO>/compare/{{ previous.version }}..{{ version }})
<!--trim-->
"""
# replace <REPO> with actual repository URL
postprocessors = [
  { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" },
]

[git]
# replace issue numbers with <REPO>/issues/<num>
commit_preprocessors = [
  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))" },
]

Imagine you created a tag (e.g. 0.2.0) with the following commit:

feat: add xyz (#1)

In the changelog, it will turn into:

## [0.2.0](https://github.com/orhun/git-cliff/compare/v0.1.0..v0.2.0)

### Features

- Add xyz ([#1](https://github.com/orhun/git-cliff/issues/1))

The way that it works is:

The numbers in commit messages are replaced with <REPO>/issues/<num> with the help of git.preprocessors.
The changelog is generated using changelog.body which has a couple of <REPO> usages.
<REPO is replaced with the original repository URL in the final changelog using changelog.postprocessors.

PyPI Releases 🐍

git-cliff is now packaged for PyPI, the Python packaging index.

https://pypi.org/project/git-cliff
https://test.pypi.org/project/git-cliff (test package)

You can download it with pip:

pip install git-cliff

Optional git2 🍦

If you are using git-cliff as a library, you can now get rid of git2 dependency by disabling the repo feature.

repo: Enable parsing commits from a git repository. Enabled by default. You can turn this off if you already have the commits to put in the changelog and you don't need git-cliff to parse them.

Here is an example from release-plz:

[dependencies]
git-cliff-core = { version = "1.3.0", default-features = false }

Cocogitto example 🐓

cocogitto is one other great release tool and conventional commits toolbox written in Rust.

With the newly added cocogitto.toml example, you can generate changelogs similar to cocogitto's changelog format.

For example:

git cliff -c examples/cocogitto.toml

Results in:

# Changelog

All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.

---

## [unreleased]

### Bug Fixes

- **(cd)** do not publish release notes for pre-releases (#249) - ([7a82aa1](https://github.com/cocogitto/cocogitto/commit/7a82aa1a769b2170ea7563d7df3c59da5a134201)) - Orhun Parmaksız

Docker improvement 🐋

To avoid CVE-2022-24765 (safe directory vulnerability), we were copying the project files into the container. After #142 is merged, this is no longer the case and the Docker container can be run as follows:

- docker run -t -v "$(pwd)/.git":/app/ "orhunp/git-cliff:${TAG:-latest}"
+ docker run -t -v "$(pwd)":/app/ "orhunp/git-cliff:${TAG:-latest}"

RustLab 2023 📢

I'm happy to announce that I will be talking about git-cliff at RustLab 2023! 🎉

rustlab2023

https://rustlab.it/talks/turning-git-commits-into-changelog-with-git-cliff

In this talk, I will be sharing the story behind git-cliff, implementation details with certain design choices, and most importantly how to work with Git objects using Rust. Also, I will be sharing examples of how to use git-cliff and integrate it with your project.

Additionally, I will be giving tips on creating a successful command-line tool in Rust and publishing it as open source.

Dates: November 19th -> November 21th
Location: Florence, Italy
Tickets: https://rustlab.it/tickets

Contributions

Any contribution is highly appreciated! There are contribution guidelines for getting started.

Feel free to submit issues and join Discord / Matrix!

Donate

If you liked git-cliff and/or my other projects on GitHub, consider donating to support my open source endeavors.

💖 https://donate.orhun.dev

Have an awesome day! ⛰️

What's new in 1.2.0?

April 28, 2023 · 6 min read

Orhun Parmaksız

Author of git-cliff

In this post, I'm giving a brief introduction to the new features in the 1.2.0 release while giving insight into the future of git-cliff.

git-cliff is a command-line tool (written in Rust) that provides a highly customizable way to generate changelogs from git history. It supports using custom regular expressions to alter changelogs which are mostly based on conventional commits. With a single configuration file, a wide variety of formats can be applied for a changelog, thanks to the Jinja2/Django-inspired template engine. More information and examples can be found in the GitHub repository.

Today, the new version of git-cliff (1.2.0) is released. There are a couple of major cool features that I believe are interesting and also there were some internal library changes. Let's have a look!

What's new?

The full changelog can be found here.

Improved documentation

git-cliff documentation is moved to https://git-cliff.org.

It is surely better than cluttering up the README.md with all the information.

The source for the website can be found here.

Python Integration

For Python projects, you can now place the git-cliff configuration inside pyproject.toml as follows:

name = "..."

[project]
dependencies = []

[tool.git-cliff.changelog]
header = "All notable changes to this project will be documented in this file."
body = "..."
footer = "<!-- generated by git-cliff -->"
# see [changelog] section for more keys

[tool.git-cliff.git]
conventional_commits = true
commit_parsers = []
filter_commits = false
# see [git] section for more keys

See the documentation for more information.

Thanks to @radusuciu for the implementation!

Better commit grouping

You can now use regex values while grouping the commits via commit_parsers.

Let's say we have this commit history for example:

* fix(args): rename help argument due to conflict
* feat(parser): add ability to parse arrays

For this configuration:

# regex for parsing and grouping commits
commit_parsers = [
    { message = '^fix\((.*)\)', group = 'Fix (${1})' },
    { message = '^feat\((.*)\)', group = 'Feat (${1})' },
]

We get:

## [1.0.0] - 2021-07-18

### Feat (parser)

- Add ability to parse arrays

### Fix (args)

- Rename help argument due to conflict

Thanks to @erwinc1 for reporting the issue!

Overriding configuration with environment variables

It was reported by @mackness on Discord that overriding the nested configuration values with environment variables was not working as expected. So we made some changes:

The prefix for environment variables is changed to GIT_CLIFF (from CLIFF).
"__" can be used as the separator for nested fields.

For example:

GIT_CLIFF__CHANGELOG__FOOTER overrides changelog.footer
GIT_CLIFF__GIT__IGNORE_TAGS overrides git.ignore_tags

See the documentation for more information.

Thanks to @mackness for the implementation!

New configuration file

For my own projects such as halp and linuxwave, I started to use a fancier git-cliff configuration so I thought it would be nice to use it for the git-cliff repository as well.

Just to avoid confusion: the default (basic) template has not changed. I'm just maintaining another cliff.toml at the root of the repository now.

cliff.toml (default)
cliff.toml (new)

The changelog looks something like this now:

## [unreleased]

### ⛰️ Features

- _(cache)_ Use cache while fetching pages
- _(config)_ Support multiple file formats

## [1.0.1] - 2021-07-18

### 🚜 Refactor

- _(parser)_ Expose string functions

### ⚙️ Miscellaneous Tasks

- _(release)_ Add release script

See the other template examples in the documentation.

New GitHub Action

A new GitHub Action for git-cliff has been created by @jackton1!

tj-actions/git-cliff is another GitHub Action that you can use to generate changelogs for your project.

It uses a generic cliff-template.toml without the need to maintain multiple configuration files for each project or you can optionally provide a customized template as a path or URL which falls back to project's cliff.toml if it exist.

- name: Check out repository
  uses: actions/checkout@v3
  with:
    fetch-depth: 0

- name: Run git-cliff
  uses: tj-actions/git-cliff@v1

See the documentation for more information.

Internal changes

Here is a list of changes that are worth mentioning if you use git-cliff/git-cliff-core in your Rust project as a library:

Move changelog module to git-cliff-core (2ab2c8f)
- This reduces the number of dependencies since you will only depend on git-cliff-core for changelog generation.
Make the fields of Signature public (104aac9)
- Useful if you want to construct this struct manually.

Console interview

The Console newsletter interview came out where I talk about the story behind git-cliff, my motivation, and the technical challenges that I faced during development.

Read: Console #141 - The Open Source Newsletter

Discord server

If you are having a problem with git-cliff or want to contribute to the project or you just want to chit-chat, feel free to join our Discord server!

Looking forward

Upcoming features

Here is the list of open pull requests that I'm planning to focus on for the next releases:

Publish git-cliff on PyPI
- This would make it seamless for Python projects to install and use git-cliff and would pair nicely with the newly added support for configuration in pyproject.toml. It also fits nicely in the recent rustification of python tooling trend.
Add postprocessors to changelog
- This will enable things like replacing usernames with GitHub usernames for the generated changelog.

Also, see the project issues.

Apart from those, I'm planning really big updates for the future that will revolutionize the changelog generation. Stay tuned! 🚀

New organization

I created an organization on GitHub: https://github.com/git-cliff

The following repositories will be moved there:

orhun/git-cliff -> git-cliff/git-cliff
orhun/git-cliff-action -> git-cliff/action

Just a heads-up :3

If you have a git-cliff-related repository that you're possibly interested in maintaining as a part of this organization, hit me up!

Contributions

Any contribution is highly appreciated! There are contribution guidelines for getting started.

Feel free to submit issues and throw in ideas!

Donate

If you liked git-cliff and/or my other projects on GitHub, consider donating to support my open source endeavors.

💖 https://donate.orhun.dev

Have a wonderful day! ⛰️

What's new? ⛰️​

🥋 Jujutsu Support​

☘️ Add missing fields to context​

📩 Raw message in context​

⚙️ Remote API URL configuration​

✨ Preserve first time contributors​

🐋 ARM Docker images​

❄️ Nix environment​

🎨 Colored help​

💖 User testimonials​

🚀 Stabilize remote integration​

🧰 Other​

Contributions 👥​

Support 🌟​

What's new? ⛰️​

🛠️ Deprecated integration fields​

🌲 Better branch support​

♾️ Render always​

📤 Output from configuration​

📦 Improve Typescript API​

✂️ Trim commit messages​

🌟 Better example templates​

🧰 Other​

Contributions 👥​

Support 🌟​

What's new? ⛰️​

🔥 Generate changelog from context​

🧩 Grouping by arbitrary fields​

⬆️ Bump specific versions​

⚡ Gotta go fast​

💯 Performance profiling​

⚗️ Better integration activation​

🔢 count_tags​

🏆 KaiCode: Open Source Festival​

🦊 GitLab integration fixes​

🧰 Other​

Contributions 👥​

Support 🌟​

What's new? ⛰️​

🍵 Gitea Integration​

📤 Bump based on pattern​

⬆️ Set initial tag for bump​

⚙️ --ignore-tags argument​

📝 Header template​

🧮 Parse commits by footer​

📩 Support tag messages​

📂 Repository path in context​

📡 Remote data in context​

🧰 Other​

Contributions 👥​

Support 🌟​

What's new? ⛰️​

🦊 GitLab Integration​

📘 Bitbucket Integration​

📤 Output to stdout​

🧰 Other​

Contributions 👥​

Support 🌟​

What's new? ⛰️​

🎈 Configurable Bump Rules​

🛠️ Better Template Errors​

🤖 Auto Detecting Config​

🚦 Commit Processing Order​

✂️ Trim Text​

🚀 Quick Installation in CI​

🧰 Other​

Contributions 👥​

Support 🌟​

What's new? ⛰️​

🚀 GitHub Integration​

🦀 RustLab 2023​

📋 Built-in Templates​

📄 Footer Template​

🧶 Improve Skipping​

1. .cliffignore​

2. --skip-commit​

🖨️ Print Bumped Version​

🚫 Disable Command Execution​

🔄 Filter Merge Commits​

🔍 Match by commit SHA​

What's new? ⛰️

🥋 Jujutsu Support

☘️ Add missing fields to context

📩 Raw message in context

⚙️ Remote API URL configuration

✨ Preserve first time contributors

🐋 ARM Docker images

❄️ Nix environment

🎨 Colored help

💖 User testimonials

🚀 Stabilize remote integration

🧰 Other

Contributions 👥

Support 🌟

What's new? ⛰️

🛠️ Deprecated integration fields

🌲 Better branch support

♾️ Render always

📤 Output from configuration

📦 Improve Typescript API

✂️ Trim commit messages

🌟 Better example templates

🧰 Other

Contributions 👥

Support 🌟

What's new? ⛰️

🔥 Generate changelog from context

🧩 Grouping by arbitrary fields

⬆️ Bump specific versions

⚡ Gotta go fast

💯 Performance profiling

⚗️ Better integration activation

🔢 `count_tags`

🏆 KaiCode: Open Source Festival

🦊 GitLab integration fixes

🧰 Other

Contributions 👥

Support 🌟

What's new? ⛰️

🍵 Gitea Integration

📤 Bump based on pattern

⬆️ Set initial tag for bump

⚙️ `--ignore-tags` argument

📝 Header template

🧮 Parse commits by footer

📩 Support tag messages

📂 Repository path in context

📡 Remote data in context

🧰 Other

Contributions 👥

Support 🌟

What's new? ⛰️

🦊 GitLab Integration

📘 Bitbucket Integration

📤 Output to stdout

🧰 Other

Contributions 👥

Support 🌟

What's new? ⛰️

🎈 Configurable Bump Rules

🛠️ Better Template Errors

🤖 Auto Detecting Config

🚦 Commit Processing Order

✂️ Trim Text

🚀 Quick Installation in CI

🧰 Other

Contributions 👥

Support 🌟

What's new? ⛰️

🚀 GitHub Integration

🦀 RustLab 2023

📋 Built-in Templates

📄 Footer Template

🧶 Improve Skipping

1. `.cliffignore`

2. `--skip-commit`

🖨️ Print Bumped Version

🚫 Disable Command Execution

🔄 Filter Merge Commits

🔍 Match by commit SHA