16 posts tagged with "release"

git-cliff is a command-line tool that provides a highly customizable way to generate changelogs from the Git history.

What's new? ⛰️​

The full changelog can be found here.

📡 Offline Mode​

Now you can run git-cliff in offline mode using the --offline flag!

This feature disables contacting any external services, even if they are configured. This can be useful in scenarios where you want to avoid network calls or when working in a restricted environment.

$ git cliff --offline

This can be also configured as a part of the the remote configuration, for example:

[remote.gitlab]
owner = "archlinux"
repo = "arch-repro-status"
offline = true

⏩ Skip Tags via CLI​

Skipping certain tags with regex was already possible via the configuration file:

[git]
skip_tags = "beta|alpha"

Now you can also specify the same via the command-line using the --skip-tags argument:

$ git cliff --skip-tags "beta|alpha"

↩️ Revert Log Verbosity​

A couple of users reported the new verbosity level introduced in 2.11.0 was too noisy for their use cases.

With this release, we reverted that change and started exploring alternative ways to provide more detailed logs in a less-overwhelming way.

Related issues: #1352, #1354, #1327

🌀 Rename Azure DevOps variable​

⚠️ This is a breaking change for those using Azure DevOps remote integration.

In your template, rename {{ azureDevops.contributors }} to {{ azure_devops.contributors }}.

- {% for contributor in azureDevops.contributors | filter(attribute="is_first_time", value=true) %}
+ {% for contributor in azure_devops.contributors | filter(attribute="is_first_time", value=true) %}

See #1318 for the rationale behind this change.

🧰 Other​

• (config) Respect the changelog.output configuration (#1349) - (cfcc5ae)
• (remote) Avoid false first-time contributors when tag timestamp missing (#1348) - (de7cf02)
• (remote) Remove reqwest::Response::error_for_status (#1336) - (081ba68)

New Contributors ❤️​

• @taladar made their first contribution in #1319
• @barskern made their first contribution in #1321
• @ooooo-create made their first contribution in #1334
• @jylenhof made their first contribution in #1320

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! ⛰️

git-cliff is a command-line tool that provides a highly customizable way to generate changelogs from the Git history.

What's new? ⛰️​

The full changelog can be found here.

🌀 Azure DevOps Integration​

git-cliff now supports Azure Devops for remote integration, enabling changelog generation with metadata from Azure DevOps repositories (commits, pull requests, and contributors). 🥳

Simply configure your cliff.toml for your own repository as follows:

# Azure DevOps integration for fetching commit metadata.
[remote.azure_devops]
owner = "shiftme/gitcliff"
repo = "git-cliff-readme-example"

And then update your [changelog].body with the relevant template variables, e.g. {{ commit.remote.pr_number }}, {{ commit.remote.username }} and so on.

e.g. results in:

## What's Changed in v1.0.0

- Initial commit by @orhun
- docs(project): add README.md by @orhun
- feat(parser): add ability to parse arrays by @orhun
- fix(args): rename help argument due to conflict by @orhun
- docs(example)!: add tested usage example by @orhun

### New Contributors

- @orhun made their first contribution

For more information, see the documentation.

Thanks to @amd989 for the implementation in #1283!

❎ Failing on unmatched commits​

A new configuration variable was added for enforcing that all commits are matched by a commit parser:

[git]
commit_parsers = [
    { message = "^feat", group = "Should be matched" },
]

fail_on_unmatched_commit = true

If fail_on_unmatched_commit is set to true, git-cliff will fail when any commit included in the changelog is not matched by any of the configured commit_parsers.

🧩 New built-in filters​

git-cliff now has new custom filters you can use inside templates:

• upper_first: Converts the first character of a string to uppercase.

    {{ "hello" | upper_first }} →  Hello
  

• find_regex: Finds all occurrences of a regex pattern in a string.

  {{ "hello world, hello universe" | find_regex(pat="hello") }} →  [hello, hello]
  

• replace_regex: Replaces all occurrences of a regex pattern with a string.

  {{ "hello world" | replace_regex(from="o", to="a") }} →  hella warld
  

• split_regex: Splits a string by a regex pattern.

  {{ "hello world, hello universe" | split_regex(pat=" ") }} →  [hello, world,, hello, universe]
  

🆙 Increased log verbosity​

We have evaluated and increased the verbosity of some log messages to provide better insights into the internal workings of git-cliff.

To get more detailed logs, provide one or multiple -v flags when running:

$ git cliff -vv

✨ Better include-path handling​

1. The --include_path's behavior has been revised and several reported issues have been addressed in #1290 thanks to @ognis1205!

2. --include-path is now automatically set to the value of --workdir if the latter is provided. This ensures that commit parsing works as expected when a different working directory is specified.

Before:

git cliff --workdir my_crate --include-path my_crate

After:

git cliff --workdir my_crate

🦀 Better API​

The git-cliff library crates (git_cliff & git_cliff_core) has been improved with several new features and enhancements!

• git_cliff::run now returns the generated git_cliff_core::changelog::Changelog,
• git_cliff::write_changelog helper writes it to a file or stdout,
• git_cliff::init_config function handles config creation,
• git_cliff::check_new_version is now public.

Breaking changes:

• Changelog::new / Changelog::from_context take Config by value

Here is how you can create a minimal git-cliff application in Rust:

use clap::Parser;
use git_cliff::args::Opt;
use git_cliff_core::error::Result;

fn main() -> Result<()> {
    let args = Opt::parse();
    let changelog = git_cliff::run(args.clone())?;
    git_cliff::write_changelog(&args, changelog, std::io::stdout())?;
    Ok(())
}

🧰 Other​

• (bump) Write bumped version to stdout even when output config is set (#1307) - (314ff57)
• (args) Group remote-related CLI arguments under REMOTE OPTIONS heading (#1271) - (0b6af12)
• (remote) Expose commits and PRs as streams (#1272) - (b82221a)
• (ci) Stabilize lychee link checking in CI (#1295) - (7ed1db0)

New Contributors ❤️​

• @Lewiscowles1986 made their first contribution in #1226
• @OpenSauce made their first contribution in #1314
• @amd989 made their first contribution in #1283
• @asweet-confluent made their first contribution in #1272
• @linus-skold made their first contribution in #1287
• @simoncdn made their first contribution in #1305
• @haidaraM made their first contribution in #1285
• @ritoban23 made their first contribution in #1271

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! ⛰️

git-cliff is a command-line tool that provides a highly customizable way to generate changelogs from the Git history.

What's new? ⛰️​

The full changelog can be found here.

📈 Release statistics​

git-cliff now supports adding various release-related metrics to the changelog via statistics variable!

You can use it in your template as follows:

[changelog]
body = """
### Commit Statistics

- {{ statistics.commit_count }} commit(s) contributed to the release.
- {{ statistics.commits_timespan | default(value=0) }} day(s) passed between the first and last commit.
- {{ statistics.conventional_commit_count }} commit(s) parsed as conventional.
- {{ statistics.links | length }} linked issue(s) detected in commits.

{%- for link in statistics.links %}
      {{ "  " }}- [{{ link.text }}]({{ link.href }}) (referenced {{ link.count }} time(s))
{%- endfor %}

- {{ statistics.days_passed_since_last_release }} day(s) passed between releases.

"""

This will render a section like this in the changelog:

## Commit Statistics

- 5 commit(s) contributed to the release.
- 0 day(s) passed between the first and last commit.
- 5 commit(s) parsed as conventional.
- 3 linked issue(s) detected in commits.
  - [#452](https://github.com/orhun/git-cliff/issues/452) (referenced 2 time(s))
  - [#1148](https://github.com/orhun/git-cliff/issues/1148) (referenced 1 time(s))
  - [ietf-rfc3986](https://datatracker.ietf.org/doc/html/rfc3986) (referenced 1 time(s))
- 1430 day(s) passed between releases.

See release statistics for the available variables and more details.

Thanks to Shingo OKAWA for the implementation in #1151!

📝 New template​

Related to the new statistics feature, we added a new built-in template called statistics.toml!

It can be used as follows:

$ git cliff --config statistics

To initialize cliff.toml with it:

$ git cliff --init statistics

 INFO  git_cliff > Saving the configuration file (statistics) to "cliff.toml"

It serves the purpose of providing a basic template that includes release statistics. You can use it as a starting point for your own changelog template or simply use it as is.

📁 Include/exclude paths in config​

As highly requested, you can now include or exclude specific paths in your changelog generation via the include_paths and exclude_paths options in the configuration file.

[git]
include_paths = ["src/", "doc/**/*.md"]
exclude_paths = ["unrelated/"]

These options are the same as providing --include-paths and --exclude-paths command line arguments.

Thanks to @Kriskras99 for implementing this in #1173!

🧮 Support matching arrays via parsers​

The commit parser has been extended to support regex matching on array values, such as remote.pr_labels.

For example, this makes it possible to group commits based on their GitHub labels as follows:

[git]
commit_parsers = [
  { field = "remote.pr_labels", pattern = "duplicate|invalid|wontfix|skip changelog", skip = true },
  { field = "remote.pr_labels", pattern = "breaking change", group = "<!-- 0 -->🏗️ Breaking Changes" },
  { field = "remote.pr_labels", pattern = "feature|deprecation", group = "<!-- 1 -->🚀 Features" },
  { field = "remote.pr_labels", pattern = "enhancement|refactor", group = "<!-- 1 -->🛠️ Enhancements" },
  { field = "remote.pr_labels", pattern = "bug|regression", group = "<!-- 2 -->🐛 Bug Fixes" },
  { field = "remote.pr_labels", pattern = "security", group = "<!-- 3 -->🔐 Security" },
  { field = "remote.pr_labels", pattern = "documentation", group = "<!-- 4 -->📝 Documentation" },
  { message = ".*", group = "<!-- 5 -->🌀 Miscellaneous" },
]

🗑️ Empty header/footer as default​

In the previous release, we internally started initializing the configuration file with default values. This sadly made it impossible to render a changelog without a header or footer.

This behavior has been reverted in this release and the default values for [changelog.header] and [changelog.footer] are now empty. Meaning that the following is a minimal configuration that will render a changelog without a header or footer:

[changelog]
body = """
{% if version %}\
    ## {{ version | trim_start_matches(pat="v") }} - {{ timestamp | date(format="%Y-%m-%d") }}\
{% else %}\
    ## Unreleased\
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | upper_first }}
    {% for commit in commits %}\
        - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}
    {% endfor %}\
{% endfor %}\n
"""

🐧 Gentoo support​

git-cliff made its way into the Gentoo Linux package repository! 🎉

It can be installed via the following command:

emerge git-cliff

See the package page here.

Thanks to @aspann for packaging!

🏴 Spaces instead of tabs​

git-cliff now uses spaces instead of tabs throughout the codebase! This change made the code more consistent with the Rust community's conventions and improved readability.

🧰 Other​

• (config) Check if commit.footers is defined in detailed example (#1170) - (078545f)
• (generation) Ensure skip_tags condition is evaluated first (#1190) - (318be66)
• (repo) Use the correct order while diffing paths (#1188) - (ff6c310)
• (config) Implement FromStr instead of Config::parse_from_str() (#1185) - (692345e)
• (ci) Apply security best practices (#1180) - (a32deca)
• (fixture) Add test fixture for overriding the conventional scope (#1166) - (cb84a08)
• (build) Bump MSRV to 1.85.1 - (d8279d4)
• (crate) Remove Rust nightly requirement - (4f3e5af)

New Contributors ❤️​

• @Nick2bad4u made their first contribution in #1180
• @aspann made their first contribution in #1203
• @muzimuzhi made their first contribution in #1200
• @j-g00da made their first contribution in #1188
• @Kriskras99 made their first contribution in #1173
• @wetneb made their first contribution in #1165
• @gmeligio made their first contribution in #1170
• @LitoMore made their first contribution in #1164

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! ⛰️

git-cliff is a command-line tool that provides a highly customizable way to generate changelogs from the Git history.

10k Stars! 🌟​

Started from the cd69e764f68e5f09cf6e14975e6a876cdccbcfb9, now we're here.

git-cliff has reached a whopping 10000 stars on GitHub and I wanted to celebrate this huge milestone with giving away a limited edition T-shirt!

You can join the giveaway by clicking here. Nothing else is required!

If you want to buy the T-shirt and support the project, visit our shop at Grindhouse for different sizes and colors!

Thank you all for the support and love you have shown to git-cliff! ⛰️🧡

What's new? ⛰️​

The full changelog can be found here.

🌀 Submodule Support​

git-cliff now supports submodules! You can recurse into submodules and generate changelogs for them as well.

Just set the following option in your configuration file:

[git]
recurse_submodules = true

And then you can use the submodule_commits template variable to access the commits of submodules as follows:

[changelog]
body = """
{% for submodule_path, commits in submodule_commits %}
    ### {{ submodule_path | upper_first }}
    {% for group, commits in commits | group_by(attribute="group") %}
        #### {{ group | upper_first }}
        {% for commit in commits %}
            - {{ commit.message | upper_first }}\
        {% endfor %}
    {% endfor %}
{% endfor %}\n
"""

Thanks @lehmanju for the implementation in #1082!

⚠️ Conventional commit check​

git-cliff can now check if the commits in the repository follow the conventional commits specification.

To enable this check, set the require_conventional option in your configuration file:

[git]
require_conventional = true

If any unconventional commits are found, an error will be thrown and the changelog generation will fail.

🛰️ Remote config​

Have a configuration file elsewhere on the internet? No probs.

$ git cliff --config-url https://github.com/orhun/git-cliff/blob/main/examples/github-keepachangelog.toml?raw=true

The new --config-url option allows you to specify a URL to a configuration file!

↔️ Commit range variable​

The template context now includes a commit_range variable that contains the range of commits that were used to generate the changelog.

Can be used as follows:

{{ commit_range.from }}..{{ commit_range.to }}

Results in:

a140cef0405e0bcbfb5de44ff59e091527d91b38..a9d4050212a18f6b3bd76e2e41fbb9045d268b80

{{ commit_range.from | truncate(length=7, end="") }}..{{ commit_range.to | truncate(length=7, end="") }}

a140cef..a9d4050

🌿 Better branch support​

git-cliff used to only support the default branches of the remotes (e.g., main branch on GitHub).

Now, it can fetch commits from the correct branch automatically based on the commit range that you provide.

For example:

$ git cliff v1.0.0..v1.0.1 --github-repo my-org/my-private-repo

This command used to default to the main branch of the my-org/my-private-repo repository. Now, it will use the v1.1 branch thus using the correct commits for the changelog.

Similarly:

$ git cliff 9f66ac0f76..89de5e8e50 --gitlab-repo my-org/my-private-repo

The changelog will contains commits up to the commit 89de5e8e50.

Thanks to @william-stacken for the implementation in #1086!

🔢 Disable topological sorting​

The topological sorting of commits can now be disabled by setting the topological_sort option to false in your configuration file:

[git]
topo_order_commits = false

• If false, the commits will be sorted in the order they were committed, without considering their parent-child relationships.
  • This is equivalent to running git log.
• Otherwise, if true (default), the commits will be sorted topologically, which means that the commits will be ordered in such a way that all parent commits come before their children.
  • This is equivalent to running git log --topo-order.

📝 New blog posts​

Check out the new blog posts from the community members:

• An introduction to git-cliff for release management: Learn how to automate your software releases
• Git-cliff and monorepos: An introduction to the monorepo capabilities of git-cliff

🛡️ Remove tj-actions​

There was a security issue reported in the tj-actions organization.

There is also a GitHub Action created for git-cliff: tj-actions/git-cliff.

The action seems to be unaffected by the compromise, but I have removed all the references to it from the documentation and the website for safety.

🐛 Various Bug Fixes​

• (bump) Check the next version against tag_pattern regex (#1070) - (c4f0d28)
• (bump) Accept lowercase values for bump_type config (#1101) - (77632b2)
• (git) Handle worktrees while retrieving the path of repository (#1054) - (fab02b0)
• (remote) Fix detection of GitLab merge request sha if commits were squashed (#1043) - (5f3a3d0)
• (submodules) Fix submodules handling when using custom range (#1136) - (451a694)
• (template) Correctly serialize JSON for the commit fields (#1145) - (e981e1d)

🧰 Other​

• (project) Migrate to Rust 2024 edition (#1128) - (4445f06)
• (config) Initialize config structs with default values (#1090) - (9e4bd07)
• (quickstart) Clarify git-cliff command (#1051) - (cd26bb2)
• (security) Extend security policy (#1142) - (4c3c946)

New Contributors ❤️​

• @ognis1205 made their first contribution in #1145
• @janderssonse made their first contribution in #1142
• @jdrst made their first contribution in #1138
• @lehmanju made their first contribution in #1136
• @Jean-Beru made their first contribution in #1132
• @william-stacken made their first contribution in #1086
• @SebClapie made their first contribution in #1121
• @okydk made their first contribution in #1051

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! ⛰️

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? ⛰️​

Happy new year! This version of git-cliff comes with quality of life improvements and bug fixes.

The full changelog can be found here.

🔥 Improved Monorepo Support​

There were numerous improvements to the monorepo support in this release:

1. git-cliff now discovers the Git repositories automatically even though when you run from sub directories.

2. The configuration file is now automatically found when running from a sub directory.

3. The include-path is now automatically set to the current directory when running from a sub directory.

As a result, the following command:

$ cd packages/some_library

$ git cliff --include-path "packages/some_library/**/*" --repository "../../"

becomes:

$ cd packages/some_library

$ git cliff # just works!

🛡️ Native TLS Support​

git-cliff now supports enabling native TLS for remote requests. This is useful when you rely on a corporate trust root (e.g., for a mandatory proxy) that's included in your system's certificate store.

To enable it:

$ git cliff --use-native-tls

Or configure it in your cliff.toml:

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

⚙️ Custom Config Name​

You can now specify a custom filename for the configuration while initializing git-cliff:

$ git-cliff --init --config custom.toml

🚨 Better Errors​

Before:

$ git cliff test
 ERROR git_cliff > Git error: `unable to parse OID - contains invalid characters; class=Invalid (3)`

After:

$ git cliff test
 ERROR git_cliff > Failed to set the commit range: unable to parse OID - contains invalid characters; class=Invalid (3)
"test" is not a valid commit range. Did you provide the correct arguments?

🔄 Run with Callback API​

If you are using git-cliff in your Rust project as a library, you can now run it with a callback function to modify the changelog before it's printed:

use clap::Parser;
use git_cliff::args::Opt;
use git_cliff_core::error::Result;

fn main() -> Result<()> {
    let args = Opt::parse();

    git_cliff::run_with_changelog_modifier(args, |changelog| {
        println!("Releases: {:?}", changelog.releases);
        Ok(())
    })?;

    Ok(())
}

🧰 Other​

• (config) Allow environment overwrites when using builtin config (#961) - (7ba3b55)
• (remote) Fix detection of GitLab merge request sha (#968) - (1297655)
• (tips) Extend the merge commit filter example (#963) - (09c0f90)
• (build) Bump MSRV to 1.83.0 - (37598c2)

Contributions 👥​

• @xsadia made their first contribution in #992
• @chenrui333 made their first contribution in #1002
• @hackenbergstefan made their first contribution in #968
• @paul-uz made their first contribution in #963
• @jmartens made their first contribution in #959

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! ⛰️

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!

☘️ 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! ⛰️

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

♾️ 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.

✂️ 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! ⛰️

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:

1. Print context
2. Modify it with an external tool
3. 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.*"

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! ⛰️

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:

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

📤 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-->

🧮 Parse commits by footer​

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! ⛰️

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:

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

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! ⛰️