[ { "path": ".cliffignore", "content": "# skip commits by their SHA1\n\n4f88dda8c746173ea59f920b7579b7f6c74bd6c8\n10c3194381f2cc4f93eb97404369568882ed8677\n" }, { "path": ".dockerignore", "content": "# Directories\n/.git/\n/.github/\n/npm/\n/pypi/\n/website/\n\n# Files\n.editorconfig\n.gitignore\n*.md\ncodecov.yml\nDockerfile\nLICENSE\nrustfmt.toml\n_config.yml\n.lycheeignore\nlychee.toml\n\n# Ignore rust toolchain files as they would needlessly fetch the toolchain.\n# But the image already contains a sufficient toolchain.\n# Ignore both the latest naming and the legacy naming\nrust-toolchain.toml\nrust-toolchain\n" }, { "path": ".editorconfig", "content": "# https://EditorConfig.org\n\n# top-most EditorConfig file\nroot = true\n\n[{*.sh,*.rs}]\nindent_style = space\nindent_size = 4\n" }, { "path": ".envrc", "content": "use flake\ndotenv_if_exists .env\n" }, { "path": ".git-blame-ignore-revs", "content": "00273009e7553229bccc02e9f4a00d6f8acb9cd5\n" }, { "path": ".github/CODEOWNERS", "content": "# See https://help.github.com/articles/about-codeowners/\n# for more info about CODEOWNERS file\n\n# It uses the same pattern rule for gitignore file\n# https://git-scm.com/docs/gitignore#_pattern_format\n\n# Core\n* @orhun\n" }, { "path": ".github/FUNDING.yml", "content": "github: orhun\npatreon: orhunp\nbuy_me_a_coffee: orhun\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.yml", "content": "name: Bug report 🐛\ndescription: Report a bug to help us improve\nlabels: ['bug']\nassignees: \n - orhun\nbody:\n - type: markdown\n attributes:\n value: |\n Thanks for taking the time to fill out this bug report!\n - type: checkboxes\n id: new-bug\n attributes:\n label: Is there an existing issue for this?\n description: Please search to see if an issue already exists for the bug you encountered.\n options:\n - label: I have searched the existing issues\n required: true\n - type: textarea\n id: bug-description\n attributes:\n label: Description of the bug\n description: Tell us what bug you encountered and what should have happened\n validations:\n required: true\n - type: textarea\n id: steps-to-reproduce\n attributes:\n label: Steps To Reproduce\n description: Steps to reproduce the behavior.\n placeholder: |\n Please tell us how to reproduce this bug, for example:\n 1. Build with '...' arguments\n 2. Run with '....' arguments\n 4. Use '...' configuration options\n 5. See the error\n validations:\n required: true\n - type: textarea\n id: expected-behavior\n attributes:\n label: Expected behavior\n description: What should be the expected behavior.\n placeholder: A clear and concise description of what you expected to happen.\n validations:\n required: true\n - type: textarea\n id: screenshots\n attributes:\n label: Screenshots / Logs\n description: If applicable, add screenshots to help explain your problem.\n placeholder: Paste your screenshots here.\n - type: textarea\n id: software-info\n attributes:\n label: Software information\n description: Please provide the following information about your environment.\n value: |\n - Operating system:\n - Rust version:\n - Project version:\n validations:\n required: true\n - type: textarea\n id: additional-context\n attributes:\n label: Additional context\n description: Do you want to share any additional context about this bug?\n placeholder: Add any other context about the problem here.\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "contact_links:\n - name: Discord Chat\n url: https://discord.gg/W3mAwMDWH4\n about: Ask questions and have discussions about git-cliff on Discord\n - name: Matrix Chat\n url: https://matrix.to/#/#git-cliff:matrix.org\n about: Ask questions and have discussions about git-cliff on Matrix\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.yml", "content": "name: Feature request ⛰️ \ndescription: Suggest an idea for this project\nlabels: ['feature/request']\nassignees: \n - orhun\nbody:\n - type: markdown\n attributes:\n value: Thank you for suggesting this feature! The more information you provide, the more likely it is that it will be picked up.\n - type: checkboxes\n id: new-feature\n attributes:\n label: Is there an existing issue or pull request for this?\n description: Please search to see if an issue or pull request already exists for the feature you desire.\n options:\n - label: I have searched the existing issues and pull requests\n required: true\n - type: textarea\n id: feature-description\n attributes:\n label: Feature description\n description: Is your feature request related to a problem? Please describe.\n placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n validations:\n required: true\n - type: textarea\n id: desired-solution\n attributes:\n label: Desired solution\n description: Describe the solution you'd like\n placeholder: A clear and concise description of what you want to happen.\n validations:\n required: true\n - type: textarea\n id: alternatives-considered\n attributes:\n label: Alternatives considered\n description: Describe alternatives you've considered\n placeholder: A clear and concise description of any alternative solutions or features you've considered.\n validations:\n required: true\n - type: textarea\n id: additional-context\n attributes:\n label: Additional context\n description: Do you want to share any additional context about this bug?\n placeholder: Add any other context about the problem here.\n" }, { "path": ".github/ISSUE_TEMPLATE/integration.yml", "content": "name: Integration ⚙️\ndescription: Report a bug or request a feature about an integration (e.g GitHub/GitLab/Gitea/Bitbucket)\nlabels: [\"integration\"]\nassignees:\n - orhun\nbody:\n - type: markdown\n attributes:\n value: |\n Thanks for taking the time to fill out this bug report!\n Please see https://git-cliff.org/docs/category/integration for more information about integrations.\n - type: checkboxes\n id: new-bug\n attributes:\n label: Is there an existing issue for this?\n description: Please search to see if an issue already exists for the bug you encountered.\n options:\n - label: I have searched the existing issues\n required: true\n - type: textarea\n id: bug-description\n attributes:\n label: Description of the bug\n description: Tell us what bug you encountered and what should have happened\n validations:\n required: true\n - type: textarea\n id: steps-to-reproduce\n attributes:\n label: Steps To Reproduce\n description: Steps to reproduce the behavior.\n placeholder: |\n Please tell us how to reproduce this bug, for example:\n 1. Build with '...' arguments\n 2. Run with '....' arguments\n 4. Use '...' configuration options\n 5. See the error\n validations:\n required: true\n - type: textarea\n id: expected-behavior\n attributes:\n label: Expected behavior\n description: What should be the expected behavior.\n placeholder: A clear and concise description of what you expected to happen.\n validations:\n required: true\n - type: textarea\n id: screenshots\n attributes:\n label: Screenshots / Logs\n description: If applicable, add screenshots to help explain your problem.\n placeholder: Paste your screenshots here.\n - type: textarea\n id: software-info\n attributes:\n label: Software information\n description: Please provide the following information about your environment.\n value: |\n - Operating system:\n - Rust version:\n - Project version:\n validations:\n required: true\n - type: textarea\n id: additional-context\n attributes:\n label: Additional context\n description: Do you want to share any additional context about this bug?\n placeholder: Add any other context about the problem here.\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "## Description\n\n\n\n## Motivation and Context\n\n\n\n\n## How Has This Been Tested?\n\n\n\n\n\n## Screenshots / Logs (if applicable)\n\n## Types of Changes\n\n\n\n- [ ] Bug fix (non-breaking change which fixes an issue)\n- [ ] New feature (non-breaking change which adds functionality)\n- [ ] Breaking change (fix or feature that would cause existing functionality to change)\n- [ ] Documentation (no code change)\n- [ ] Refactor (refactoring production code)\n- [ ] Other \n\n## Checklist:\n\n\n\n\n- [ ] My code follows the code style of this project.\n- [ ] I have updated the documentation accordingly (if applicable).\n- [ ] I have formatted the code with [rustfmt](https://github.com/rust-lang/rustfmt).\n - [ ] `cargo +nightly fmt --all`\n- [ ] I checked the lints with [clippy](https://github.com/rust-lang/rust-clippy).\n - [ ] `cargo clippy --tests --verbose -- -D warnings`\n- [ ] I have added tests to cover my changes.\n- [ ] All new and existing tests passed.\n - [ ] `cargo test`\n\n\n" }, { "path": ".github/actions/run-fixtures-test/action.yml", "content": "name: Run a fixtures test\ndescription: Run a fixtures test\n\ninputs:\n fixtures-dir:\n description: Path to the fixtures directory\n required: true\n command:\n description: The git-cliff command to run\n required: false\n default: \"\"\n date-format:\n description: The date format to use\n required: false\n default: \"%Y-%m-%d\"\n previous-release-timestamp:\n description: The timestamp of the previous release\n required: false\n default: \"1970-01-01 00:00:00\"\n\nruns:\n using: composite\n steps:\n - name: Install toolchain\n uses: dtolnay/rust-toolchain@nightly\n\n - name: Install git-cliff\n run: cargo install --path git-cliff/ --profile dev\n shell: bash\n\n - name: Set git config\n run: |\n git config --global user.name \"github-actions[bot]\"\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n shell: bash\n\n - name: Create commits and tags\n working-directory: ${{ inputs.fixtures-dir }}\n run: |\n git init\n ./commit.sh\n shell: bash\n\n - name: Generate a changelog\n working-directory: ${{ inputs.fixtures-dir }}\n shell: bash\n run: |\n set +e\n git cliff --config cliff.toml ${{ inputs.command }} > output.md\n echo \"$?\" > output.rc\n if [ -f output.md ]; then\n cat output.md\n fi\n\n - name: Compare the output with the expected output\n working-directory: ${{ inputs.fixtures-dir }}\n env:\n IN_DATE_FORMAT: ${{ inputs.date-format }}\n IN_PREVIOUS_RELEASE_TIMESTAMP: ${{ inputs.previous-release-timestamp }}\n shell: bash\n run: |\n if [ -f expected.md ]; then\n current_date=$(date +\"$IN_DATE_FORMAT\")\n previous_release_timestamp=\"$IN_PREVIOUS_RELEASE_TIMESTAMP\"\n previous_release_timestamp=$(date -d \"$previous_release_timestamp\" +%s)\n current_release_timestamp=$(date +%s)\n days_since_last_release=$(( (current_release_timestamp - previous_release_timestamp) / 86400 ))\n sed -i \"s/<>/$current_date/g\" expected.md\n sed -i \"s/<>/$days_since_last_release/g\" expected.md\n if ! diff --strip-trailing-cr output.md expected.md; then\n\n echo '> expected'\n cat expected.md\n\n echo '> output'\n cat output.md\n\n echo \"The generated changelog does not match the expected changelog.\"\n exit 1\n fi\n fi\n\n - name: Compare the return code with the expected return code\n working-directory: ${{ inputs.fixtures-dir }}\n shell: bash\n run: |\n if [ -f expected.rc ]; then\n if ! diff --strip-trailing-cr --ignore-all-space output.rc expected.rc; then\n echo \"The return code does not match the expected return code.\"\n exit 1\n fi\n fi\n" }, { "path": ".github/bors.toml", "content": "status = [\n \"Check\",\n \"Lints\",\n \"Formatting\",\n \"Test suite\",\n \"Audit check\",\n \"Links\",\n \"Check Rust version\",\n]\ndelete_merged_branches = true\nupdate_base_for_deletes = true\ncut_body_after = \"
\"\ncommit_title = \"chore(pull): merge ${PR_REFS}\"\n" }, { "path": ".github/config.yml", "content": "# Configuration for welcome - https://github.com/behaviorbot/welcome\n\n# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome\n\n# Comment to be posted to on first time issues\nnewIssueWelcomeComment: >\n Thanks for opening your first issue at **git-cliff**! Be sure to follow the issue template! ⛰️\n\n# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome\n\n# Comment to be posted to on PRs from first time contributors in your repository\nnewPRWelcomeComment: >\n Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️\n\n# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge\n\n# Comment to be posted to on pull requests merged by a first time user\nfirstPRMergeComment: >\n Congrats on merging your first pull request! ⛰️\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n # Maintain dependencies for Cargo\n - package-ecosystem: cargo\n directory: \"/\"\n schedule:\n interval: monthly\n open-pull-requests-limit: 10\n groups:\n minor:\n update-types:\n - \"minor\"\n patch:\n update-types:\n - \"patch\"\n\n # Maintain dependencies for GitHub Actions\n - package-ecosystem: github-actions\n directory: \"/\"\n schedule:\n interval: monthly\n open-pull-requests-limit: 10\n groups:\n minor:\n update-types:\n - \"minor\"\n patch:\n update-types:\n - \"patch\"\n\n # Maintain dependencies for NPM\n - package-ecosystem: \"npm\"\n directory: \"/website\"\n schedule:\n interval: monthly\n open-pull-requests-limit: 10\n groups:\n minor:\n update-types:\n - \"minor\"\n patch:\n update-types:\n - \"patch\"\n\n - package-ecosystem: npm\n directory: /npm/git-cliff\n schedule:\n interval: monthly\n open-pull-requests-limit: 10\n groups:\n minor:\n update-types:\n - \"minor\"\n patch:\n update-types:\n - \"patch\"\n ignore:\n # We intentionally ignore semver-major updates to avoid\n # PR noise when new Node versions are released.\n # Revisit this when updating the supported Node.js range.\n - dependency-name: \"@types/node\"\n update-types: [\"version-update:semver-major\"]\n\n # Maintain dependencies for Docker\n - package-ecosystem: docker\n directory: /\n schedule:\n interval: monthly\n open-pull-requests-limit: 10\n" }, { "path": ".github/fixtures/README.md", "content": "# Fixtures\n\n[Test fixtures](https://en.wikipedia.org/wiki/Test_fixture) are a way of testing the `git-cliff`'s functionality against a configuration file (`cliff.toml`) and asserting the output (`expected.md`).\n\nThey are being [run](https://github.com/orhun/git-cliff/actions/workflows/test-fixtures.yml) as a part of the GitHub Actions and the workflow file can be viewed [here](../workflows/test-fixtures.yml).\n\n## Adding new fixtures\n\n1. Copy the `new-fixture-template` as `test-`.\n2. Update the files accordingly to the function that is being tested.\n3. Run the fixture locally. (see below)\n4. Add the fixture to [`test-fixtures.yml`](../workflows/test-fixtures.yml) matrix.\n - If you need to specify custom arguments to `git-cliff` for the fixture test, you can do it here with using `command`.\n5. Commit your changes.\n\nSee [this commit](https://github.com/orhun/git-cliff/commit/c94cb6a37ae268953ab29dd35cb43b6a4fec47cc) as an example.\n\n## Running locally\n\nTo run the fixtures locally:\n\n```sh\n./test-fixtures-locally.sh \n```\n\n## See also\n\n- [Contribution Guidelines](https://github.com/orhun/git-cliff/blob/main/CONTRIBUTING.md)\n" }, { "path": ".github/fixtures/new-fixture-template/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/new-fixture-template/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/new-fixture-template/expected.md", "content": "## [unreleased]\n\n### Test\n\n- Add tests\n\n## [0.2.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 2\n\n### Features\n\n- Add feature 2\n\n## [0.1.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 1\n\n### Features\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-always-render/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% if commits | length == 0 %}\nNo significant changes.\n\n{% else %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") -%}\n ### {{ group | upper_first }}\n etc.\n{% endfor %}\n{% endif %}\\\n\"\"\"\n# render body even when there are no releases to process\nrender_always = true\n" }, { "path": ".github/fixtures/test-always-render/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-always-render/expected.md", "content": "## [0.2.0] - <>\n\nNo significant changes.\n\n" }, { "path": ".github/fixtures/test-always-render-unreleased/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% if commits | length == 0 %}\nNo significant changes.\n\n{% else %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") -%}\n ### {{ group | upper_first }}\n etc.\n{% endfor %}\n{% endif %}\\\n\"\"\"\n# render body even when there are no releases to process\nrender_always = true\n" }, { "path": ".github/fixtures/test-always-render-unreleased/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-always-render-unreleased/expected.md", "content": "## [unreleased]\n\nNo significant changes.\n\n" }, { "path": ".github/fixtures/test-azure-devops-integration/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# Azure DevOps integration for fetching commit metadata.\n[remote.azure_devops]\nowner = \"shiftme/gitcliff\"\nrepo = \"git-cliff-readme-example\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{%- macro remote_url() -%}\n https://dev.azure.com/{{ remote.azure_devops.owner }}/_git/{{ remote.azure_devops.repo }}\n{%- endmacro -%}\n\n## What's Changed\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in \\\n [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pullrequest/{{ commit.remote.pr_number }})\\\n {%- endif %}\n{%- endfor -%}\n\n{% if azure_devops.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in azure_devops.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pullrequest/{{ contributor.pr_number }}) \\\n {%- endif %}\n{% endfor %}\\\n\\n\\n\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n" }, { "path": ".github/fixtures/test-azure-devops-integration/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://dev.azure.com/shiftme/gitcliff/_git/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-azure-devops-integration/expected.md", "content": "## What's Changed\n* feat(config): support multiple file formats by @orhun\n* feat(cache): use cache while fetching pages by @orhun\n\n## What's Changed in v1.0.1\n* refactor(parser): expose string functions by @orhun\n* chore(release): add release script by @orhun\n\n## What's Changed in v1.0.0\n* Initial commit by @orhun\n* docs(project): add README.md by @orhun\n* feat(parser): add ability to parse arrays by @orhun\n* fix(args): rename help argument due to conflict by @orhun\n* docs(example)!: add tested usage example by @orhun\n\n### New Contributors\n* @orhun made their first contribution\n\n\n" }, { "path": ".github/fixtures/test-azure-devops-integration-custom-range/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# Azure DevOps integration for fetching commit metadata.\n[remote.azure_devops]\nowner = \"shiftme/gitcliff\"\nrepo = \"git-cliff-readme-example\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{%- macro remote_url() -%}\n https://dev.azure.com/{{ remote.azure_devops.owner }}/_git/{{ remote.azure_devops.repo }}\n{%- endmacro -%}\n\n## What's Changed\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in \\\n [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pullrequest/{{ commit.remote.pr_number }})\\\n {%- endif %}\n{%- endfor -%}\n\n{% if azure_devops.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in azure_devops.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pullrequest/{{ contributor.pr_number }}) \\\n {%- endif %}\n{% endfor %}\\\n\\n\\n\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n" }, { "path": ".github/fixtures/test-azure-devops-integration-custom-range/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://dev.azure.com/shiftme/gitcliff/_git/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-azure-devops-integration-custom-range/expected.md", "content": "## What's Changed in v1.0.1\n* refactor(parser): expose string functions by @orhun\n* chore(release): add release script by @orhun\n\n" }, { "path": ".github/fixtures/test-bitbucket-integration/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# Bitbucket integration for fetching commit metadata.\n[remote.bitbucket]\nowner = \"mcwarman-playground\"\nrepo = \"git-cliff-readme-example\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{%- macro remote_url() -%}\n https://bitbucket.org/{{ remote.bitbucket.owner }}/{{ remote.bitbucket.repo }}\n{%- endmacro -%}\n\n## What's Changed\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in \\\n [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull-requests/{{ commit.remote.pr_number }})\\\n {%- endif %}\n{%- endfor -%}\n\n{% if bitbucket.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in bitbucket.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull-requests/{{ contributor.pr_number }}) \\\n {%- endif %}\n{% endfor %}\\\n\\n\\n\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n" }, { "path": ".github/fixtures/test-bitbucket-integration/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://bitbucket.org/mcwarman-playground/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-bitbucket-integration/expected.md", "content": "## What's Changed\n* feat(config): support multiple file formats by @orhun \n* feat(cache): use cache while fetching pages by @orhun \n* feat(ci): add pipeline config by @mcwarman <7236500+mcwarman@users.noreply.github.com> in [#1](https://bitbucket.org/mcwarman-playground/git-cliff-readme-example/pull-requests/1)\n\n## What's Changed in v1.0.1\n* refactor(parser): expose string functions by @orhun \n* chore(release): add release script by @orhun \n\n## What's Changed in v1.0.0\n* Initial commit by @orhun \n* docs(project): add README.md by @orhun \n* feat(parser): add ability to parse arrays by @orhun \n* fix(args): rename help argument due to conflict by @orhun \n* docs(example)!: add tested usage example by @orhun \n\n### New Contributors\n* @orhun made their first contribution\n\n\n" }, { "path": ".github/fixtures/test-bitbucket-integration-custom-range/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# Bitbucket integration for fetching commit metadata.\n[remote.bitbucket]\nowner = \"mcwarman-playground\"\nrepo = \"git-cliff-readme-example\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{%- macro remote_url() -%}\n https://bitbucket.org/{{ remote.bitbucket.owner }}/{{ remote.bitbucket.repo }}\n{%- endmacro -%}\n\n## What's Changed\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in \\\n [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull-requests/{{ commit.remote.pr_number }})\\\n {%- endif %}\n{%- endfor -%}\n\n{% if bitbucket.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in bitbucket.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull-requests/{{ contributor.pr_number }}) \\\n {%- endif %}\n{% endfor %}\\\n\\n\\n\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n" }, { "path": ".github/fixtures/test-bitbucket-integration-custom-range/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://bitbucket.org/mcwarman-playground/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-bitbucket-integration-custom-range/expected.md", "content": "## What's Changed in v1.0.1\n* refactor(parser): expose string functions by @orhun \n* chore(release): add release script by @orhun \n\n" }, { "path": ".github/fixtures/test-bump-initial-tag/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n\n[bump]\ninitial_tag = \"1.15.5\"\n" }, { "path": ".github/fixtures/test-bump-initial-tag/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/test-bump-initial-tag/expected.md", "content": "## [1.15.5]\n\n### Test\n\n- Add tests\n\n" }, { "path": ".github/fixtures/test-bump-initial-tag-cli-arg/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n\n[bump]\ninitial_tag = \"test\"\n" }, { "path": ".github/fixtures/test-bump-initial-tag-cli-arg/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/test-bump-initial-tag-cli-arg/expected.md", "content": "## [2.1.1]\n\n### Test\n\n- Add tests\n\n" }, { "path": ".github/fixtures/test-bump-initial-tag-default/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-bump-initial-tag-default/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/test-bump-initial-tag-default/expected.md", "content": "## [0.1.0]\n\n### Test\n\n- Add tests\n\n" }, { "path": ".github/fixtures/test-bump-unreleased-with-tag-message-arg/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n {% if message %}\n {{ message }}\n {% endif %}\\\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# regex for parsing and grouping commits\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-bump-unreleased-with-tag-message-arg/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/test-bump-unreleased-with-tag-message-arg/expected.md", "content": "## [0.2.1]\n\nSome text\n\n### Test\n\n- Add tests\n\n" }, { "path": ".github/fixtures/test-bump-version/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n" }, { "path": ".github/fixtures/test-bump-version/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat!: add breaking feature\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 2\"\n" }, { "path": ".github/fixtures/test-bump-version/expected.md", "content": "## [1.0.0]\n\n### 🚀 Features\n\n- [**breaking**] Add breaking feature\n\n### 🐛 Bug Fixes\n\n- Fix feature 2\n\n## [0.1.0]\n\n### 🚀 Features\n\n- Add feature 1\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-bump-version-custom-minor/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[bump]\nfeatures_always_bump_minor = true\nbreaking_always_bump_major = true\ncustom_minor_increment_regex = \"minor|more\"\n" }, { "path": ".github/fixtures/test-bump-version-custom-minor/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"minor: add minor\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 2\"\n" }, { "path": ".github/fixtures/test-bump-version-custom-minor/expected.md", "content": "## [0.2.0]\n\n### 🐛 Bug Fixes\n\n- Fix feature 2\n\n### 💼 Other\n\n- Add minor\n\n## [0.1.0]\n\n### 🚀 Features\n\n- Add feature 1\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-bump-version-keep-zerover/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[bump]\nfeatures_always_bump_minor = false\nbreaking_always_bump_major = false\n" }, { "path": ".github/fixtures/test-bump-version-keep-zerover/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat!: add breaking feature\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 2\"\n" }, { "path": ".github/fixtures/test-bump-version-keep-zerover/expected.md", "content": "## [0.2.0]\n\n### Feat\n\n- [**breaking**] Add breaking feature\n\n### Fix\n\n- Fix feature 2\n\n## [0.1.0]\n\n### Feat\n\n- Add feature 1\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-bump-version-major/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n" }, { "path": ".github/fixtures/test-bump-version-major/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 2\"\n" }, { "path": ".github/fixtures/test-bump-version-major/expected.md", "content": "## [1.0.0]\n\n### 🐛 Bug Fixes\n\n- Fix feature 1\n- Fix feature 2\n\n## [0.1.0]\n\n### 🚀 Features\n\n- Add feature 1\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-bump-version-minor/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n" }, { "path": ".github/fixtures/test-bump-version-minor/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat!: add breaking feature\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 2\"\n" }, { "path": ".github/fixtures/test-bump-version-minor/expected.md", "content": "## [0.2.0]\n\n### 🚀 Features\n\n- [**breaking**] Add breaking feature\n\n### 🐛 Bug Fixes\n\n- Fix feature 2\n\n## [0.1.0]\n\n### 🚀 Features\n\n- Add feature 1\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-bump-version-patch/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n" }, { "path": ".github/fixtures/test-bump-version-patch/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat!: add breaking feature\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 2\"\n" }, { "path": ".github/fixtures/test-bump-version-patch/expected.md", "content": "## [0.1.1]\n\n### 🚀 Features\n\n- [**breaking**] Add breaking feature\n\n### 🐛 Bug Fixes\n\n- Fix feature 2\n\n## [0.1.0]\n\n### 🚀 Features\n\n- Add feature 1\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-bumped-version/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n" }, { "path": ".github/fixtures/test-bumped-version/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 2\"\n" }, { "path": ".github/fixtures/test-bumped-version/expected.md", "content": "v0.1.1\n" }, { "path": ".github/fixtures/test-cli-arg-ignore-tags/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# regex for skipping tags\nskip_tags = \"\"\n# regex for ignoring tags\nignore_tags = \"\"\n" }, { "path": ".github/fixtures/test-cli-arg-ignore-tags/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add first beta feature\"\ngit tag v1.0.0-beta.1\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat: add second beta feature\"\ngit tag v1.0.0-beta.2\n\n# WARNING: If we won't create this commit, 1.0.0 won't be created!\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"chore: why do i need a commit here?\"\ngit tag v1.0.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:49\" git commit --allow-empty -m \"fix: simple fix\"\ngit tag v1.0.1\n" }, { "path": ".github/fixtures/test-cli-arg-ignore-tags/expected.md", "content": "## [1.0.1] - 2021-01-23\n\n### 🐛 Bug Fixes\n\n- Simple fix\n\n## [1.0.0] - 2021-01-23\n\n### 🚀 Features\n\n- Add first beta feature\n- Add second beta feature\n\n### ⚙️ Miscellaneous Tasks\n\n- Why do i need a commit here?\n\n" }, { "path": ".github/fixtures/test-cli-arg-skip-tags/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# regex for skipping tags\nskip_tags = \"\"\n# regex for ignoring tags\nignore_tags = \"\"\n" }, { "path": ".github/fixtures/test-cli-arg-skip-tags/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add first beta feature\"\ngit tag v1.0.0-beta.1\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat: add second beta feature\"\ngit tag v1.0.0-beta.2\n\n# WARNING: If we won't create this commit, 1.0.0 won't be created!\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"chore: why do i need a commit here?\"\ngit tag v1.0.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:49\" git commit --allow-empty -m \"fix: simple fix\"\ngit tag v1.0.1\n" }, { "path": ".github/fixtures/test-cli-arg-skip-tags/expected.md", "content": "## [1.0.1] - 2021-01-23\n\n### 🐛 Bug Fixes\n\n- Simple fix\n\n## [1.0.0] - 2021-01-23\n\n### ⚙️ Miscellaneous Tasks\n\n- Why do i need a commit here?\n\n" }, { "path": ".github/fixtures/test-commit-footers/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% if commit.footers %}\\\n {% for footer in commit.footers -%}\n , {{ footer.token }}{{ footer.separator }}{{ footer.value }}\\\n {% endfor %}\\\n {% endif %}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n" }, { "path": ".github/fixtures/test-commit-footers/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\" -m \"footer: test\"\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat: add feature 2\" -m \"Signed-off-by: bot\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"fix: fix feature 1\" -m \"footer1: xyz\" -m \"footer2: abc\"\n" }, { "path": ".github/fixtures/test-commit-footers/expected.md", "content": "## [unreleased]\n\n### 🐛 Bug Fixes\n\n- Fix feature 1, footer1:xyz, footer2:abc\n\n## [0.1.0] - 2021-01-23\n\n### 🚀 Features\n\n- Add feature 1, footer:test\n- Add feature 2, Signed-off-by:bot\n\n" }, { "path": ".github/fixtures/test-commit-preprocessors/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Replace issue numbers with links to the issue.\n { pattern = '\\(#([0-9]+)\\)', replace = \"([issue#${1}](https://github.com/orhun/git-cliff/issues/${1}))\" },\n # Trim multiple spaces.\n { pattern = \" +\", replace = \" \" },\n]\n" }, { "path": ".github/fixtures/test-commit-preprocessors/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1 (#1)\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"refactor: move classes\"\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-commit-preprocessors/expected.md", "content": "## [0.1.0] - 2022-04-06\n\n### 🚀 Features\n\n- Add feature 1\n\n### 🐛 Bug Fixes\n\n- Fix feature 1 ([issue#1](https://github.com/orhun/git-cliff/issues/1))\n\n### 🚜 Refactor\n\n- Move classes\n\n" }, { "path": ".github/fixtures/test-commit-range/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\n{{ commit_range.from }}..{{ commit_range.to }}\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-commit-range/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-commit-range/expected.md", "content": "## [unreleased]\n\na9d4050212a18f6b3bd76e2e41fbb9045d268b80..df6aef41292f3ffe5887754232e6ea7831c50ba5\n\n### Features\n\n- Support multiple file formats\n- Use cache while fetching pages\n\n## [1.0.1] - 2021-07-18\n\ne4fd3cf8e2e6f49c0b57f66416e886c37cbb3715..06412ac1dd4071006c465dde6597a21d4367a158\n\n### Chore\n\n- Add release script\n\n### Refactor\n\n- Expose string functions\n\n## [1.0.0] - 2021-07-18\n\na78bc368e9ee382a3016c0c4bab41f7de4503bcd..ad27b43e8032671afb4809a1a3ecf12f45c60e0e\n\n### Bug Fixes\n\n- Rename help argument due to conflict\n\n### Features\n\n- Add ability to parse arrays\n\n### Docs\n\n- Add README.md\n- Add tested usage example\n\n" }, { "path": ".github/fixtures/test-commit-range-with-given-range/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\n{{ commit_range.from }}..{{ commit_range.to }}\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-commit-range-with-given-range/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-commit-range-with-given-range/expected.md", "content": "## [unreleased]\n\na140cef0405e0bcbfb5de44ff59e091527d91b38..a9d4050212a18f6b3bd76e2e41fbb9045d268b80\n\n### Bug Fixes\n\n- Rename help argument due to conflict\n\n### Features\n\n- Add ability to parse arrays\n- Support multiple file formats\n\n### Chore\n\n- Add release script\n\n### Docs\n\n- Add tested usage example\n\n### Refactor\n\n- Expose string functions\n\n" }, { "path": ".github/fixtures/test-commit-range-with-sort-commits/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\n{{ commit_range.from }}..{{ commit_range.to }}\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\nsort_commits = \"newest\"\n" }, { "path": ".github/fixtures/test-commit-range-with-sort-commits/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-commit-range-with-sort-commits/expected.md", "content": "## [unreleased]\n\na9d4050212a18f6b3bd76e2e41fbb9045d268b80..df6aef41292f3ffe5887754232e6ea7831c50ba5\n\n### Features\n\n- Use cache while fetching pages\n- Support multiple file formats\n\n## [1.0.1] - 2021-07-18\n\ne4fd3cf8e2e6f49c0b57f66416e886c37cbb3715..06412ac1dd4071006c465dde6597a21d4367a158\n\n### Chore\n\n- Add release script\n\n### Refactor\n\n- Expose string functions\n\n## [1.0.0] - 2021-07-18\n\na78bc368e9ee382a3016c0c4bab41f7de4503bcd..ad27b43e8032671afb4809a1a3ecf12f45c60e0e\n\n### Bug Fixes\n\n- Rename help argument due to conflict\n\n### Features\n\n- Add ability to parse arrays\n\n### Docs\n\n- Add tested usage example\n- Add README.md\n\n" }, { "path": ".github/fixtures/test-configure-from-cargo-toml/Cargo.toml", "content": "[package]\nname = \"test\"\nversion = \"0.1.0\"\nedition = \"2021\"\n\n[package.metadata.git-cliff.changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n\n[package.metadata.git-cliff.git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-configure-from-cargo-toml/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/test-configure-from-cargo-toml/expected.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\n## [unreleased]\n\n### Test\n\n- Add tests\n\n## [0.2.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 2\n\n### Features\n\n- Add feature 2\n\n## [0.1.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 1\n\n### Features\n\n- Add feature 1\n\n\n" }, { "path": ".github/fixtures/test-conventional-commit/cliff.toml", "content": "[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% for group, commits in commits | group_by(attribute=\"group\") %}\\\n ## {{ group | striptags | trim | upper_first }}\n {% for commit in commits %}\n {% if commit.scope %}*({{ commit.scope }})* {% endif %}\\\n {% if commit.breaking %}[**breaking**]: {{ commit.breaking_description }}{% endif %}\n {{ commit.message }}: {{ commit.body }}\\\n {% for footer in commit.footers %}\n - {{ footer.token }}{{ footer.separator }} {{ footer.value }}\\\n {% endfor %}\n {% endfor %}\n{% endfor %}\\\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\" },\n]\n" }, { "path": ".github/fixtures/test-conventional-commit/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \\\n \"feat(web): feature 1, breaking change in footer\n\nBody feature 1\n\nBREAKING CHANGE: breaking change description feature 1\nSigned-off-by: user1 \nReviewed-by: user2\n\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \\\n \"feat(web)!: feature 2, breaking chain in description\n\nBody feature 2\n\nSigned-off-by: user3 \n\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \\\n \"feat!: feature 3, use default scope = app\n\nBody feature 2\n\nSigned-off-by: user3 \n\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \\\n \"fix(scope): fix 1, use scope as group\n\nBody fix 1\n\nFix: #1\n\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \\\n \"fix(front-end): fix 2, no footer\n\nBody fix 2\n\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:14\" git commit --allow-empty -m \\\n \"fix(front-end): fix 3 and 4, no body but footer\n\nFix: #3\nFix: #4\n\"\n\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-conventional-commit/expected.md", "content": "## Features\n\n*(web)* [**breaking**]: breaking change description feature 1\nfeature 1, breaking change in footer: Body feature 1\n- BREAKING CHANGE: breaking change description feature 1\n- Signed-off-by: user1 \n- Reviewed-by: user2\n\n*(web)* [**breaking**]: feature 2, breaking chain in description\nfeature 2, breaking chain in description: Body feature 2\n- Signed-off-by: user3 \n\n*(app)* [**breaking**]: feature 3, use default scope = app\nfeature 3, use default scope = app: Body feature 2\n- Signed-off-by: user3 \n\n## Fix\n\n*(scope)* \nfix 1, use scope as group: Body fix 1\n- Fix: #1\n\n*(front-end)* \nfix 2, no footer: Body fix 2\n\n*(front-end)* \nfix 3 and 4, no body but footer: \n- Fix: #3\n- Fix: #4\n\n" }, { "path": ".github/fixtures/test-custom-remote-api-url/cliff.toml", "content": "[remote.gitlab]\nowner = \"archlinux\"\nrepo = \"arch-repro-status\"\napi_url = \"https://gitlab.archlinux.org/api/v4\"\n\n[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n## What's Changed\n\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}\n{%- endfor -%}\n\n{% if gitlab.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in gitlab.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \\\n {%- endif %}\n{%- endfor -%}\n\n{% if version %}\n {% if previous.version %}\n **Full Changelog**: https://gitlab.com/{{ remote.gitlab.owner }}/{{ remote.gitlab.repo }}/compare/{{ previous.version }}...{{ version }}\n {% endif %}\n{% else -%}\n {% raw %}\\n{% endraw %}\n{% endif %}\n\"\"\"\n\n[git]\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = []\n" }, { "path": ".github/fixtures/test-custom-remote-api-url/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://gitlab.archlinux.org/archlinux/arch-repro-status\ngit fetch\ngit checkout 5fe2f324db566756ccaf066fe186100a09a87625\n" }, { "path": ".github/fixtures/test-custom-remote-api-url/expected.md", "content": "## What's Changed in v1.4.1\n* Update the copyright year in license by @Orhun Parmaksız\n* bump dependencies by @Orhun Parmaksız\n* update cargo-deny config by @Orhun Parmaksız\n* prepare for 1.4.1 by @Orhun Parmaksız\n\n**Full Changelog**: https://gitlab.com/archlinux/arch-repro-status/compare/v1.4.0...v1.4.1\n\n" }, { "path": ".github/fixtures/test-custom-scope/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for group, commits in commits | group_by(attribute=\"scope\") %}\n #### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n {% endfor %}\\\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-custom-scope/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-custom-scope/expected.md", "content": "## [0.1.0] - 2022-04-06\n\n### Bug Fixes\n\n#### Cli\n\n- Fix feature 1\n- Fix feature 2\n\n### Features\n\n#### App\n\n- Add feature 1\n\n#### Gui\n\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-custom-tag-pattern/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"alpha-\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-custom-tag-pattern/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag beta-0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag alpha-0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\ngit tag beta-0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag alpha-0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/test-custom-tag-pattern/expected.md", "content": "## [unreleased]\n\n### Test\n\n- Add tests\n\n## [0.2.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 2\n\n### Features\n\n- Add feature 2\n\n## [0.1.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 1\n\n### Features\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-date-order/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n" }, { "path": ".github/fixtures/test-date-order/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.2.0\n\ngit checkout v0.1.0\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"feat: fix feature 1\"\ngit tag v0.1.1\n" }, { "path": ".github/fixtures/test-date-order/expected.md", "content": "## [0.1.1] - 2021-01-23\n\n### 🚀 Features\n\n- Fix feature 1\n\n" }, { "path": ".github/fixtures/test-fail-on-unmatched-commit/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for group, commits in commits | group_by(attribute=\"scope\") %}\n #### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n {% endfor %}\\\n{% endfor %}\\n\n\"\"\"\n\n[git]\nfail_on_unmatched_commit = true\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", skip = true },\n { message = \"Initial commit\", skip = true },\n]\n# Prevent commits that are breaking from being excluded by commit parsers.\nprotect_breaking_commits = true\n" }, { "path": ".github/fixtures/test-fail-on-unmatched-commit/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"invalid: text text\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui)!: add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui)!: fix feature 2\"\n\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-fail-on-unmatched-commit/expected.rc", "content": "1" }, { "path": ".github/fixtures/test-fixtures-locally.sh", "content": "#!/usr/bin/env bash\nset -e\n\nSCRIPT_DIR=$(readlink -f \"$(dirname \"$0\")\")\n\nif [ -z \"$1\" ]; then\n\techo \"Please input a fixture name.\"\n\texit 1\nfi\n\nexport FIXTURES_DIR=\"$SCRIPT_DIR/$1\"\n\n# Set up a temporary repository\ncd \"$(mktemp -d)\"\ngit init >&2\n\n# Commit\n\"$FIXTURES_DIR/commit.sh\"\n\n# Check if we are running on Windows with MINGW64 and if cygpath is available\nif [ -n \"$MSYSTEM\" ] && [ \"$MSYSTEM\" = \"MINGW64\" ]; then\n echo \"Running inside MINGW64 trying to convert paths to Windows format.\"\n if command -v cygpath > /dev/null 2>&1; then\n # Convert the path to Windows format\n SCRIPT_DIR=$(cygpath -w \"$SCRIPT_DIR\")\n FIXTURES_DIR=$(cygpath -w \"$FIXTURES_DIR\")\n else\n echo \"WARNING: cygpath command not found in the PATH. The script may not work correctly on Windows.\"\n exit 1\n fi\nfi\n\n# Show results\necho -e \"\\n---Run git-cliff---\" >&2\ncargo run --manifest-path \"$SCRIPT_DIR/../../Cargo.toml\" -- -vv --config \"$FIXTURES_DIR/cliff.toml\" \"${@:2}\" -o \"$FIXTURES_DIR/output.md\"\n\nsed -i \"s/2022-04-05/2022-04-06/g\" \"$FIXTURES_DIR/output.md\"\n\ndiff --strip-trailing-cr \"$FIXTURES_DIR/output.md\" \"$FIXTURES_DIR/expected.md\"\n" }, { "path": ".github/fixtures/test-footer-filter/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# regex for parsing and grouping commits\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n # Accept both separators, \": \" and \":\".\n # Conventional commits require the separator to be \": \", but the reference implementation of the\n # conventional commits parser currently does not adhere to the specification. See also:\n # https://github.com/conventional-commits/parser/issues/47\n { footer = \"^changelog: ?ignore\", skip = true },\n]\n" }, { "path": ".github/fixtures/test-footer-filter/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 00:00:00\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 00:10:00\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:00:00\" git commit --allow-empty -m \"refactor: change feature 1\" -m \"BREAKING CHANGE: feature 1 is now different\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:10:00\" git commit --allow-empty -m \"chore: upgrade dependencies\" -m \"changelog: ignore\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 02:00:00\" git commit --allow-empty -m \"test: add tests\" -m \"footer: some more info\"\nGIT_COMMITTER_DATE=\"2022-04-06 02:10:00\" git commit --allow-empty -m \"test: add more tests\" -m \"changelog: ignore\"\n" }, { "path": ".github/fixtures/test-footer-filter/expected.md", "content": "## [unreleased]\n\n### Test\n\n- Add tests\n\n## [0.2.0] - 2022-04-06\n\n### Refactor\n\n- Change feature 1\n\n## [0.1.0] - 2022-04-06\n\n### Features\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-footer-template/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n{% for release in releases %}\\\n {% if release.version %}\\\n {% if release.previous.version %}\\\n \n {% endif %}\\\n {% else %}\\\n \n {% endif %}\\\n{% endfor %}\\\n\"\"\"\n" }, { "path": ".github/fixtures/test-footer-template/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 2\"\ngit tag v0.2.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"feat: add footer\"\ngit tag v3.0.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"test: footer\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"perf: footer\"\n" }, { "path": ".github/fixtures/test-footer-template/expected.md", "content": "## [unreleased]\n\n### ⚡ Performance\n\n- Footer\n\n### 🧪 Testing\n\n- Footer\n\n## [3.0.0]\n\n### 🚀 Features\n\n- Add footer\n\n## [0.2.0]\n\n### 🐛 Bug Fixes\n\n- Fix feature 1\n- Fix feature 2\n\n## [0.1.0]\n\n### 🚀 Features\n\n- Add feature 1\n- Add feature 2\n\n\n\n\n\n" }, { "path": ".github/fixtures/test-from-context/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}{% if extra.note %} - {{ extra.note }}{% endif %}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}{% if commit.extra.note %} ({{ commit.extra.note }}){% endif %}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# regex for parsing and grouping commits\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-from-context/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2 SHOULD NOT BE IN THE CHANGELOG\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/test-from-context/context.json", "content": "[\n {\n \"version\": null,\n \"message\": null,\n \"commits\": [\n {\n \"id\": \"c7541276668616c136d12a9ccd87087314d66fb6\",\n \"message\": \"add tests\",\n \"body\": null,\n \"footers\": [],\n \"group\": \"test\",\n \"breaking_description\": null,\n \"breaking\": false,\n \"scope\": null,\n \"links\": [],\n \"author\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1723730666\n },\n \"committer\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1649201113\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n }\n }\n ],\n \"commit_id\": null,\n \"timestamp\": 0,\n \"previous\": {\n \"version\": \"v0.2.0\",\n \"message\": null,\n \"commits\": [\n {\n \"id\": \"ce8cecc9834e5cbdb5b4e79c8260cace3c0dd949\",\n \"message\": \"feat(gui): add feature 2\\n\",\n \"group\": null,\n \"scope\": null,\n \"links\": [],\n \"author\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1723730666\n },\n \"committer\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1649201111\n },\n \"conventional\": false,\n \"merge_commit\": false,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n }\n },\n {\n \"id\": \"5061081d6272b1da2146fab49d803c193db309d9\",\n \"message\": \"fix(gui): fix feature 2\\n\",\n \"group\": null,\n \"scope\": null,\n \"links\": [],\n \"author\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1723730666\n },\n \"committer\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1649201112\n },\n \"conventional\": false,\n \"merge_commit\": false,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n }\n }\n ],\n \"commit_id\": \"5061081d6272b1da2146fab49d803c193db309d9\",\n \"timestamp\": 1649201112,\n \"previous\": null,\n \"repository\": \"/home/johndoe/repo/\",\n \"commit_range\": null,\n \"submodule_commits\": {},\n \"github\": {\n \"contributors\": []\n },\n \"gitlab\": {\n \"contributors\": []\n },\n \"gitea\": {\n \"contributors\": []\n },\n \"bitbucket\": {\n \"contributors\": []\n },\n \"azure_devops\": {\n \"contributors\": []\n }\n },\n \"repository\": \"/home/johndoe/repo/\",\n \"commit_range\": null,\n \"submodule_commits\": {},\n \"github\": {\n \"contributors\": []\n },\n \"gitlab\": {\n \"contributors\": []\n },\n \"gitea\": {\n \"contributors\": []\n },\n \"bitbucket\": {\n \"contributors\": []\n },\n \"azure_devops\": {\n \"contributors\": []\n }\n },\n {\n \"version\": \"v0.2.0\",\n \"message\": null,\n \"commits\": [\n {\n \"id\": \"ce8cecc9834e5cbdb5b4e79c8260cace3c0dd949\",\n \"message\": \"add feature 2\",\n \"body\": null,\n \"footers\": [],\n \"group\": \"Features\",\n \"breaking_description\": null,\n \"breaking\": false,\n \"scope\": \"gui\",\n \"links\": [],\n \"author\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1723730666\n },\n \"committer\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1649201111\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n }\n },\n {\n \"id\": \"5061081d6272b1da2146fab49d803c193db309d9\",\n \"message\": \"fix feature 2\",\n \"body\": null,\n \"footers\": [],\n \"group\": \"Bug Fixes\",\n \"breaking_description\": null,\n \"breaking\": false,\n \"scope\": \"cli\",\n \"links\": [],\n \"author\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1723730666\n },\n \"committer\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1649201112\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"extra\": {\n \"note\": \"that was a tough one\"\n },\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n }\n }\n ],\n \"commit_id\": \"5061081d6272b1da2146fab49d803c193db309d9\",\n \"timestamp\": 1649201112,\n \"previous\": {\n \"version\": \"v0.1.0\",\n \"message\": null,\n \"commits\": [\n {\n \"id\": \"c6ba7fe73c3b639ff2f934f3f98e5f50350ab463\",\n \"message\": \"Initial commit\\n\",\n \"group\": null,\n \"scope\": null,\n \"links\": [],\n \"author\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1723730666\n },\n \"committer\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1649201108\n },\n \"conventional\": false,\n \"merge_commit\": false,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n }\n },\n {\n \"id\": \"9c10e506bf103998e303d8164c7b4a1a841e2471\",\n \"message\": \"feat: add feature 1\\n\",\n \"group\": null,\n \"scope\": null,\n \"links\": [],\n \"author\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1723730666\n },\n \"committer\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1649201109\n },\n \"conventional\": false,\n \"merge_commit\": false,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n }\n },\n {\n \"id\": \"98b1464c2f99a0c6812ce6d3ea4a5b953dd35fe2\",\n \"message\": \"fix: fix feature 1\\n\",\n \"group\": null,\n \"scope\": null,\n \"links\": [],\n \"author\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1723730666\n },\n \"committer\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1649201110\n },\n \"conventional\": false,\n \"merge_commit\": false,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n }\n }\n ],\n \"commit_id\": \"98b1464c2f99a0c6812ce6d3ea4a5b953dd35fe2\",\n \"timestamp\": 1649201110,\n \"previous\": null,\n \"repository\": \"/home/johndoe/repo/\",\n \"commit_range\": null,\n \"submodule_commits\": {},\n \"github\": {\n \"contributors\": []\n },\n \"gitlab\": {\n \"contributors\": []\n },\n \"gitea\": {\n \"contributors\": []\n },\n \"bitbucket\": {\n \"contributors\": []\n },\n \"azure_devops\": {\n \"contributors\": []\n }\n },\n \"extra\": {\n \"note\": \"This is so awesome!\"\n },\n \"repository\": \"/home/johndoe/repo/\",\n \"commit_range\": null,\n \"submodule_commits\": {},\n \"github\": {\n \"contributors\": []\n },\n \"gitlab\": {\n \"contributors\": []\n },\n \"gitea\": {\n \"contributors\": []\n },\n \"bitbucket\": {\n \"contributors\": []\n },\n \"azure_devops\": {\n \"contributors\": []\n }\n },\n {\n \"version\": \"v0.1.0\",\n \"message\": null,\n \"commits\": [\n {\n \"id\": \"9c10e506bf103998e303d8164c7b4a1a841e2471\",\n \"message\": \"add feature 1\",\n \"body\": null,\n \"footers\": [],\n \"group\": \"Features\",\n \"breaking_description\": null,\n \"breaking\": false,\n \"scope\": \"app\",\n \"links\": [],\n \"author\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1723730666\n },\n \"committer\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1649201109\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n }\n },\n {\n \"id\": \"98b1464c2f99a0c6812ce6d3ea4a5b953dd35fe2\",\n \"message\": \"fix feature 1\",\n \"body\": null,\n \"footers\": [],\n \"group\": \"Bug Fixes\",\n \"breaking_description\": null,\n \"breaking\": false,\n \"scope\": \"cli\",\n \"links\": [],\n \"author\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1723730666\n },\n \"committer\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"timestamp\": 1649201110\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n }\n }\n ],\n \"commit_id\": \"98b1464c2f99a0c6812ce6d3ea4a5b953dd35fe2\",\n \"timestamp\": 1649201110,\n \"previous\": {\n \"version\": null,\n \"message\": null,\n \"commits\": [],\n \"commit_id\": null,\n \"timestamp\": 0,\n \"previous\": null,\n \"repository\": null,\n \"commit_range\": null,\n \"submodule_commits\": {},\n \"github\": {\n \"contributors\": []\n },\n \"gitlab\": {\n \"contributors\": []\n },\n \"gitea\": {\n \"contributors\": []\n },\n \"bitbucket\": {\n \"contributors\": []\n },\n \"azure_devops\": {\n \"contributors\": []\n }\n },\n \"repository\": \"/home/johndoe/repo/\",\n \"commit_range\": null,\n \"submodule_commits\": {},\n \"github\": {\n \"contributors\": []\n },\n \"gitlab\": {\n \"contributors\": []\n },\n \"gitea\": {\n \"contributors\": []\n },\n \"bitbucket\": {\n \"contributors\": []\n },\n \"azure_devops\": {\n \"contributors\": []\n }\n }\n]" }, { "path": ".github/fixtures/test-from-context/expected.md", "content": "## [unreleased]\n\n### Test\n\n- Add tests\n\n## [0.2.0] - 2022-04-05 - This is so awesome!\n\n### Bug Fixes\n\n- Fix feature 2 (that was a tough one)\n\n### Features\n\n- Add feature 2\n\n## [0.1.0] - 2022-04-05\n\n### Bug Fixes\n\n- Fix feature 1\n\n### Features\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-from-context-does-not-discard-fields/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ## {{ group | striptags | trim | upper_first }}\n {% for commit in commits %}\n {% if commit.scope %}*({{ commit.scope }})* {% endif %}\\\n {% if commit.breaking %}[**breaking**]: {{ commit.breaking_description }}{% endif %}\n {{ commit.message }}: {{ commit.body }}\\\n {% for footer in commit.footers %}\n - {{ footer.token }}{{ footer.separator }} {{ footer.value }}\\\n {% endfor %}\n {% endfor %}\\\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\" },\n]\n" }, { "path": ".github/fixtures/test-from-context-does-not-discard-fields/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \\\n \"feat(web): feature 1, breaking change in footer\n\nBody feature 1\n\nBREAKING CHANGE: breaking change description feature 1\nSigned-off-by: user1 \nReviewed-by: user2\n\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \\\n \"feat(web)!: feature 2, breaking chain in description\n\nBody feature 2\n\nSigned-off-by: user3 \n\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \\\n \"feat!: feature 3, use default scope = app\n\nBody feature 2\n\nSigned-off-by: user3 \n\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \\\n \"fix(scope): fix 1, use scope as group\n\nBody fix 1\n\nFix: #1\n\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \\\n \"fix(front-end): fix 2, no footer\n\nBody fix 2\n\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:14\" git commit --allow-empty -m \\\n \"fix(front-end): fix 3 and 4, no body but footer\n\nFix: #3\nFix: #4\n\"\n\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-from-context-does-not-discard-fields/context.json", "content": "[\n {\n \"version\": \"v0.1.0\",\n \"message\": null,\n \"commits\": [\n {\n \"id\": \"ab06a042344dbd1c4af974ef393049b44ad0ae28\",\n \"message\": \"feature 1, breaking change in footer\",\n \"body\": \"Body feature 1\",\n \"footers\": [\n {\n \"token\": \"BREAKING CHANGE\",\n \"separator\": \":\",\n \"value\": \"breaking change description feature 1\",\n \"breaking\": true\n },\n {\n \"token\": \"Signed-off-by\",\n \"separator\": \":\",\n \"value\": \"user1 \",\n \"breaking\": false\n },\n {\n \"token\": \"Reviewed-by\",\n \"separator\": \":\",\n \"value\": \"user2\",\n \"breaking\": false\n }\n ],\n \"group\": \"Features\",\n \"breaking_description\": \"breaking change description feature 1\",\n \"breaking\": true,\n \"scope\": \"web\",\n \"links\": [],\n \"author\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1728938297\n },\n \"committer\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1649175909\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"extra\": null,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"raw_message\": \"feat(web): feature 1, breaking change in footer\\n\\nBody feature 1\\n\\nBREAKING CHANGE: breaking change description feature 1\\nSigned-off-by: user1 \\nReviewed-by: user2\"\n },\n {\n \"id\": \"a87599e6ecaf05e80ac4d87edd9a852fd8cad189\",\n \"message\": \"feature 2, breaking chain in description\",\n \"body\": \"Body feature 2\",\n \"footers\": [\n {\n \"token\": \"Signed-off-by\",\n \"separator\": \":\",\n \"value\": \"user3 \",\n \"breaking\": false\n }\n ],\n \"group\": \"Features\",\n \"breaking_description\": \"feature 2, breaking chain in description\",\n \"breaking\": true,\n \"scope\": \"web\",\n \"links\": [],\n \"author\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1728938297\n },\n \"committer\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1649175910\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"extra\": null,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"raw_message\": \"feat(web)!: feature 2, breaking chain in description\\n\\nBody feature 2\\n\\nSigned-off-by: user3 \"\n },\n {\n \"id\": \"9d83e631a1c57eec825f724283041662edd9230b\",\n \"message\": \"feature 3, use default scope = app\",\n \"body\": \"Body feature 2\",\n \"footers\": [\n {\n \"token\": \"Signed-off-by\",\n \"separator\": \":\",\n \"value\": \"user3 \",\n \"breaking\": false\n }\n ],\n \"group\": \"Features\",\n \"breaking_description\": \"feature 3, use default scope = app\",\n \"breaking\": true,\n \"scope\": \"app\",\n \"links\": [],\n \"author\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1728938297\n },\n \"committer\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1649175911\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"extra\": null,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"raw_message\": \"feat!: feature 3, use default scope = app\\n\\nBody feature 2\\n\\nSigned-off-by: user3 \"\n },\n {\n \"id\": \"3bb5b6f741fd40cc71f09d3c6a339e4b5d0843cc\",\n \"message\": \"fix 1, use scope as group\",\n \"body\": \"Body fix 1\",\n \"footers\": [\n {\n \"token\": \"Fix\",\n \"separator\": \":\",\n \"value\": \"#1\",\n \"breaking\": false\n }\n ],\n \"group\": \"fix\",\n \"breaking_description\": null,\n \"breaking\": false,\n \"scope\": \"scope\",\n \"links\": [],\n \"author\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1728938297\n },\n \"committer\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1649175912\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"extra\": null,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"raw_message\": \"fix(scope): fix 1, use scope as group\\n\\nBody fix 1\\n\\nFix: #1\"\n },\n {\n \"id\": \"856472f0e5b238278fe331dcc151a96982c5bbad\",\n \"message\": \"fix 2, no footer\",\n \"body\": \"Body fix 2\",\n \"footers\": [],\n \"group\": \"fix\",\n \"breaking_description\": null,\n \"breaking\": false,\n \"scope\": \"front-end\",\n \"links\": [],\n \"author\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1728938297\n },\n \"committer\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1649175913\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"extra\": null,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"raw_message\": \"fix(front-end): fix 2, no footer\\n\\nBody fix 2\"\n },\n {\n \"id\": \"6e7a2b8e670a348ccfbae696fd850d8769c54360\",\n \"message\": \"fix 3 and 4, no body but footer\",\n \"body\": null,\n \"footers\": [\n {\n \"token\": \"Fix\",\n \"separator\": \":\",\n \"value\": \"#3\",\n \"breaking\": false\n },\n {\n \"token\": \"Fix\",\n \"separator\": \":\",\n \"value\": \"#4\",\n \"breaking\": false\n }\n ],\n \"group\": \"fix\",\n \"breaking_description\": null,\n \"breaking\": false,\n \"scope\": \"front-end\",\n \"links\": [],\n \"author\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1728938297\n },\n \"committer\": {\n \"name\": \"github-actions[bot]\",\n \"email\": \"github-actions[bot]@users.noreply.github.com\",\n \"timestamp\": 1649175914\n },\n \"conventional\": true,\n \"merge_commit\": false,\n \"extra\": null,\n \"github\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitlab\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"gitea\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"bitbucket\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"azure_devops\": {\n \"username\": null,\n \"pr_title\": null,\n \"pr_number\": null,\n \"pr_labels\": [],\n \"is_first_time\": false\n },\n \"raw_message\": \"fix(front-end): fix 3 and 4, no body but footer\\n\\nFix: #3\\nFix: #4\"\n }\n ],\n \"commit_id\": \"6e7a2b8e670a348ccfbae696fd850d8769c54360\",\n \"timestamp\": 1649175914,\n \"previous\": {\n \"version\": null,\n \"message\": null,\n \"commits\": [],\n \"commit_id\": null,\n \"timestamp\": 0,\n \"previous\": null,\n \"repository\": null,\n \"commit_range\": null,\n \"submodule_commits\": {},\n \"extra\": null,\n \"github\": {\n \"contributors\": []\n },\n \"gitlab\": {\n \"contributors\": []\n },\n \"gitea\": {\n \"contributors\": []\n },\n \"bitbucket\": {\n \"contributors\": []\n },\n \"azure_devops\": {\n \"contributors\": []\n }\n },\n \"repository\": \"/path/to/repository\",\n \"commit_range\": null,\n \"submodule_commits\": {},\n \"extra\": null,\n \"github\": {\n \"contributors\": []\n },\n \"gitlab\": {\n \"contributors\": []\n },\n \"gitea\": {\n \"contributors\": []\n },\n \"bitbucket\": {\n \"contributors\": []\n },\n \"azure_devops\": {\n \"contributors\": []\n }\n }\n]" }, { "path": ".github/fixtures/test-from-context-does-not-discard-fields/expected.md", "content": "\n## Features\n\n*(web)* [**breaking**]: breaking change description feature 1\nfeature 1, breaking change in footer: Body feature 1\n- BREAKING CHANGE: breaking change description feature 1\n- Signed-off-by: user1 \n- Reviewed-by: user2\n\n*(web)* [**breaking**]: feature 2, breaking chain in description\nfeature 2, breaking chain in description: Body feature 2\n- Signed-off-by: user3 \n\n*(app)* [**breaking**]: feature 3, use default scope = app\nfeature 3, use default scope = app: Body feature 2\n- Signed-off-by: user3 \n\n## Fix\n\n*(scope)* \nfix 1, use scope as group: Body fix 1\n- Fix: #1\n\n*(front-end)* \nfix 2, no footer: Body fix 2\n\n*(front-end)* \nfix 3 and 4, no body but footer: \n- Fix: #3\n- Fix: #4\n\n" }, { "path": ".github/fixtures/test-gitea-integration/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# Gitea integration for fetching commit metadata.\n[remote.gitea]\nowner = \"ThetaDev\"\nrepo = \"git-cliff-readme-example\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n## What's Changed\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}\n{%- endfor -%}\n\n{% if gitea.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in gitea.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \\\n {%- endif %}\n{%- endfor -%}\n{% raw %}\\n\\n{% endraw -%}\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n" }, { "path": ".github/fixtures/test-gitea-integration/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://codeberg.org/ThetaDev/git-cliff-readme-example.git\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-gitea-integration/expected.md", "content": "## What's Changed\n* Initial commit by @ThetaDev\n* docs(project): add README.md by @ThetaDev\n* feat(parser): add ability to parse arrays by @ThetaDev\n* fix(args): rename help argument due to conflict by @ThetaDev\n* docs(example)!: add tested usage example by @ThetaDev\n* refactor(parser): expose string functions by @ThetaDev\n* chore(release): add release script by @ThetaDev\n* feat(config): support multiple file formats by @ThetaDev\n* feat(cache): use cache while fetching pages by @ThetaDev\n\n### New Contributors\n* @ThetaDev made their first contribution\n\n" }, { "path": ".github/fixtures/test-gitea-integration-custom-range/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# Gitea integration for fetching commit metadata.\n[remote.gitea]\nowner = \"ThetaDev\"\nrepo = \"git-cliff-readme-example\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n## What's Changed\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}\n{%- endfor -%}\n\n{% if gitea.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in gitea.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \\\n {%- endif %}\n{%- endfor -%}\n{% raw %}\\n\\n{% endraw -%}\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n" }, { "path": ".github/fixtures/test-gitea-integration-custom-range/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://codeberg.org/ThetaDev/git-cliff-readme-example.git\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-gitea-integration-custom-range/expected.md", "content": "## What's Changed\n* feat(config): support multiple file formats by @ThetaDev\n* feat(cache): use cache while fetching pages by @ThetaDev\n\n" }, { "path": ".github/fixtures/test-github-integration/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# GitHub integration for fetching commit metadata.\n[remote.github]\nowner = \"orhun\"\nrepo = \"git-cliff-readme-example\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n## What's Changed\n\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}\n{%- endfor -%}\n\n{% if github.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in github.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \\\n {%- endif %}\n{%- endfor -%}\n\n{% if version %}\n {% if previous.version %}\n **Full Changelog**: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/compare/{{ previous.version }}...{{ version }}\n {% endif %}\n{% else -%}\n {% raw %}\\n{% endraw %}\n{% endif %}\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n" }, { "path": ".github/fixtures/test-github-integration/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-github-integration/expected.md", "content": "## What's Changed\n* feat(config): support multiple file formats by @orhun\n* feat(cache): use cache while fetching pages by @orhun\n\n## What's Changed in v1.0.1\n* refactor(parser): expose string functions by @orhun\n* chore(release): add release script by @orhun\n\n**Full Changelog**: https://github.com/orhun/git-cliff-readme-example/compare/v1.0.0...v1.0.1\n\n## What's Changed in v1.0.0\n* Initial commit by @orhun\n* docs(project): add README.md by @orhun\n* feat(parser): add ability to parse arrays by @orhun\n* fix(args): rename help argument due to conflict by @orhun\n* docs(example)!: add tested usage example by @orhun\n\n### New Contributors\n* @orhun made their first contribution\n\n" }, { "path": ".github/fixtures/test-github-integration-custom-range/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# GitHub integration for fetching commit metadata.\n[remote.github]\nowner = \"orhun\"\nrepo = \"git-cliff-readme-example\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n## What's Changed\n\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}\n{%- endfor -%}\n\n{% if github.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in github.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \\\n {%- endif %}\n{%- endfor -%}\n\n{% if version %}\n {% if previous.version %}\n **Full Changelog**: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/compare/{{ previous.version }}...{{ version }}\n {% endif %}\n{% else -%}\n {% raw %}\\n{% endraw %}\n{% endif %}\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n" }, { "path": ".github/fixtures/test-github-integration-custom-range/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-github-integration-custom-range/expected.md", "content": "## What's Changed in v1.0.1\n* refactor(parser): expose string functions by @orhun\n* chore(release): add release script by @orhun\n\n**Full Changelog**: https://github.com/orhun/git-cliff-readme-example/compare/v1.0.0...v1.0.1\n\n" }, { "path": ".github/fixtures/test-gitlab-integration/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# GitLab integration for fetching commit metadata.\n[remote.gitlab]\nowner = \"dark0dave\"\nrepo = \"dotfiles\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n## What's Changed\n\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}\n{%- endfor -%}\n\n{% if gitlab.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in gitlab.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \\\n {%- endif %}\n{%- endfor -%}\n\n{% if version %}\n {% if previous.version %}\n **Full Changelog**: https://gitlab.com/{{ remote.gitlab.owner }}/{{ remote.gitlab.repo }}/compare/{{ previous.version }}...{{ version }}\n {% endif %}\n{% else -%}\n {% raw %}\\n{% endraw %}\n{% endif %}\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n" }, { "path": ".github/fixtures/test-gitlab-integration/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://gitlab.com/dark0dave/dotfiles\ngit fetch\ngit checkout 3c048a1b6a32e6d1076581225b06dd41ee5a02ff\n" }, { "path": ".github/fixtures/test-gitlab-integration/expected.md", "content": "## What's Changed\n* Initial commit by @dark0dave\n* Added tmux files by @dark0dave\n* Updated readme by @dark0dave\n* Updated readme and added zshrc files by @dark0dave\n* Added python files by @dark0dave\n* Added curl files by @dark0dave\n* Zsh update by @dark0dave\n* Update README.md by @dark0dave\n* Fix for path by @dark0dave\n* Update README.md by @dark0dave\n* Started setup files by @dark0dave\n* Updated tmux to be a little nicer by @dark0dave\n* Merge branch 'feature/tmux-improvements' into 'master' by @dark0dave in #2\n\n" }, { "path": ".github/fixtures/test-gitlab-integration-custom-range/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# GitLab integration for fetching commit metadata.\n[remote.gitlab]\nowner = \"dark0dave\"\nrepo = \"dotfiles\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n## What's Changed\n\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}\n{%- endfor -%}\n\n{% if gitlab.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in gitlab.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \\\n {%- endif %}\n{%- endfor -%}\n\n{% if version %}\n {% if previous.version %}\n **Full Changelog**: https://gitlab.com/{{ remote.gitlab.owner }}/{{ remote.gitlab.repo }}/compare/{{ previous.version }}...{{ version }}\n {% endif %}\n{% else -%}\n {% raw %}\\n{% endraw %}\n{% endif %}\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n" }, { "path": ".github/fixtures/test-gitlab-integration-custom-range/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://gitlab.com/dark0dave/dotfiles\ngit fetch\ngit checkout 3c048a1b6a32e6d1076581225b06dd41ee5a02ff\n" }, { "path": ".github/fixtures/test-gitlab-integration-custom-range/expected.md", "content": "## What's Changed\n* Added curl files by @dark0dave\n* Zsh update by @dark0dave\n* Update README.md by @dark0dave\n* Fix for path by @dark0dave\n* Update README.md by @dark0dave\n\n" }, { "path": ".github/fixtures/test-header-template/cliff.toml", "content": "[changelog]\n# template for the changelog footer\nheader = \"\"\"\n# Changelog\n{% for release in releases %}\\\n {% if release.version %}\\\n {% if release.previous.version %}\\\n \n {% endif %}\\\n {% else %}\\\n \n {% endif %}\\\n{% endfor %}\\\n\"\"\"\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n" }, { "path": ".github/fixtures/test-header-template/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"fix: fix feature 2\"\ngit tag v0.2.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"feat: add footer\"\ngit tag v3.0.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"test: footer\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"perf: footer\"\n" }, { "path": ".github/fixtures/test-header-template/expected.md", "content": "# Changelog\n\n\n\n## [unreleased]\n\n### Perf\n\n- Footer\n\n### Test\n\n- Footer\n\n## [3.0.0]\n\n### Feat\n\n- Add footer\n\n## [0.2.0]\n\n### Fix\n\n- Fix feature 1\n- Fix feature 2\n\n## [0.1.0]\n\n### Feat\n\n- Add feature 1\n- Add feature 2\n" }, { "path": ".github/fixtures/test-ignore-tags/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"v0.1.0-beta.1\"\n# Regex to exclude git tags after applying the tag_pattern.\nignore_tags = \"v.*-beta.*\"\n" }, { "path": ".github/fixtures/test-ignore-tags/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add skip feature\"\ngit tag v0.1.0-beta.1\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"feat: fix feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:48\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.2.0-beta.1\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:49\" git commit --allow-empty -m \"feat: add feature 3\"\ngit tag v0.2.0\n" }, { "path": ".github/fixtures/test-ignore-tags/expected.md", "content": "## [0.2.0] - 2021-01-23\n\n### 🚀 Features\n\n- Add feature 2\n- Add feature 3\n\n## [0.1.0] - 2021-01-23\n\n### 🚀 Features\n\n- Add feature 1\n- Fix feature 1\n\n" }, { "path": ".github/fixtures/test-invert-ignore-tags/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# regex for skipping tags\nskip_tags = \"v0.1.0-beta.1\"\n# regex for ignoring tags\nignore_tags = \"v.*-beta.*\"\ncount_tags = \"v0.2.0\"\n" }, { "path": ".github/fixtures/test-invert-ignore-tags/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add skip feature\"\ngit tag v0.1.0-beta.1\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"feat: fix feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:48\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.2.0-beta.1\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:49\" git commit --allow-empty -m \"feat: add feature 3\"\ngit tag v0.2.0\n" }, { "path": ".github/fixtures/test-invert-ignore-tags/expected.md", "content": "## [0.2.0] - 2021-01-23\n\n### 🚀 Features\n\n- Add feature 1\n- Fix feature 1\n- Add feature 2\n- Add feature 3\n\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% else %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/releases/tag/{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% endif %}\\\n {% endif %}\\\n{% else %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [Unreleased](https://github.com/dummy/dummy/compare/{{ previous.version }}...HEAD)\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = true\n# Regex to select git tags that represent releases.\ntag_pattern = \"v[0-9]*\"\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"v0.1.0-beta.1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-24 01:23:46\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.2.0\n\nGIT_COMMITTER_DATE=\"2021-01-25 01:23:47\" git commit --allow-empty -m \"fix: fix feature 1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links/expected.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [Unreleased](https://github.com/dummy/dummy/compare/v0.2.0...HEAD)\n\n### Fixed\n\n- Fix feature 1\n\n## [0.2.0](https://github.com/dummy/dummy/compare/v0.1.0...v0.2.0) - 2021-01-24\n\n### Added\n\n- Add feature 2\n\n## [0.1.0](https://github.com/dummy/dummy/releases/tag/v0.1.0) - 2021-01-23\n\n### Added\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-current-arg/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% else %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/releases/tag/{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% endif %}\\\n {% endif %}\\\n{% else %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [Unreleased](https://github.com/dummy/dummy/compare/{{ previous.version }}...HEAD)\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = true\n# Regex to select git tags that represent releases.\ntag_pattern = \"v[0-9]*\"\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"v0.1.0-beta.1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-current-arg/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-24 01:23:46\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.2.0\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-current-arg/expected.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [0.2.0](https://github.com/dummy/dummy/compare/v0.1.0...v0.2.0) - 2021-01-24\n\n### Added\n\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-latest-arg/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% else %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/releases/tag/{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% endif %}\\\n {% endif %}\\\n{% else %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [Unreleased](https://github.com/dummy/dummy/compare/{{ previous.version }}...HEAD)\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = true\n# Regex to select git tags that represent releases.\ntag_pattern = \"v[0-9]*\"\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"v0.1.0-beta.1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-latest-arg/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-24 01:23:46\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.2.0\n\nGIT_COMMITTER_DATE=\"2021-01-25 01:23:47\" git commit --allow-empty -m \"fix: fix feature 1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-latest-arg/expected.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [0.2.0](https://github.com/dummy/dummy/compare/v0.1.0...v0.2.0) - 2021-01-24\n\n### Added\n\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-no-tags/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% else %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/releases/tag/{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% endif %}\\\n {% endif %}\\\n{% else %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [Unreleased](https://github.com/dummy/dummy/compare/{{ previous.version }}...HEAD)\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = true\n# Regex to select git tags that represent releases.\ntag_pattern = \"v[0-9]*\"\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"v0.1.0-beta.1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-no-tags/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\n\nGIT_COMMITTER_DATE=\"2021-01-24 01:23:46\" git commit --allow-empty -m \"feat: add feature 2\"\n\nGIT_COMMITTER_DATE=\"2021-01-25 01:23:47\" git commit --allow-empty -m \"fix: fix feature 1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-no-tags/expected.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [Unreleased]\n\n### Added\n\n- Add feature 1\n- Add feature 2\n\n### Fixed\n\n- Fix feature 1\n\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-one-tag/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% else %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/releases/tag/{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% endif %}\\\n {% endif %}\\\n{% else %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [Unreleased](https://github.com/dummy/dummy/compare/{{ previous.version }}...HEAD)\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = true\n# Regex to select git tags that represent releases.\ntag_pattern = \"v[0-9]*\"\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"v0.1.0-beta.1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-one-tag/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-one-tag/expected.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [0.1.0](https://github.com/dummy/dummy/releases/tag/v0.1.0) - 2021-01-23\n\n### Added\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-one-tag-bump-arg/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% else %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/releases/tag/{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% endif %}\\\n {% endif %}\\\n{% else %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [Unreleased](https://github.com/dummy/dummy/compare/{{ previous.version }}...HEAD)\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = true\n# Regex to select git tags that represent releases.\ntag_pattern = \"v[0-9]*\"\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"v0.1.0-beta.1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-one-tag-bump-arg/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"Initial commit\"\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-25 01:23:47\" git commit --allow-empty -m \"fix: fix feature 1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-one-tag-bump-arg/expected.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [0.1.1](https://github.com/dummy/dummy/compare/v0.1.0...v0.1.1) - <>\n\n### Fixed\n\n- Fix feature 1\n\n## [0.1.0](https://github.com/dummy/dummy/releases/tag/v0.1.0) - 2021-01-23\n\n### Added\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-tag-arg/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% else %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/releases/tag/{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% endif %}\\\n {% endif %}\\\n{% else %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [Unreleased](https://github.com/dummy/dummy/compare/{{ previous.version }}...HEAD)\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = true\n# Regex to select git tags that represent releases.\ntag_pattern = \"v[0-9]*\"\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"v0.1.0-beta.1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-tag-arg/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-24 01:23:46\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.2.0\n\nGIT_COMMITTER_DATE=\"2021-01-25 01:23:47\" git commit --allow-empty -m \"fix: fix feature 1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-tag-arg/expected.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [0.3.0](https://github.com/dummy/dummy/compare/v0.2.0...v0.3.0) - <>\n\n### Fixed\n\n- Fix feature 1\n\n## [0.2.0](https://github.com/dummy/dummy/compare/v0.1.0...v0.2.0) - 2021-01-24\n\n### Added\n\n- Add feature 2\n\n## [0.1.0](https://github.com/dummy/dummy/releases/tag/v0.1.0) - 2021-01-23\n\n### Added\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-unreleased-arg/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% else %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}](https://github.com/dummy/dummy/releases/tag/{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% endif %}\\\n {% endif %}\\\n{% else %}\\\n {% if previous %}\\\n {% if previous.version %}\\\n ## [Unreleased](https://github.com/dummy/dummy/compare/{{ previous.version }}...HEAD)\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n {% else %}\\\n ## [Unreleased]\n {% endif %}\\\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = true\n# Regex to select git tags that represent releases.\ntag_pattern = \"v[0-9]*\"\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"v0.1.0-beta.1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-unreleased-arg/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-24 01:23:46\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.2.0\n\nGIT_COMMITTER_DATE=\"2021-01-25 01:23:47\" git commit --allow-empty -m \"fix: fix feature 1\"\n" }, { "path": ".github/fixtures/test-keep-a-changelog-links-unreleased-arg/expected.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [Unreleased](https://github.com/dummy/dummy/compare/v0.2.0...HEAD)\n\n### Fixed\n\n- Fix feature 1\n\n" }, { "path": ".github/fixtures/test-latest-with-one-tag/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n" }, { "path": ".github/fixtures/test-latest-with-one-tag/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: initial commit\"\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-latest-with-one-tag/expected.md", "content": "## [0.1.0] - 2021-01-23\n\n### 🚀 Features\n\n- Initial commit\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-limit-commits/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# Limit the total number of commits contained in the changelog.\nlimit_commits = 2\n" }, { "path": ".github/fixtures/test-limit-commits/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1 (#1)\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"refactor: move classes\"\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-limit-commits/expected.md", "content": "## [0.1.0] - 2022-04-06\n\n### 🐛 Bug Fixes\n\n- Fix feature 1 (#1)\n\n### 🚜 Refactor\n\n- Move classes\n\n" }, { "path": ".github/fixtures/test-monorepo-include-path/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# regex for parsing and grouping commits\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-monorepo-include-path/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff\ngit fetch\nmv cliff.toml cliff.toml.bak\ngit checkout 076feb74b4d8c8634669f57d4e2765c39490d80e\nmv cliff.toml.bak cliff.toml\n" }, { "path": ".github/fixtures/test-monorepo-include-path/expected.md", "content": "## [unreleased]\n\n### Bug Fixes\n\n- Include the root commit when `--latest` is used with one tag (#901)\n- Match PR and release metadata correctly (#907)\n- Fix missing commit fields in context (#837) (#920)\n- Preserve first time contributors (#925)\n\n### Features\n\n- Allow overriding the remote API URL via config (#896)\n\n" }, { "path": ".github/fixtures/test-no-exec/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n# An array of regex based postprocessors to modify the changelog.\npostprocessors = [\n { pattern = '.*', replace_command = 'this_command_does_not_exist' },\n]\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n { pattern = '.*', replace_command = \"this_command_does_not_exist\" },\n]\n" }, { "path": ".github/fixtures/test-no-exec/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/test-no-exec/expected.md", "content": "## [unreleased]\n\n### Test\n\n- Add tests\n\n## [0.2.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 2\n\n### Features\n\n- Add feature 2\n\n## [0.1.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 1\n\n### Features\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-offline/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[remote]\n# Should make us avoid all calls to external services\noffline = true\n\n# GitHub integration for fetching commit metadata.\n[remote.github]\nowner = \"orhun\"\nrepo = \"git-cliff-readme-example\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n## What's Changed\n\n{%- if version %} in {{ version }}{%- endif -%}\n{% for commit in commits %}\n * {{ commit.message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}\n{%- endfor -%}\n\n{% if version %}\n {% if previous.version %}\n **Full Changelog**: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/compare/{{ previous.version }}...{{ version }}\n {% endif %}\n{% else -%}\n {% raw %}\\n{% endraw %}\n{% endif %}\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n" }, { "path": ".github/fixtures/test-offline/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-offline/expected.md", "content": "## What's Changed\n* feat(config): support multiple file formats\n* feat(cache): use cache while fetching pages\n\n## What's Changed in v1.0.1\n* refactor(parser): expose string functions\n* chore(release): add release script\n\n**Full Changelog**: https://github.com/orhun/git-cliff-readme-example/compare/v1.0.0...v1.0.1\n\n## What's Changed in v1.0.0\n* Initial commit\n* docs(project): add README.md\n* feat(parser): add ability to parse arrays\n* fix(args): rename help argument due to conflict\n* docs(example)!: add tested usage example\n\n" }, { "path": ".github/fixtures/test-override-scope/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## {{ version | trim_start_matches(pat=\"v\") }} - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## Unreleased\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for group, commits in commits | group_by(attribute=\"scope\") %}\n #### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n {% endfor %}\\\n{% endfor %}\\n\n\"\"\"\n\n[git]\nconventional_commits = true\nfilter_unconventional = false\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"([Xx]enon)\", scope = \"Xenon\" }\n]\n" }, { "path": ".github/fixtures/test-override-scope/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"fix(Xenon): first commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix(Xenon): second commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix(xenon): third commit\"\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-override-scope/expected.md", "content": "## 0.1.0 - 2022-04-06\n\n### Fix\n\n#### Xenon\n\n- First commit\n- Second commit\n- Third commit\n\n" }, { "path": ".github/fixtures/test-regex-json-array/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[remote.github]\nowner = \"orhun\"\nrepo = \"git-cliff-readme-example-one-pr-one-commit\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | split(pat=\"\\n\") | nth(n=0) | trim_end }} \\\n {%- if commit.remote.pr_number -%}\n ([PR #{{ commit.remote.pr_number }}](https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/pull/{{ commit.remote.pr_number }}))\\\n {%- endif -%}\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { field = \"remote.pr_labels\", pattern = \"area/documentation\", group = \"📝 Documentation\" },\n { field = \"remote.pr_labels\", pattern = \"breaking change\", group = \"💥 Breaking Changes\" },\n { field = \"remote.pr_labels\", pattern = \"type/bug\", group = \"🐛 Bug Fixes\" },\n { field = \"remote.pr_labels\", pattern = \"type/enhancement\", group = \"✨ Enhancements\" },\n { field = \"remote.pr_labels\", pattern = \"type/refactor\", group = \"🧹 Refactoring\" },\n { field = \"remote.pr_labels\", pattern = \"type/update\", group = \"🚀 Feature Updates\" },\n { message = \".*\", group = \"🌀 Miscellaneous\" },\n]\n" }, { "path": ".github/fixtures/test-regex-json-array/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff-readme-example-one-pr-one-commit\ngit pull origin main\ngit fetch --tags\n" }, { "path": ".github/fixtures/test-regex-json-array/expected.md", "content": "## [unreleased]\n\n### ✨ Enhancements\n\n- feat(cache): use cache while fetching pages([PR #7](https://github.com/orhun/git-cliff-readme-example-one-pr-one-commit/pull/7))\n- feat(config): support multiple file formats([PR #8](https://github.com/orhun/git-cliff-readme-example-one-pr-one-commit/pull/8))\n- feat(parser): add ability to parse arrays([PR #9](https://github.com/orhun/git-cliff-readme-example-one-pr-one-commit/pull/9))\n\n## [1.0.1] - 2025-06-18\n\n### 🚀 Feature Updates\n\n- chore(release): add release script([PR #6](https://github.com/orhun/git-cliff-readme-example-one-pr-one-commit/pull/6))\n\n### 🐛 Bug Fixes\n\n- fix(args): rename help argument due to conflict([PR #5](https://github.com/orhun/git-cliff-readme-example-one-pr-one-commit/pull/5))\n\n## [1.0.0] - 2025-06-18\n\n### 💥 Breaking Changes\n\n- refactor(parser): expose string functions([PR #3](https://github.com/orhun/git-cliff-readme-example-one-pr-one-commit/pull/3))\n\n### 📝 Documentation\n\n- docs(project): add README.md([PR #2](https://github.com/orhun/git-cliff-readme-example-one-pr-one-commit/pull/2))\n- docs(example)!: add tested usage example([PR #4](https://github.com/orhun/git-cliff-readme-example-one-pr-one-commit/pull/4))\n\n### 🌀 Miscellaneous\n\n- chore: initialize main\n- initial commit([PR #1](https://github.com/orhun/git-cliff-readme-example-one-pr-one-commit/pull/1))\n\n" }, { "path": ".github/fixtures/test-regex-label-grouping/cliff.toml", "content": "[changelog]\nbody = \"\"\"\n### What's changed\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n #### {{ group }}\n {% for commit in commits -%}\n - {{ commit.message }}\n {% endfor -%}\\n\n{% endfor %}\\n\n\"\"\"\n\n[git]\ncommit_parsers = [\n { field = \"author.name\", pattern = \"testa\", group = \"TEST A\" },\n { field = \"author.name\", pattern = \"testb\", group = \"TEST B\" },\n { field = \"author.name\", pattern = \"testc\", group = \"TEST C\" },\n]\n" }, { "path": ".github/fixtures/test-regex-label-grouping/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty --author=\"testa \" -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty --author=\"testa \" -m \"feat: add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty --author=\"testb \" -m \"feat: add feature 3\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty --author=\"testb \" -m \"feat: add feature 4\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty --author=\"testc \" -m \"feat: add feature 5\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:14\" git commit --allow-empty --author=\"testc \" -m \"feat: add feature 6\" \n" }, { "path": ".github/fixtures/test-regex-label-grouping/expected.md", "content": "### What's changed\n\n#### TEST A\n- add feature 1\n- add feature 2\n\n#### TEST B\n- add feature 3\n- add feature 4\n\n#### TEST C\n- add feature 5\n- add feature 6\n\n" }, { "path": ".github/fixtures/test-regex-replace-parser/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - ({{ commit.scope }}) {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = '^fix\\((.*)\\)', group = 'Fix (${1}) 🧰' },\n { message = '^feat\\((.*)\\)', group = 'Feature (${1}) 🚀' },\n { message = \"^\\\\[(.*)\\\\]\", group = \"Changes to ${1}\", scope = \"${1}\" },\n]\n" }, { "path": ".github/fixtures/test-regex-replace-parser/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat(config): add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix(config): fix feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"[tests]: add tests\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"[codebase]: refactor stuff\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"[codebase]: refactor more stuff\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"[security]: rewrite everything in Rust\"\n" }, { "path": ".github/fixtures/test-regex-replace-parser/expected.md", "content": "## [unreleased]\n\n### Changes to codebase\n\n- (codebase) Refactor stuff\n- (codebase) Refactor more stuff\n\n### Changes to security\n\n- (security) Rewrite everything in Rust\n\n### Changes to tests\n\n- (tests) Add tests\n\n## [0.2.0] - 2022-04-05\n\n### Feature (gui) 🚀\n\n- (gui) Add feature 2\n\n### Fix (gui) 🧰\n\n- (gui) Fix feature 2\n\n## [0.1.0] - 2022-04-05\n\n### Feature (config) 🚀\n\n- (config) Add feature 1\n\n### Fix (config) 🧰\n\n- (config) Fix feature 1\n\n" }, { "path": ".github/fixtures/test-release-statistics/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\n### Commit Statistics\\n\n- {{ statistics.commit_count }} commit(s) contributed to the release.\n- {{ statistics.commits_timespan | default(value=0) }} day(s) passed between the first and last commit.\n- {{ statistics.conventional_commit_count }} commit(s) parsed as conventional.\n- {{ statistics.links | length }} linked issue(s) detected in commits.\n{%- if statistics.links | length > 0 %}\n\t{%- for link in statistics.links %}\n {{ \" \" }}- [{{ link.text }}]({{ link.href }}) (referenced {{ link.count }} time(s))\n\t{%- endfor %}\n{%- endif %}\n{%- if statistics.days_passed_since_last_release %}\n\t- {{ statistics.days_passed_since_last_release }} day(s) passed between releases.\n{%- endif %}\\n\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n# An array of link parsers for extracting external references, and turning them into URLs, using regex.\nlink_parsers = [\n { pattern = \"#(\\\\d+)\", href = \"https://github.com/orhun/git-cliff/issues/$1\"},\n { pattern = \"RFC(\\\\d+)\", text = \"ietf-rfc$1\", href = \"https://datatracker.ietf.org/doc/html/rfc$1\"},\n]\n" }, { "path": ".github/fixtures/test-release-statistics/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:14\" git commit --allow-empty -m \"feat: add release statistics feature(#452)\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:14\" git commit --allow-empty -m \"fix: remove duplication (#452)\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:14\" git commit --allow-empty -m \"feat: make git short shat available(#1148)\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:15\" git commit --allow-empty -m \"fix(parser): ensure URI parsing is RFC3986-compliant\"\n" }, { "path": ".github/fixtures/test-release-statistics/expected.md", "content": "## [unreleased]\n\n### Bug Fixes\n\n- Remove duplication (#452)\n- Ensure URI parsing is RFC3986-compliant\n\n### Features\n\n- Add release statistics feature(#452)\n- Make git short shat available(#1148)\n\n### Test\n\n- Add tests\n\n### Commit Statistics\n\n- 5 commit(s) contributed to the release.\n- 0 day(s) passed between the first and last commit.\n- 5 commit(s) parsed as conventional.\n- 3 linked issue(s) detected in commits.\n - [#452](https://github.com/orhun/git-cliff/issues/452) (referenced 2 time(s))\n - [#1148](https://github.com/orhun/git-cliff/issues/1148) (referenced 1 time(s))\n - [ietf-rfc3986](https://datatracker.ietf.org/doc/html/rfc3986) (referenced 1 time(s))\n- <> day(s) passed between releases.\n\n## [0.2.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 2\n\n### Features\n\n- Add feature 2\n\n### Commit Statistics\n\n- 2 commit(s) contributed to the release.\n- 0 day(s) passed between the first and last commit.\n- 2 commit(s) parsed as conventional.\n- 0 linked issue(s) detected in commits.\n\n## [0.1.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 1\n\n### Commit Statistics\n\n- 1 commit(s) contributed to the release.\n- 0 day(s) passed between the first and last commit.\n- 1 commit(s) parsed as conventional.\n- 0 linked issue(s) detected in commits.\n\n" }, { "path": ".github/fixtures/test-remote-config/cliff.toml", "content": "[changelog]\nheader = \"This is going to be overriden\"\n" }, { "path": ".github/fixtures/test-remote-config/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/test-remote-config/expected.md", "content": "## [unreleased]\n\n### Test\n\n- Add tests\n\n## [0.2.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 2\n\n### Features\n\n- Add feature 2\n\n## [0.1.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 1\n\n### Features\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-require-conventional-negative/cliff.toml", "content": "[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ## {{ group | striptags | trim | upper_first }}\n {% for commit in commits %}\n {% if commit.scope %}*({{ commit.scope }})* {% endif %}\\\n {% if commit.breaking %}[**breaking**]: {{ commit.breaking_description }}{% endif %}\n {{ commit.message }}: {{ commit.body }}\\\n {% for footer in commit.footers %}\n - {{ footer.token }}{{ footer.separator }} {{ footer.value }}\\\n {% endfor %}\n {% endfor %}\\\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# Require all commits to be conventional.\n# Takes precedence over filter_unconventional.\nrequire_conventional = true\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\" },\n]\n" }, { "path": ".github/fixtures/test-require-conventional-negative/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"This is unconventional.\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \\\n \"This is unconventional on multiple lines.\n\nLine 2\n\nSome Footer: user3 \n\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui)!: fix feature 2\"\n\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-require-conventional-negative/expected.rc", "content": "1" }, { "path": ".github/fixtures/test-require-conventional-skipped/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for group, commits in commits | group_by(attribute=\"scope\") %}\n #### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n {% endfor %}\\\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# Require all commits to be conventional.\n# Takes precedence over filter_unconventional.\nrequire_conventional = true\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", skip = true },\n { message = \"Initial commit\", skip = true },\n]\n# Prevent commits that are breaking from being excluded by commit parsers.\nprotect_breaking_commits = true\n" }, { "path": ".github/fixtures/test-require-conventional-skipped/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui)!: add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui)!: fix feature 2\"\n\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-require-conventional-skipped/expected.md", "content": "## [0.1.0] - 2022-04-06\n\n### Bug Fixes\n\n#### Gui\n\n- Fix feature 2\n\n### Features\n\n#### App\n\n- Add feature 1\n\n#### Gui\n\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-skip-breaking-changes/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for group, commits in commits | group_by(attribute=\"scope\") %}\n #### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n {% endfor %}\\\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\", skip = true },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\", skip = true },\n]\n# Prevent commits that are breaking from being excluded by commit parsers.\nprotect_breaking_commits = true\n" }, { "path": ".github/fixtures/test-skip-breaking-changes/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix!: fix feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui)!: add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui)!: fix feature 2\"\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-skip-breaking-changes/expected.md", "content": "## [0.1.0] - 2022-04-06\n\n### Bug Fixes\n\n#### Cli\n\n- Fix feature 1\n- Fix feature 2\n\n### Features\n\n#### Gui\n\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-skip-commits/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"🚀 Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"🐛 Bug Fixes\", scope = \"cli\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = true\n" }, { "path": ".github/fixtures/test-skip-commits/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n{\n echo \"06412ac1dd4071006c465dde6597a21d4367a158\"\n echo \"81fbc6365484abf0b4f4b05d384175763ad8db44\"\n echo \"e4fd3cf8e2e6f49c0b57f66416e886c37cbb3715\"\n} >>.cliffignore\n" }, { "path": ".github/fixtures/test-skip-commits/expected.md", "content": "## [unreleased]\n\n### 🚀 Features\n\n- Support multiple file formats\n- Use cache while fetching pages\n\n## [1.0.0] - 2021-07-18\n\n### 🚀 Features\n\n- Add ability to parse arrays\n\n### 🐛 Bug Fixes\n\n- Rename help argument due to conflict\n\n" }, { "path": ".github/fixtures/test-skip-tags/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"v0.0.1\"\n" }, { "path": ".github/fixtures/test-skip-tags/commit.sh", "content": "set -e\n\nGIT_COMMITTER_DATE=\"2025-06-24 21:01:21\" git commit --allow-empty -m \"init\"\ngit tag v0.0.1\n\nGIT_COMMITTER_DATE=\"2025-06-24 21:01:22\" git commit --allow-empty -m \"feat: add feature 0\"\nGIT_COMMITTER_DATE=\"2025-06-24 21:01:23\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-skip-tags/expected.md", "content": "## [0.1.0] - 2025-06-24\n\n### 🚀 Features\n\n- Add feature 0\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-split-commits/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = true\n" }, { "path": ".github/fixtures/test-split-commits/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \\\n\"feat: add feature 1\nfeat: add feature 2\nfix: fix feature 1\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \\\n\"chore: bump deps\nstyle: apply formatting\nfix: fix feature 2\"\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \\\n\"test: add initial tests\ntest: add more tests\ntest: update assert statements\"\n\ngit tag v0.1.0\n" }, { "path": ".github/fixtures/test-split-commits/expected.md", "content": "## [0.1.0] - 2022-04-06\n\n### 🚀 Features\n\n- Add feature 1\n- Add feature 2\n\n### 🐛 Bug Fixes\n\n- Fix feature 1\n- Fix feature 2\n\n### 💼 Other\n\n- Initial commit\n\n### 🎨 Styling\n\n- Apply formatting\n\n### 🧪 Testing\n\n- Add initial tests\n- Add more tests\n- Update assert statements\n\n### ⚙️ Miscellaneous Tasks\n\n- Bump deps\n\n" }, { "path": ".github/fixtures/test-submodules/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\\n{% for submodule_path, commits in submodule_commits %}\n ### {{ submodule_path | upper_first }}\n {% for group, commits in commits | group_by(attribute=\"group\") %}\n #### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\nrecurse_submodules = true\n" }, { "path": ".github/fixtures/test-submodules/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ncurrent_dir=\"$(pwd)\"\nsubmodule_one_dir=\"$(mktemp -d)\"\nsubmodule_two_dir=\"$(mktemp -d)\"\n\ncd $submodule_one_dir && git init >&2\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:8\" git commit --allow-empty -m \"feat: submodule_one initial commit\"\n\ncd $submodule_two_dir && git init >&2\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:12\" git commit --allow-empty -m \"feat: submodule_two feature B\"\n\ncd $current_dir\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\n\ngit -c protocol.file.allow=always submodule add $submodule_one_dir submodule_one\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit -a -m \"feat: add submodule_one\"\n\ncd submodule_one\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:10\" git commit --allow-empty -m \"feat: submodule_one feature A\"\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:11\" git commit --allow-empty -m \"fix: submodule_one fix A\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit -a -m \"feat: submodule_one update 1\"\ngit tag v0.1.0\n\ngit -c protocol.file.allow=always submodule add $submodule_two_dir submodule_two\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit -a -m \"feat: submodule_two with initial commits\"\n\ncd submodule_two\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:13\" git commit --allow-empty -m \"fix: submodule_two fix B\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit -a -m \"feat: submodule_two update 1\"\ngit tag v0.2.0\n\ncd submodule_two\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:14\" git commit --allow-empty -m \"fix: submodule_two fix C\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit -a -m \"feat: submodule_two update 2\"\n" }, { "path": ".github/fixtures/test-submodules/expected.md", "content": "## [unreleased]\n\n### Features\n\n- Submodule_two update 2\n\n### Submodule_two\n\n#### Bug Fixes\n\n- Submodule_two fix C\n\n\n## [0.2.0] - 2022-04-06\n\n### Features\n\n- Submodule_two with initial commits\n- Submodule_two update 1\n\n### Submodule_two\n\n#### Bug Fixes\n\n- Submodule_two fix B\n\n#### Features\n\n- Submodule_two feature B\n\n\n## [0.1.0] - 2022-04-06\n\n### Features\n\n- Add submodule_one\n- Submodule_one update 1\n\n### Submodule_one\n\n#### Bug Fixes\n\n- Submodule_one fix A\n\n#### Features\n\n- Submodule_one feature A\n- Submodule_one initial commit\n\n\n" }, { "path": ".github/fixtures/test-submodules-include-path/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\\n{% for submodule_path, commits in submodule_commits %}\n ### {{ submodule_path | upper_first }}\n {% for group, commits in commits | group_by(attribute=\"group\") %}\n #### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n {% endfor %}\n{% endfor %}\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\nrecurse_submodules = true\n" }, { "path": ".github/fixtures/test-submodules-include-path/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ncurrent_dir=\"$(pwd)\"\nsubmodule_one_dir=\"$(mktemp -d)\"\nsubmodule_two_dir=\"$(mktemp -d)\"\n\ncd $submodule_one_dir && git init >&2\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:8\" git commit --allow-empty -m \"feat: submodule_one initial commit\"\n\ncd $submodule_two_dir && git init >&2\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:12\" git commit --allow-empty -m \"feat: submodule_two feature B\"\n\ncd $current_dir\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\n\ngit -c protocol.file.allow=always submodule add $submodule_one_dir submodule_one\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit -a -m \"feat: add submodule_one\"\n\ncd submodule_one\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:10\" git commit --allow-empty -m \"feat: submodule_one feature A\"\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:11\" git commit --allow-empty -m \"fix: submodule_one fix A\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit -a -m \"feat: submodule_one update 1\"\ngit tag v0.1.0\n\ngit -c protocol.file.allow=always submodule add $submodule_two_dir submodule_two\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit -a -m \"feat: submodule_two with initial commits\"\n\ncd submodule_two\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:13\" git commit --allow-empty -m \"fix: submodule_two fix B\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit -a -m \"feat: submodule_two update 1\"\ngit tag v0.2.0\n\ncd submodule_two\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:14\" git commit --allow-empty -m \"fix: submodule_two fix C\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit -a -m \"feat: submodule_two update 2\"\n" }, { "path": ".github/fixtures/test-submodules-include-path/expected.md", "content": "## [unreleased]\n\n### Features\n\n- Submodule_two update 2\n\n### Submodule_two\n\n#### Bug Fixes\n\n- Submodule_two fix C\n\n## [0.2.0] - 2022-04-06\n\n### Features\n\n- Submodule_two with initial commits\n- Submodule_two update 1\n\n### Submodule_two\n\n#### Bug Fixes\n\n- Submodule_two fix B\n\n#### Features\n\n- Submodule_two feature B\n\n" }, { "path": ".github/fixtures/test-submodules-include-path-config/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\\n{% for submodule_path, commits in submodule_commits %}\n ### {{ submodule_path | upper_first }}\n {% for group, commits in commits | group_by(attribute=\"group\") %}\n #### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n {% endfor %}\n{% endfor %}\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\nrecurse_submodules = true\ninclude_paths = [\"submodule_two\"]\n" }, { "path": ".github/fixtures/test-submodules-include-path-config/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ncurrent_dir=\"$(pwd)\"\nsubmodule_one_dir=\"$(mktemp -d)\"\nsubmodule_two_dir=\"$(mktemp -d)\"\n\ncd $submodule_one_dir && git init >&2\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:8\" git commit --allow-empty -m \"feat: submodule_one initial commit\"\n\ncd $submodule_two_dir && git init >&2\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:12\" git commit --allow-empty -m \"feat: submodule_two feature B\"\n\ncd $current_dir\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\n\ngit -c protocol.file.allow=always submodule add $submodule_one_dir submodule_one\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit -a -m \"feat: add submodule_one\"\n\ncd submodule_one\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:10\" git commit --allow-empty -m \"feat: submodule_one feature A\"\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:11\" git commit --allow-empty -m \"fix: submodule_one fix A\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit -a -m \"feat: submodule_one update 1\"\ngit tag v0.1.0\n\ngit -c protocol.file.allow=always submodule add $submodule_two_dir submodule_two\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit -a -m \"feat: submodule_two with initial commits\"\n\ncd submodule_two\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:13\" git commit --allow-empty -m \"fix: submodule_two fix B\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit -a -m \"feat: submodule_two update 1\"\ngit tag v0.2.0\n\ncd submodule_two\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:14\" git commit --allow-empty -m \"fix: submodule_two fix C\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit -a -m \"feat: submodule_two update 2\"\n" }, { "path": ".github/fixtures/test-submodules-include-path-config/expected.md", "content": "## [unreleased]\n\n### Features\n\n- Submodule_two update 2\n\n### Submodule_two\n\n#### Bug Fixes\n\n- Submodule_two fix C\n\n## [0.2.0] - 2022-04-06\n\n### Features\n\n- Submodule_two with initial commits\n- Submodule_two update 1\n\n### Submodule_two\n\n#### Bug Fixes\n\n- Submodule_two fix B\n\n#### Features\n\n- Submodule_two feature B\n\n" }, { "path": ".github/fixtures/test-submodules-range/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\\n{% for submodule_path, commits in submodule_commits %}\n ### {{ submodule_path | upper_first }}\n {% for group, commits in commits | group_by(attribute=\"group\") %}\n #### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n {% endfor %}\n{% endfor %}\n\"\"\"\n\n[git]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's `scope` and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\nrecurse_submodules = true\n" }, { "path": ".github/fixtures/test-submodules-range/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ncurrent_dir=\"$(pwd)\"\nsubmodule_one_dir=\"$(mktemp -d)\"\nsubmodule_two_dir=\"$(mktemp -d)\"\n\ncd $submodule_one_dir && git init >&2\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:8\" git commit --allow-empty -m \"feat: submodule_one initial commit\"\n\ncd $submodule_two_dir && git init >&2\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:12\" git commit --allow-empty -m \"feat: submodule_two feature B\"\n\ncd $current_dir\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\n\ngit -c protocol.file.allow=always submodule add $submodule_one_dir submodule_one\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit -a -m \"feat: add submodule_one\"\n\ncd submodule_one\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:10\" git commit --allow-empty -m \"feat: submodule_one feature A\"\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:11\" git commit --allow-empty -m \"fix: submodule_one fix A\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit -a -m \"feat: submodule_one update 1\"\ngit tag v0.1.0\n\ngit -c protocol.file.allow=always submodule add $submodule_two_dir submodule_two\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit -a -m \"feat: submodule_two with initial commits\"\n\ncd submodule_two\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:13\" git commit --allow-empty -m \"fix: submodule_two fix B\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit -a -m \"feat: submodule_two update 1\"\ngit tag v0.2.0\n\ncd submodule_two\nGIT_COMMITTER_DATE=\"2022-04-05 01:00:14\" git commit --allow-empty -m \"fix: submodule_two fix C\"\ncd ..\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit -a -m \"feat: submodule_two update 2\"\n" }, { "path": ".github/fixtures/test-submodules-range/expected.md", "content": "## [unreleased]\n\n### Features\n\n- Submodule_two update 2\n\n### Submodule_two\n\n#### Bug Fixes\n\n- Submodule_two fix C\n\n## [0.2.0] - 2022-04-06\n\n### Features\n\n- Submodule_two with initial commits\n- Submodule_two update 1\n\n### Submodule_two\n\n#### Bug Fixes\n\n- Submodule_two fix B\n\n#### Features\n\n- Submodule_two feature B\n\n" }, { "path": ".github/fixtures/test-tag-message/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% if message %}\n {{ message }}\n {% endif %}\\\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# regex for parsing and grouping commits\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-tag-message/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0 -m \"Some text\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"test: add tests\"\n" }, { "path": ".github/fixtures/test-tag-message/expected.md", "content": "## [unreleased]\n\n### Test\n\n- Add tests\n\n## [0.2.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 2\n\n### Features\n\n- Add feature 2\n\n## [0.1.0] - 2022-04-06\n\nSome text\n\n### Bug Fixes\n\n- Fix feature 1\n\n### Features\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-topo-order/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# Order releases topologically instead of chronologically.\ntopo_order = true\n" }, { "path": ".github/fixtures/test-topo-order/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.2.0\n\ngit checkout v0.1.0\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"feat: fix feature 1\"\ngit tag v0.1.1\n" }, { "path": ".github/fixtures/test-topo-order/expected.md", "content": "## [0.2.0] - 2021-01-23\n\n### 🚀 Features\n\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-topo-order-arg/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n" }, { "path": ".github/fixtures/test-topo-order-arg/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:45\" git commit --allow-empty -m \"feat: add feature 1\"\ngit tag v0.1.0\n\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:46\" git commit --allow-empty -m \"feat: add feature 2\"\ngit tag v0.2.0\n\ngit checkout v0.1.0\nGIT_COMMITTER_DATE=\"2021-01-23 01:23:47\" git commit --allow-empty -m \"feat: fix feature 1\"\ngit tag v0.1.1\n" }, { "path": ".github/fixtures/test-topo-order-arg/expected.md", "content": "## [0.2.0] - 2021-01-23\n\n### 🚀 Features\n\n- Add feature 2\n\n" }, { "path": ".github/fixtures/test-topo-order-commits/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n\n[git]\n\ntopo_order_commits = false" }, { "path": ".github/fixtures/test-topo-order-commits/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 03:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 03:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 03:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 03:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 03:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.2.0\nGIT_COMMITTER_DATE=\"2022-04-06 03:25:25\" git commit --allow-empty -m \"test: add tests\"\nGIT_COMMITTER_DATE=\"2022-04-06 03:25:25\" git checkout v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 03:25:13\" git commit --allow-empty -m \"fix: fix again feature 1\"\ngit tag v0.1.1\ngit checkout master\ngit merge v0.1.1 --no-edit\n" }, { "path": ".github/fixtures/test-topo-order-commits/expected.md", "content": "## [unreleased]\n\n### 🧪 Testing\n\n- Add tests\n## [0.1.1] - 2022-04-06\n\n### 🐛 Bug Fixes\n\n- Fix again feature 1\n## [0.2.0] - 2022-04-06\n\n### 🚀 Features\n\n- *(gui)* Add feature 2\n\n### 🐛 Bug Fixes\n\n- *(gui)* Fix feature 2\n## [0.1.0] - 2022-04-06\n\n### 🚀 Features\n\n- Add feature 1\n\n### 🐛 Bug Fixes\n\n- Fix feature 1\n" }, { "path": ".github/fixtures/test-unchanged-tag-date/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# regex for parsing and grouping commits\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-unchanged-tag-date/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:08\" git commit --allow-empty -m \"Initial commit\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:09\" git commit --allow-empty -m \"feat: add feature 1\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:10\" git commit --allow-empty -m \"fix: fix feature 1\"\ngit tag v0.1.0\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:11\" git commit --allow-empty -m \"feat(gui): add feature 2\"\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:12\" git commit --allow-empty -m \"fix(gui): fix feature 2\"\ngit tag v0.2.0\n" }, { "path": ".github/fixtures/test-unchanged-tag-date/expected.md", "content": "## [0.2.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 2\n\n### Features\n\n- Add feature 2\n\n## [0.1.0] - 2022-04-06\n\n### Bug Fixes\n\n- Fix feature 1\n\n### Features\n\n- Add feature 1\n\n" }, { "path": ".github/fixtures/test-unreleased-tag-missing-release-commit/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[remote.github]\nowner = \"orhun\"\nrepo = \"git-cliff-readme-example\"\n\n[changelog]\nbody = \"\"\"new_contributors: {{ github.contributors | filter(attribute=\"is_first_time\", value=true) | length }}\"\"\"\n\n[git]\nconventional_commits = false\n" }, { "path": ".github/fixtures/test-unreleased-tag-missing-release-commit/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff-readme-example\ngit pull origin master\ngit fetch --tags\n\nGIT_COMMITTER_DATE=\"2022-04-06 01:25:13\" git commit --allow-empty -m \"chore: local-only commit\"\n" }, { "path": ".github/fixtures/test-unreleased-tag-missing-release-commit/expected.md", "content": "new_contributors: 0" }, { "path": ".github/fixtures/test-workdir-include-path/cliff.toml", "content": "[changelog]\n# template for the changelog body\n# https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n\n[git]\n# regex for parsing and grouping commits\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\", default_scope = \"app\" },\n { message = \"^fix\", group = \"Bug Fixes\", scope = \"cli\" },\n]\n" }, { "path": ".github/fixtures/test-workdir-include-path/commit.sh", "content": "#!/usr/bin/env bash\nset -e\n\ngit remote add origin https://github.com/orhun/git-cliff\ngit fetch\nmv cliff.toml cliff.toml.bak\ngit checkout 076feb74b4d8c8634669f57d4e2765c39490d80e\nmv cliff.toml.bak .github/fixtures/cliff.toml\n" }, { "path": ".github/fixtures/test-workdir-include-path/expected.md", "content": "## [unreleased]\n\n### Bug Fixes\n\n- Include the root commit when `--latest` is used with one tag (#901)\n- Match PR and release metadata correctly (#907)\n- Fix missing commit fields in context (#837) (#920)\n- Preserve first time contributors (#925)\n\n### Features\n\n- Allow overriding the remote API URL via config (#896)\n\n" }, { "path": ".github/mergify.yml", "content": "pull_request_rules:\n - name: Automatic merge for Dependabot pull requests\n conditions:\n - author=dependabot[bot]\n actions:\n merge:\n method: squash\n" }, { "path": ".github/workflows/cd.yml", "content": "name: Continuous Deployment\n\non:\n push:\n tags:\n - \"v*.*.*\"\n\njobs:\n generate-changelog:\n name: Generate changelog\n runs-on: ubuntu-22.04\n outputs:\n release_body: ${{ steps.git-cliff.outputs.content }}\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n fetch-depth: 0\n - name: Generate a changelog\n uses: orhun/git-cliff-action@07dda386992489f0a6151dee53f3a137713644de # main\n id: git-cliff\n with:\n config: cliff.toml\n args: -vv --latest --no-exec --github-repo ${{ github.repository }}\n\n publish-binaries:\n name: Publish binaries\n needs: generate-changelog\n runs-on: ${{ matrix.build.os }}\n strategy:\n fail-fast: false\n matrix:\n build:\n - {\n NAME: linux-x64-glibc,\n OS: ubuntu-22.04,\n TOOLCHAIN: stable,\n TARGET: x86_64-unknown-linux-gnu,\n NPM_PUBLISH: true,\n PYPI_PUBLISH: true,\n }\n - {\n NAME: linux-x64-musl,\n OS: ubuntu-22.04,\n TOOLCHAIN: stable,\n TARGET: x86_64-unknown-linux-musl,\n NPM_PUBLISH: false,\n PYPI_PUBLISH: true,\n }\n - {\n NAME: linux-x86-glibc,\n OS: ubuntu-22.04,\n TOOLCHAIN: stable,\n TARGET: i686-unknown-linux-gnu,\n NPM_PUBLISH: false,\n PYPI_PUBLISH: false,\n }\n - {\n NAME: linux-x86-musl,\n OS: ubuntu-22.04,\n TOOLCHAIN: stable,\n TARGET: i686-unknown-linux-musl,\n NPM_PUBLISH: false,\n PYPI_PUBLISH: true,\n }\n - {\n NAME: linux-arm64-glibc,\n OS: ubuntu-22.04,\n TOOLCHAIN: stable,\n TARGET: aarch64-unknown-linux-gnu,\n NPM_PUBLISH: true,\n PYPI_PUBLISH: true,\n }\n - {\n NAME: linux-arm64-musl,\n OS: ubuntu-22.04,\n TOOLCHAIN: stable,\n TARGET: aarch64-unknown-linux-musl,\n NPM_PUBLISH: false,\n PYPI_PUBLISH: true,\n }\n - {\n NAME: win32-x64-mingw,\n OS: windows-2025,\n TOOLCHAIN: stable,\n TARGET: x86_64-pc-windows-gnu,\n NPM_PUBLISH: false,\n PYPI_PUBLISH: false,\n }\n - {\n NAME: win32-x64-msvc,\n OS: windows-2025,\n TOOLCHAIN: stable,\n TARGET: x86_64-pc-windows-msvc,\n NPM_PUBLISH: true,\n PYPI_PUBLISH: true,\n }\n - {\n NAME: win32-x86-msvc,\n OS: windows-2025,\n TOOLCHAIN: stable,\n TARGET: i686-pc-windows-msvc,\n NPM_PUBLISH: false,\n PYPI_PUBLISH: true,\n }\n - {\n NAME: win32-arm64-msvc,\n OS: windows-2025,\n TOOLCHAIN: stable,\n TARGET: aarch64-pc-windows-msvc,\n NPM_PUBLISH: true,\n PYPI_PUBLISH: false,\n }\n - {\n NAME: darwin-x64,\n OS: macos-15,\n TOOLCHAIN: stable,\n TARGET: x86_64-apple-darwin,\n NPM_PUBLISH: true,\n PYPI_PUBLISH: true,\n }\n - {\n NAME: darwin-arm64,\n OS: macos-15,\n TOOLCHAIN: stable,\n TARGET: aarch64-apple-darwin,\n NPM_PUBLISH: true,\n PYPI_PUBLISH: true,\n }\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Set the release version\n shell: bash\n run: echo \"RELEASE_VERSION=${GITHUB_REF:11}\" >> $GITHUB_ENV\n - name: Install dependencies\n shell: bash\n run: |\n if [[ \"${{ matrix.build.NAME }}\" = *\"-musl\" ]]; then\n sudo apt-get update\n sudo apt-get install -y --no-install-recommends \\\n --allow-unauthenticated musl-tools\n fi\n - name: Install Rust toolchain\n uses: actions-rs/toolchain@16499b5e05bf2e26879000db0c1d13f7e13fa3af # v1.0.7\n with:\n toolchain: ${{ matrix.build.TOOLCHAIN }}\n target: ${{ matrix.build.TARGET }}\n override: true\n - name: Build (linux/macos)\n if: matrix.build.OS != 'windows-2025'\n uses: actions-rs/cargo@844f36862e911db73fe0815f00a4a2602c279505 # v1.0.3\n with:\n use-cross: true\n command: build\n args: --release --locked --target ${{ matrix.build.TARGET }}\n - name: Build (windows)\n if: matrix.build.OS == 'windows-2025'\n uses: actions-rs/cargo@844f36862e911db73fe0815f00a4a2602c279505 # v1.0.3\n with:\n command: build\n args: --release --locked --target ${{ matrix.build.TARGET }} # --no-default-features\n - name: Prepare release assets\n shell: bash\n run: |\n mkdir -p release/{man,completions}\n cp {LICENSE-MIT,LICENSE-APACHE,README.md,CHANGELOG.md} release/\n OUT_DIR=release/completions/ cargo run --release --bin git-cliff-completions\n OUT_DIR=release/man/ cargo run --release --bin git-cliff-mangen\n for bin in 'git-cliff' 'git-cliff-completions' 'git-cliff-mangen'; do\n if [ \"${{ matrix.build.OS }}\" = \"windows-2025\" ]; then\n bin=\"${bin}.exe\"\n fi\n cp \"target/${{ matrix.build.TARGET }}/release/${bin}\" release/\n done\n mv release/ git-cliff-${{ env.RELEASE_VERSION }}/\n - name: Create release artifacts\n shell: bash\n run: |\n if [ \"${{ matrix.build.OS }}\" = \"windows-2025\" ]; then\n 7z a -tzip \"git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}.zip\" \\\n git-cliff-${{ env.RELEASE_VERSION }}/\n else\n tar -czvf git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}.tar.gz \\\n git-cliff-${{ env.RELEASE_VERSION }}/\n shasum -a 512 git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}.tar.gz \\\n > git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}.tar.gz.sha512\n fi\n - name: Sign the release\n if: matrix.build.OS == 'ubuntu-22.04' || matrix.build.OS == 'macos-15'\n run: |\n echo \"${{ secrets.GPG_RELEASE_KEY }}\" | base64 --decode > private.key\n echo \"${{ secrets.GPG_PASSPHRASE }}\" | gpg --pinentry-mode=loopback \\\n --passphrase-fd 0 --import private.key\n echo \"${{ secrets.GPG_PASSPHRASE }}\" | gpg --pinentry-mode=loopback \\\n --passphrase-fd 0 --detach-sign \\\n git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}.tar.gz\n - name: Publish to GitHub\n if: ${{ !contains(github.ref, '-') }}\n uses: svenstaro/upload-release-action@b98a3b12e86552593f3e4e577ca8a62aa2f3f22b # v2\n with:\n repo_token: ${{ secrets.GITHUB_TOKEN }}\n file: git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}*\n file_glob: true\n overwrite: true\n tag: ${{ github.ref }}\n release_name: \"Release v${{ env.RELEASE_VERSION }}\"\n body: \"${{ needs.generate-changelog.outputs.release_body }}\"\n - name: Publish to GitHub (pre-release)\n if: ${{ contains(github.ref, '-') }}\n uses: svenstaro/upload-release-action@b98a3b12e86552593f3e4e577ca8a62aa2f3f22b # v2\n with:\n repo_token: ${{ secrets.GITHUB_TOKEN }}\n file: git-cliff-${{ env.RELEASE_VERSION }}-${{ matrix.build.TARGET }}*\n file_glob: true\n overwrite: true\n tag: ${{ github.ref }}\n release_name: \"Pre-release v${{ env.RELEASE_VERSION }}\"\n prerelease: true\n - name: Install node\n if: matrix.build.NPM_PUBLISH == true\n uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0\n with:\n node-version: 18\n registry-url: \"https://registry.npmjs.org\"\n - name: Publish to NPM\n if: matrix.build.NPM_PUBLISH == true\n shell: bash\n run: |\n cd npm\n bin=\"git-cliff\"\n node_os=$(echo \"${{ matrix.build.NAME }}\" | cut -d '-' -f1)\n export node_os\n node_arch=$(echo \"${{ matrix.build.NAME }}\" | cut -d '-' -f2)\n export node_arch\n export version=\"${{ env.RELEASE_VERSION }}\"\n if [ \"${{ matrix.build.OS }}\" = \"windows-2025\" ]; then\n export node_pkg=\"${bin}-windows-${node_arch}\"\n else\n export node_pkg=\"${bin}-${node_os}-${node_arch}\"\n fi\n mkdir -p \"${node_pkg}/bin\"\n envsubst < package.json.tmpl > \"${node_pkg}/package.json\"\n if [ \"${{ matrix.build.OS }}\" = \"windows-2025\" ]; then\n bin=\"${bin}.exe\"\n fi\n cp \"../target/${{ matrix.build.TARGET }}/release/${bin}\" \"${node_pkg}/bin\"\n cp ../README.md \"${node_pkg}\"\n cd \"${node_pkg}\"\n npm publish\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n - name: Build Python wheels (linux)\n if: matrix.build.PYPI_PUBLISH == true && startsWith(matrix.build.NAME, 'linux')\n uses: PyO3/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad # v1.50.1\n with:\n working-directory: pypi\n target: ${{ matrix.build.TARGET }}\n args: --release --sdist --out wheels\n sccache: \"true\"\n # https://github.com/PyO3/maturin-action/issues/245\n manylinux: ${{ matrix.build.TARGET == 'aarch64-unknown-linux-gnu' && '2_28' || 'auto' }}\n - name: Build Python wheels (macos & windows)\n if: |\n matrix.build.PYPI_PUBLISH == true &&\n (startsWith(matrix.build.OS, 'macos') || startsWith(matrix.build.OS, 'windows'))\n uses: PyO3/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad # v1.50.1\n with:\n working-directory: pypi\n target: ${{ matrix.build.TARGET }}\n args: --release --sdist --out wheels\n sccache: \"true\"\n - name: Build Python wheels (musl)\n if: matrix.build.PYPI_PUBLISH == true && endsWith(matrix.build.OS, 'musl')\n uses: PyO3/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad # v1.50.1\n with:\n working-directory: pypi\n target: ${{ matrix.build.TARGET }}\n args: --release --sdist --out wheels\n sccache: \"true\"\n manylinux: musllinux_1_2\n - name: Upload Python wheels\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0\n with:\n name: \"wheels-${{ matrix.build.TARGET }}\"\n working-directory: pypi\n path: pypi/wheels\n\n publish-npm:\n name: Publish the base package to NPM\n needs: publish-binaries\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Install node\n uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0\n with:\n node-version: 18\n registry-url: \"https://registry.npmjs.org\"\n - name: Publish the package\n shell: bash\n working-directory: npm/git-cliff\n run: |\n yarn config set npmAuthToken ${NODE_AUTH_TOKEN}\n yarn config set npmPublishRegistry \"https://registry.npmjs.org\"\n yarn install\n yarn build\n cp ../../README.md .\n cp ../../CHANGELOG.md .\n if [ ${{ contains(github.ref, '-') }} = \"true\" ]; then\n yarn npm publish --tag rc\n else\n yarn npm publish\n fi\n env:\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n YARN_ENABLE_IMMUTABLE_INSTALLS: false\n\n publish-pypi:\n name: Publish PyPI package\n runs-on: ubuntu-22.04\n needs: publish-binaries\n steps:\n - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1\n with:\n path: pypi/wheels\n pattern: wheels-*\n merge-multiple: true\n - name: Publish to PyPI\n uses: PyO3/maturin-action@04ac600d27cdf7a9a280dadf7147097c42b757ad # v1.50.1\n env:\n MATURIN_PYPI_TOKEN: ${{ vars.USE_TESTPYPI == 'true' && secrets.TESTPYPI_API_TOKEN || secrets.PYPI_API_TOKEN }}\n MATURIN_REPOSITORY: ${{ vars.USE_TESTPYPI == 'true' && 'testpypi' || 'pypi' }}\n with:\n command: upload\n args: --skip-existing pypi/wheels/*\n\n publish-deb:\n name: Publish Debian package\n needs: generate-changelog\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Set the release version\n shell: bash\n run: echo \"RELEASE_VERSION=${GITHUB_REF:11}\" >> $GITHUB_ENV\n - name: Install Rust toolchain\n uses: dtolnay/rust-toolchain@4305c38b25d97ef35a8ad1f985ccf2d2242004f2 # stable\n with:\n targets: x86_64-unknown-linux-gnu\n - name: Install cargo-deb\n run: cargo install cargo-deb\n - name: Build Debian package\n run: |\n # https://github.com/kornelski/cargo-deb/pull/62\n sed \"/readme = (.*)/d\" -E -i git-cliff/Cargo.toml\n cargo build --release --locked -p git-cliff\n mkdir man/\n OUT_DIR=man cargo run --bin git-cliff-mangen\n mkdir completions\n OUT_DIR=completions cargo run --bin git-cliff-completions\n cargo-deb --deb-revision=\"\" --strip -p git-cliff -v -o git-cliff-${{ env.RELEASE_VERSION }}.deb\n - name: Sign the package\n run: |\n echo \"${{ secrets.GPG_RELEASE_KEY }}\" | base64 --decode > private.key\n echo \"${{ secrets.GPG_PASSPHRASE }}\" | gpg --pinentry-mode=loopback \\\n --passphrase-fd 0 --import private.key\n echo \"${{ secrets.GPG_PASSPHRASE }}\" | gpg --pinentry-mode=loopback \\\n --passphrase-fd 0 --detach-sign \\\n git-cliff-${{ env.RELEASE_VERSION }}.deb\n - name: Upload the release\n if: ${{ !contains(github.ref, '-') }}\n uses: svenstaro/upload-release-action@b98a3b12e86552593f3e4e577ca8a62aa2f3f22b # v2\n with:\n repo_token: ${{ secrets.GITHUB_TOKEN }}\n file: git-cliff-${{ env.RELEASE_VERSION }}.deb\n tag: ${{ github.ref }}\n release_name: \"Release v${{ env.RELEASE_VERSION }}\"\n body: \"${{ needs.generate-changelog.outputs.release_body }}\"\n - name: Upload the pre-release\n if: ${{ contains(github.ref, '-') }}\n uses: svenstaro/upload-release-action@b98a3b12e86552593f3e4e577ca8a62aa2f3f22b # v2\n with:\n repo_token: ${{ secrets.GITHUB_TOKEN }}\n file: git-cliff-${{ env.RELEASE_VERSION }}.deb\n tag: ${{ github.ref }}\n release_name: \"Pre-release v${{ env.RELEASE_VERSION }}\"\n prerelease: true\n\n publish-rpm:\n name: Publish RPM package\n needs: generate-changelog\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Set the release version\n shell: bash\n run: echo \"RELEASE_VERSION=${GITHUB_REF:11}\" >> $GITHUB_ENV\n - name: Install Rust toolchain\n uses: dtolnay/rust-toolchain@4305c38b25d97ef35a8ad1f985ccf2d2242004f2 # stable\n with:\n targets: x86_64-unknown-linux-gnu\n - name: Install cargo-generate-rpm\n run: cargo install cargo-generate-rpm\n - name: Build RPM package\n run: |\n cargo build --release --locked -p git-cliff\n mkdir man/\n OUT_DIR=man cargo run --bin git-cliff-mangen\n mkdir completions\n OUT_DIR=completions cargo run --bin git-cliff-completions\n cargo generate-rpm -p git-cliff -o git-cliff-${{ env.RELEASE_VERSION }}.x86_64.rpm\n - name: Sign the package\n run: |\n echo \"${{ secrets.GPG_RELEASE_KEY }}\" | base64 --decode > private.key\n echo \"${{ secrets.GPG_PASSPHRASE }}\" | gpg --pinentry-mode=loopback \\\n --passphrase-fd 0 --import private.key\n echo \"${{ secrets.GPG_PASSPHRASE }}\" | gpg --pinentry-mode=loopback \\\n --passphrase-fd 0 --detach-sign \\\n git-cliff-${{ env.RELEASE_VERSION }}.x86_64.rpm\n - name: Upload the release\n if: ${{ !contains(github.ref, '-') }}\n uses: svenstaro/upload-release-action@b98a3b12e86552593f3e4e577ca8a62aa2f3f22b # v2\n with:\n repo_token: ${{ secrets.GITHUB_TOKEN }}\n file: git-cliff-${{ env.RELEASE_VERSION }}.x86_64.rpm\n tag: ${{ github.ref }}\n release_name: \"Release v${{ env.RELEASE_VERSION }}\"\n body: \"${{ needs.generate-changelog.outputs.release_body }}\"\n - name: Upload the pre-release\n if: ${{ contains(github.ref, '-') }}\n uses: svenstaro/upload-release-action@b98a3b12e86552593f3e4e577ca8a62aa2f3f22b # v2\n with:\n repo_token: ${{ secrets.GITHUB_TOKEN }}\n file: git-cliff-${{ env.RELEASE_VERSION }}.x86_64.rpm\n tag: ${{ github.ref }}\n release_name: \"Pre-release v${{ env.RELEASE_VERSION }}\"\n prerelease: true\n\n publish-crates-io:\n name: Publish on crates.io\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Set the release version\n run: echo \"RELEASE_VERSION=${GITHUB_REF:11}\" >> $GITHUB_ENV\n - name: Install Rust toolchain\n uses: dtolnay/rust-toolchain@4305c38b25d97ef35a8ad1f985ccf2d2242004f2 # stable\n with:\n targets: x86_64-unknown-linux-gnu\n - name: Prepare for the crates.io release\n run: |\n mkdir git-cliff-core/config/\n cp config/cliff.toml git-cliff-core/config/\n sed -i 's|\"../config/\"|\"config/\"|' git-cliff-core/src/embed.rs\n mkdir git-cliff-core/examples/\n cp -r examples git-cliff-core\n sed -i 's|\"../examples/\"|\"examples/\"|' git-cliff-core/src/embed.rs\n - name: Publish the library\n run: |\n cargo publish --allow-dirty --manifest-path git-cliff-core/Cargo.toml \\\n --locked --token ${{ secrets.CARGO_TOKEN }}\n - name: Wait for library to update\n shell: bash\n run: |\n crate_status=\"https://raw.githubusercontent.com/rust-lang/crates.io-index/master/gi/t-/git-cliff-core\"\n until curl -s \"$crate_status\" | grep -q '\"vers\":\"${{ env.RELEASE_VERSION }}\"'; do sleep 5; done;\n - name: Publish the binary\n run: |\n cargo publish --allow-dirty --manifest-path git-cliff/Cargo.toml \\\n --locked --token ${{ secrets.CARGO_TOKEN }}\n\n publish-homebrew:\n name: Publish Homebrew formula\n if: ${{ !contains(github.ref, '-') }}\n runs-on: ubuntu-22.04\n permissions:\n contents: read\n steps:\n - name: Bump formula\n uses: mislav/bump-homebrew-formula-action@56a283fa15557e9abaa4bdb63b8212abc68e655c # v3.6\n with:\n formula-name: git-cliff\n formula-path: Formula/g/git-cliff.rb\n env:\n COMMITTER_TOKEN: ${{ secrets.HOMEBREW_COMMITTER_TOKEN }}\n" }, { "path": ".github/workflows/check-semver.yml", "content": "name: Check Semver\n\n# on:\n# pull_request:\n# branches:\n# - main\n\non: workflow_dispatch\n\njobs:\n check-semver:\n name: Check semver\n runs-on: ubuntu-latest\n outputs:\n error_message: ${{ steps.check_semver.outputs.error_message }}\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Run cargo-semver-checks\n id: check_semver\n uses: orhun/cargo-semver-checks-action@cc19b888f2062f8cc964c1d52f7f29d910becb31 # feat/add_action_output\n\n comment-on-pr:\n name: Comment on pull request\n runs-on: ubuntu-latest\n needs: check-semver\n if: always()\n permissions:\n pull-requests: write\n steps:\n - name: Comment\n if: ${{ needs.check-semver.outputs.error_message != null }}\n uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4\n with:\n header: pr-semver-check-error\n message: |\n Thank you for opening this pull request!\n\n Reviewer note: [cargo-semver-checks](https://github.com/obi1kenobi/cargo-semver-checks) reported the current version number is not SemVer-compatible with the changes made since the last release.\n\n Details:\n\n ```\n ${{ needs.check-semver.outputs.error_message }}\n ```\n\n - name: Delete comment\n if: ${{ needs.check-semver.outputs.error_message == null }}\n uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4\n with:\n header: pr-semver-check-error\n delete: true\n" }, { "path": ".github/workflows/ci.yml", "content": "name: Continuous Integration\n\non:\n pull_request:\n push:\n branches:\n - main\n - staging # for bors\n - trying # for bors\n schedule:\n - cron: \"0 0 * * 0\"\n\npermissions:\n pull-requests: write\n\njobs:\n check:\n name: Check\n runs-on: ubuntu-22.04\n steps:\n - name: Install toolchain\n uses: dtolnay/rust-toolchain@4305c38b25d97ef35a8ad1f985ccf2d2242004f2 # stable\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Check\n uses: actions-rs/cargo@844f36862e911db73fe0815f00a4a2602c279505 # v1.0.3\n with:\n command: check\n args: --locked --verbose\n - name: Check without default features\n uses: actions-rs/cargo@844f36862e911db73fe0815f00a4a2602c279505 # v1.0.3\n with:\n command: check\n args: --locked --no-default-features --verbose\n\n typos:\n name: Typos\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Check typos\n uses: crate-ci/typos@3504f4613b41e223d38c08c6953c3ef30bf29fac # master\n\n test:\n name: Test suite\n runs-on: ubuntu-22.04\n steps:\n - name: Install toolchain\n uses: dtolnay/rust-toolchain@b95584d8105b9ab200e15821fa671848cf2b7017 # nightly\n - name: Checkout\n if: github.event_name != 'pull_request'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n fetch-depth: 0\n - name: Checkout\n if: github.event_name == 'pull_request'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n ref: ${{ github.event.pull_request.head.sha }}\n fetch-depth: 0\n - name: Setup cargo-tarpaulin\n uses: taiki-e/install-action@db542c1ee140717096741d8188a70ff7cb9efb87 # cargo-tarpaulin\n - name: Run tests\n run: |\n cargo test --no-default-features \\\n -- --skip \"repo::test::git_upstream_remote\"\n - name: Run tests\n run: |\n cargo tarpaulin --out xml --verbose --all-features \\\n -- --skip \"repo::test::git_upstream_remote\"\n - name: Upload reports to codecov\n if: github.actor != 'dependabot[bot]'\n uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2\n with:\n name: code-coverage-report\n files: cobertura.xml\n flags: unit-tests\n fail_ci_if_error: true\n verbose: true\n token: ${{ secrets.CODECOV_TOKEN }}\n\n clippy:\n name: Lints\n runs-on: ubuntu-22.04\n steps:\n - name: Install toolchain\n uses: dtolnay/rust-toolchain@b95584d8105b9ab200e15821fa671848cf2b7017 # nightly\n with:\n components: clippy\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Check the lints\n uses: actions-rs/cargo@844f36862e911db73fe0815f00a4a2602c279505 # v1.0.3\n with:\n # Lints are configured via CLI arguments to avoid confusion with Cargo.toml precedence.\n command: clippy\n args: --tests --verbose -- -D warnings\n - name: Check the pedantic lints\n uses: actions-rs/cargo@844f36862e911db73fe0815f00a4a2602c279505 # v1.0.3\n with:\n # Lints are configured via CLI arguments to avoid confusion with Cargo.toml precedence.\n command: clippy\n args: --all-targets --verbose -- -W clippy::pedantic\n\n rustfmt:\n name: Formatting\n runs-on: ubuntu-22.04\n steps:\n - name: Install toolchain\n uses: dtolnay/rust-toolchain@b95584d8105b9ab200e15821fa671848cf2b7017 # nightly\n with:\n toolchain: nightly\n components: rustfmt\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Check the formatting\n run: cargo +nightly fmt --all -- --check --verbose\n\n doctest:\n name: Doctests\n runs-on: ubuntu-22.04\n steps:\n - name: Install toolchain\n uses: dtolnay/rust-toolchain@b95584d8105b9ab200e15821fa671848cf2b7017 # nightly\n with:\n components: rustfmt\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Check the formatting\n uses: actions-rs/cargo@844f36862e911db73fe0815f00a4a2602c279505 # v1.0.3\n with:\n command: test\n args: --doc\n\n lychee:\n name: Links\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Check website links\n uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0\n with:\n args: >\n -v\n --config lychee.toml\n --root-dir website\n website/docs/* website/blog/*\n fail: true\n token: ${{ secrets.GITHUB_TOKEN }}\n - name: Check root markdown links\n uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0\n with:\n args: >\n -v\n --config lychee.toml\n *.md\n fail: true\n token: ${{ secrets.GITHUB_TOKEN }}\n\n msrv:\n name: Check Rust version\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Install cargo-binstall\n uses: taiki-e/install-action@f45419ef14ff13c4459e1c4310c1ff046eff6b30 # cargo-binstall\n - name: Install cargo-msrv\n run: cargo binstall -y cargo-msrv\n - name: Run cargo-msrv\n shell: bash\n run: |\n for package in \"git-cliff\" \"git-cliff-core\"; do\n printf \"Checking MSRV for $package...\"\n cargo msrv --output-format json --path \"$package\" verify | tail -n 1 | jq --exit-status '.success'\n done\n\n tarball:\n name: Check NodeJS tarball\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Install node\n uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0\n with:\n node-version: 18\n registry-url: \"https://registry.npmjs.org\"\n - name: Validate the files in the tarball\n shell: bash\n working-directory: npm/git-cliff\n run: |\n yarn install\n yarn build\n cp ../../README.md .\n cp ../../CHANGELOG.md .\n\n files_expected_in_tarball=(\n \"CHANGELOG.md\"\n \"README.md\"\n \"lib/cjs/index.cjs\"\n \"lib/cjs/index.cjs.map\"\n \"lib/cjs/index.d.cts\"\n \"lib/cli/cli.js\"\n \"lib/esm/index.d.ts\"\n \"lib/esm/index.js\"\n \"lib/esm/index.js.map\"\n \"package.json\"\n )\n\n tarball_output=$(yarn pack --dry-run)\n\n for file in \"${files_expected_in_tarball[@]}\"; do\n if [[ ! \"$tarball_output\" == *\"$file\"* ]]; then\n echo \"Error: Expected file '$file' not found in tarball.\"\n exit 1\n fi\n done\n\n profiler:\n name: Run profiler\n runs-on: ubuntu-22.04\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n fetch-depth: 0\n - name: Install toolchain\n uses: dtolnay/rust-toolchain@4305c38b25d97ef35a8ad1f985ccf2d2242004f2 # stable\n - name: Run profiler\n run: cargo run --profile bench --features profiler -- --no-exec\n - name: Upload report\n uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0\n with:\n name: git-cliff.${{ github.run_id }}-profiler-report\n path: git-cliff.**.flamegraph.svg\n\n nix-flake:\n name: Build Nix flake\n runs-on: ubuntu-latest\n steps:\n - name: Checkout the repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Install Nix\n uses: nixbuild/nix-quick-install-action@2c9db80fb984ceb1bcaa77cdda3fdf8cfba92035 # v34\n\n - name: Restore and cache Nix store\n uses: nix-community/cache-nix-action@7df957e333c1e5da7721f60227dbba6d06080569 # v7.0.2\n with:\n primary-key: nix-${{ runner.os }}-${{ hashFiles('**/*.nix') }}\n restore-prefixes-first-match: nix-${{ runner.os }}-\n gc-max-store-size-linux: 1073741824\n purge: false\n\n - name: Check Nix flake\n run: nix flake check --all-systems -Lv --show-trace\n" }, { "path": ".github/workflows/codeql.yml", "content": "# For most projects, this workflow file will not need changing; you simply need\n# to commit it to your repository.\n#\n# You may wish to alter this file to override the set of languages analyzed,\n# or to provide custom queries or build logic.\n#\n# ******** NOTE ********\n# We have attempted to detect the languages in your repository. Please check\n# the `language` matrix defined below to confirm you have the correct set of\n# supported CodeQL languages.\n#\nname: \"CodeQL\"\n\non:\n push:\n branches: [\"main\"]\n pull_request:\n # The branches below must be a subset of the branches above\n branches: [\"main\"]\n schedule:\n - cron: \"0 0 * * 1\"\n\npermissions:\n contents: read\n\njobs:\n analyze:\n name: Analyze\n runs-on: ubuntu-latest\n permissions:\n actions: read\n contents: read\n security-events: write\n\n strategy:\n fail-fast: false\n matrix:\n language: [\"javascript\", \"typescript\"]\n # CodeQL supports [ $supported-codeql-languages ]\n # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n # Initializes the CodeQL tools for scanning.\n - name: Initialize CodeQL\n uses: github/codeql-action/init@0d579ffd059c29b07949a3cce3983f0780820c98 # v4.32.6\n with:\n languages: ${{ matrix.language }}\n # If you wish to specify custom queries, you can do so here or in a config file.\n # By default, queries listed here will override any specified in a config file.\n # Prefix the list here with \"+\" to use these queries and those in the config file.\n\n # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).\n # If this step fails, then you should remove it and run the build manually (see below)\n - name: Autobuild\n uses: github/codeql-action/autobuild@0d579ffd059c29b07949a3cce3983f0780820c98 # v4.32.6\n\n # ℹ️ Command-line programs to run using the OS shell.\n # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun\n\n # If the Autobuild fails above, remove it and uncomment the following three lines.\n # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.\n\n # - run: |\n # echo \"Run, Build Application using script\"\n # ./location_of_script_within_repo/buildscript.sh\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@0d579ffd059c29b07949a3cce3983f0780820c98 # v4.32.6\n with:\n category: \"/language:${{matrix.language}}\"\n" }, { "path": ".github/workflows/dependency-review.yml", "content": "# Dependency Review Action\n#\n# This Action will scan dependency manifest files that change as part of a Pull Request,\n# surfacing known-vulnerable versions of the packages declared or updated in the PR.\n# Once installed, if the workflow run is marked as required,\n# PRs introducing known-vulnerable packages will be blocked from merging.\n#\n# Source repository: https://github.com/actions/dependency-review-action\nname: 'Dependency Review'\non: [pull_request]\n\npermissions:\n contents: read\n\njobs:\n dependency-review:\n runs-on: ubuntu-latest\n steps:\n - name: 'Checkout Repository'\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: 'Dependency Review'\n uses: actions/dependency-review-action@2031cfc080254a8a887f58cffee85186f0e49e48 # v4.9.0\n" }, { "path": ".github/workflows/docker.yml", "content": "name: Docker Automated Builds\n\non:\n push:\n branches:\n - main\n tags:\n - \"v*.*.*\"\n pull_request:\n branches:\n - main\n schedule:\n - cron: \"0 0 * * 0\"\n\njobs:\n docker:\n name: Docker Build and Push\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Docker meta\n id: meta\n uses: docker/metadata-action@030e881283bb7a6894de51c315a6bfe6a94e05cf # v6.0.0\n with:\n images: |\n orhunp/git-cliff\n ghcr.io/${{ github.repository_owner }}/git-cliff/git-cliff\n tags: |\n type=schedule\n type=ref,event=branch\n type=ref,event=pr\n type=sha\n type=raw,value=latest,enable=${{ startsWith(github.ref, 'refs/tags/') }}\n type=raw,value=main,enable=${{ github.ref == 'refs/heads/main' }}\n type=semver,pattern={{version}}\n\n - name: Find Image by SHA Tag\n id: image_sha_tag\n env:\n META_JSON: ${{ steps.meta.outputs.json }}\n # This jq script is the most direct way to pull the current sha tag for targeting\n # the security scan.\n # The JSON output is currently an object and one property is the tags array.\n # That array contains and entry like \"ghcr.io/orhun/git-cliff/git-cliff:sha-1810ad6\"\n # This JQ script pulls the tags, then selects the first one that contains both\n # `ghcr.io` and `:sha-`. The full tag value is then exported to be used later.\n run: |\n tag_value=\"$(\n jq -r '\n first(.tags[] | select(contains(\"ghcr.io\") and contains(\":sha-\")))\n ' <<< \"$META_JSON\"\n )\"\n echo \"image=$tag_value\" >> \"$GITHUB_OUTPUT\"\n\n - name: Set up QEMU\n uses: docker/setup-qemu-action@ce360397dd3f832beb865e1373c09c0e9f86d70a # v4.0.0\n with:\n platforms: arm64\n\n - name: Set up Docker Buildx\n id: buildx\n uses: docker/setup-buildx-action@4d04d5d9486b7bd6fa91e7baf45bbb4f8b9deedd # v4.0.0\n\n - name: Cache Docker layers\n uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5.0.3\n with:\n path: /tmp/.buildx-cache\n key: ${{ runner.os }}-buildx-${{ github.sha }}\n restore-keys: |\n ${{ runner.os }}-buildx-\n\n - name: Login to Docker Hub\n if: github.event_name != 'pull_request'\n uses: docker/login-action@b45d80f862d83dbcd57f89517bcf500b2ab88fb2 # v4.0.0\n with:\n username: ${{ secrets.DOCKER_HUB_USERNAME }}\n password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}\n\n - name: Login to GHCR\n if: github.event_name != 'pull_request'\n uses: docker/login-action@b45d80f862d83dbcd57f89517bcf500b2ab88fb2 # v4.0.0\n with:\n registry: ghcr.io\n username: ${{ github.repository_owner }}\n password: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Build and push\n id: docker_build\n uses: docker/build-push-action@d08e5c354a6adb9ed34480a06d141179aa583294 # v7.0.0\n with:\n context: ./\n file: ./Dockerfile\n platforms: linux/amd64,linux/arm64\n builder: ${{ steps.buildx.outputs.name }}\n push: ${{ github.event_name != 'pull_request' }}\n tags: ${{ steps.meta.outputs.tags }}\n sbom: true\n provenance: true\n labels: ${{ steps.meta.outputs.labels }}\n cache-from: type=local,src=/tmp/.buildx-cache\n cache-to: type=local,dest=/tmp/.buildx-cache\n\n - name: Scan the image\n if: github.event_name != 'pull_request'\n uses: anchore/sbom-action@57aae528053a48a3f6235f2d9461b05fbcb7366d # v0.23.1\n with:\n image: ${{ steps.image_sha_tag.outputs.image }}\n\n - name: Image digest\n run: echo ${{ steps.docker_build.outputs.digest }}\n" }, { "path": ".github/workflows/test-fixtures.yml", "content": "name: Test fixtures\n\non:\n push:\n branches:\n - main\n pull_request:\n branches:\n - main\n\njobs:\n test-fixtures:\n name: Test fixtures\n runs-on: ubuntu-22.04\n strategy:\n fail-fast: false\n matrix:\n include:\n - fixtures-name: new-fixture-template\n - fixtures-name: test-github-integration\n - fixtures-name: test-github-integration-custom-range\n command: v1.0.0..v1.0.1\n - fixtures-name: test-gitlab-integration\n - fixtures-name: test-gitlab-integration-custom-range\n command: 9f66ac0f76..89de5e8e50\n - fixtures-name: test-gitea-integration\n - fixtures-name: test-gitea-integration-custom-range\n command: 5ed596d935..c074c439b5\n - fixtures-name: test-bitbucket-integration\n - fixtures-name: test-bitbucket-integration-custom-range\n command: v1.0.0..v1.0.1\n - fixtures-name: test-azure-devops-integration\n - fixtures-name: test-azure-devops-integration-custom-range\n command: v1.0.0..v1.0.1\n - fixtures-name: test-ignore-tags\n - fixtures-name: test-invert-ignore-tags\n - fixtures-name: test-topo-order\n command: --latest\n - fixtures-name: test-date-order\n command: --latest\n - fixtures-name: test-topo-order-arg\n command: --latest --topo-order\n - fixtures-name: test-latest-with-one-tag\n command: --latest\n - fixtures-name: test-commit-footers\n - fixtures-name: test-commit-preprocessors\n - fixtures-name: test-conventional-commit\n - fixtures-name: test-custom-scope\n - fixtures-name: test-limit-commits\n - fixtures-name: test-skip-breaking-changes\n - fixtures-name: test-split-commits\n - fixtures-name: test-bump-version\n command: --bump\n - fixtures-name: test-bump-version-major\n command: --bump major\n - fixtures-name: test-bump-version-minor\n command: --bump minor\n - fixtures-name: test-bump-version-patch\n command: --bump patch\n - fixtures-name: test-bump-version-custom-minor\n command: --bump\n - fixtures-name: test-bumped-version\n command: --bumped-version\n - fixtures-name: test-footer-template\n - fixtures-name: test-keep-a-changelog-links\n - fixtures-name: test-keep-a-changelog-links-current-arg\n command: --current\n - fixtures-name: test-keep-a-changelog-links-current-arg\n command: --latest\n - fixtures-name: test-keep-a-changelog-links-latest-arg\n command: --latest\n - fixtures-name: test-keep-a-changelog-links-no-tags\n - fixtures-name: test-keep-a-changelog-links-no-tags\n command: --unreleased\n - fixtures-name: test-keep-a-changelog-links-no-tags\n command: --latest\n - fixtures-name: test-keep-a-changelog-links-no-tags\n command: --current\n - fixtures-name: test-keep-a-changelog-links-one-tag\n - fixtures-name: test-keep-a-changelog-links-tag-arg\n command: --tag v0.3.0\n - fixtures-name: test-keep-a-changelog-links-unreleased-arg\n command: --unreleased\n - fixtures-name: test-keep-a-changelog-links-unreleased-arg\n command: --latest --unreleased\n - fixtures-name: test-keep-a-changelog-links-one-tag-bump-arg\n command: --bump\n - fixtures-name: test-skip-commits\n command: --skip-commit ad27b43e8032671afb4809a1a3ecf12f45c60e0e\n - fixtures-name: test-no-exec\n command: --no-exec\n - fixtures-name: test-custom-tag-pattern\n command: --tag-pattern \"alpha.*\"\n - fixtures-name: test-configure-from-cargo-toml\n - fixtures-name: test-bump-initial-tag\n command: --bump\n - fixtures-name: test-bump-initial-tag-default\n command: --bump\n - fixtures-name: test-bump-initial-tag-cli-arg\n command: --bump --tag=2.1.1\n - fixtures-name: test-cli-arg-ignore-tags\n command: --ignore-tags \".*beta\"\n - fixtures-name: test-cli-arg-skip-tags\n command: --skip-tags \".*beta\"\n - fixtures-name: test-tag-message\n - fixtures-name: test-bump-unreleased-with-tag-message-arg\n command: --bump --unreleased --with-tag-message \"Some text\"\n - fixtures-name: test-unreleased-tag-missing-release-commit\n command: --unreleased --tag 0.3.0\n - fixtures-name: test-from-context\n command: --from-context context.json\n - fixtures-name: test-from-context-does-not-discard-fields\n command: --from-context context.json\n - fixtures-name: test-always-render-unreleased\n command: --unreleased\n - fixtures-name: test-always-render\n command: --unreleased --tag v0.2.0\n - fixtures-name: test-unchanged-tag-date\n command: --tag v0.2.0\n - fixtures-name: test-custom-remote-api-url\n command: v1.4.0..v1.4.1\n - fixtures-name: test-monorepo-include-path\n command: v2.6.1..v2.7.0 --include-path .github/fixtures/\n - fixtures-name: test-require-conventional-negative\n - fixtures-name: test-require-conventional-skipped\n - fixtures-name: test-submodules\n - fixtures-name: test-submodules-range\n command: v0.1.0..HEAD\n - fixtures-name: test-submodules-include-path\n command: --include-path submodule_two\n - fixtures-name: test-submodules-include-path-config\n - fixtures-name: test-remote-config\n command: --config-url \"https://github.com/orhun/git-cliff/blob/main/.github/fixtures/new-fixture-template/cliff.toml?raw=true\"\n - fixtures-name: test-topo-order-commits\n - fixtures-name: test-commit-range\n - fixtures-name: test-commit-range-with-sort-commits\n - fixtures-name: test-commit-range-with-given-range\n command: a140cef^..a9d4050 --ignore-tags \".\"\n - fixtures-name: test-override-scope\n - fixtures-name: test-regex-json-array\n - fixtures-name: test-release-statistics\n previous-release-timestamp: \"2022-04-06 01:25:12\"\n - fixtures-name: test-workdir-include-path\n command: v2.6.1..v2.7.0 --workdir .github/fixtures/\n - fixtures-name: test-fail-on-unmatched-commit\n - fixtures-name: test-offline\n\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n\n - name: Run a fixtures test\n uses: ./.github/actions/run-fixtures-test\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n fixtures-dir: .github/fixtures/${{ matrix.fixtures-name }}\n command: ${{ matrix.command }}\n previous-release-timestamp: ${{ matrix.previous-release-timestamp }}\n" }, { "path": ".github/workflows/website.yml", "content": "name: Deploy website\n\non:\n push:\n branches:\n - main\n tags:\n - \"v*.*.*\"\n pull_request:\n branches:\n - main\n workflow_dispatch:\n\npermissions:\n contents: read\n pages: write\n id-token: write\n\nconcurrency:\n group: \"pages\"\n cancel-in-progress: true\n\nenv:\n NODE_OPTIONS: --max-old-space-size=6144\n\njobs:\n test-deploy:\n name: Test deployment\n if: ${{ !startsWith(github.ref, 'refs/tags/v') }}\n runs-on: ubuntu-22.04\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Set up Node.js\n uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0\n with:\n node-version: 20\n cache: yarn\n cache-dependency-path: ./website/yarn.lock\n - name: Enable Corepack\n run: corepack enable\n - name: Install dependencies\n working-directory: ./website\n run: yarn install --frozen-lockfile --non-interactive\n - name: Build\n working-directory: ./website\n run: yarn build\n\n deploy:\n name: Deploy website\n if: ${{ startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch' }}\n runs-on: ubuntu-22.04\n environment:\n name: github-pages\n url: ${{ steps.deployment.outputs.page_url }}\n steps:\n - name: Checkout\n uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n - name: Set up Node.js\n uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0\n with:\n node-version: 20\n cache: yarn\n cache-dependency-path: ./website/yarn.lock\n - name: Enable Corepack\n run: corepack enable\n - name: Install dependencies\n working-directory: ./website\n run: yarn install --frozen-lockfile --non-interactive\n - name: Build\n working-directory: ./website\n run: yarn build\n - name: Setup Pages\n uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0\n - name: Upload artifact\n uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0\n with:\n path: website/build\n - name: Deploy to GitHub Pages\n id: deployment\n uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5\n" }, { "path": ".gitignore", "content": "# Compiled files and executables\n/target/\n\n# Backup files generated by rustfmt\n**/*.rs.bk\n\n*.flamegraph.svg\n\n# direnv\n/.direnv/\n\n# Potential Nix stuff\n/result\n/result-*\n" }, { "path": ".lycheeignore", "content": "file:///\n%7Busername%7D\nhttps://datatracker.ietf.org\nprotonmail\nhttps://github.com/cocogitto/cocogitto\npypi.org\nhttps://console.substack.com\ngit-cliff/commit/\npatreon\n# Currently commented out; kept as a reference in case we want to skip npm in the future.\n# See: https://github.com/orgs/community/discussions/174098\n#https://www.npmjs.com\n# GitHub issues and PR links are occasionally unstable (502/403) due to GitHub edge/CDN behavior.\n# These links are mostly generated in CHANGELOGs and do not need strict availability checks in CI.\nhttps://github.com/.*/issues/.*\nhttps://github.com/.*/pull/.*\n" }, { "path": ".well-known/funding-manifest-urls", "content": "https://orhun.dev/funding.json\n" }, { "path": "CHANGELOG.md", "content": "[![animation](https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff-anim.gif)](https://git-cliff.org)\n\n## [2.12.0](https://github.com/orhun/git-cliff/compare/v2.11.0..v2.12.0) - 2026-01-20\n\n### ⛰️ Features\n\n- *(args)* Add offline flag ([#1321](https://github.com/orhun/git-cliff/issues/1321)) - ([f19f1cd](https://github.com/orhun/git-cliff/commit/f19f1cdf661d9a8176549c1608290448ebabd7c4))\n- *(args)* Add `--skip-tags` cli argument ([#1334](https://github.com/orhun/git-cliff/issues/1334)) - ([32cf8c5](https://github.com/orhun/git-cliff/commit/32cf8c508cdf21a2fa6a1151ef2a51db81a8c739))\n- *(logging)* Implement commit processing summary ([#1355](https://github.com/orhun/git-cliff/issues/1355)) - ([aa01a09](https://github.com/orhun/git-cliff/commit/aa01a09de21a737d5715a0fcf34504d036cdb53b))\n\n### 🐛 Bug Fixes\n\n- *(config)* Respect the changelog.output configuration ([#1349](https://github.com/orhun/git-cliff/issues/1349)) - ([cfcc5ae](https://github.com/orhun/git-cliff/commit/cfcc5ae1c2c3bbb125cae27186649aaaeb32eb10))\n- *(logging)* Revert the noisy warn log level to trace ([#1353](https://github.com/orhun/git-cliff/issues/1353)) - ([eb99e41](https://github.com/orhun/git-cliff/commit/eb99e41191483d9cb285b7e9c4aa5f7695615143))\n- *(remote)* Avoid false first-time contributors when tag timestamp missing ([#1348](https://github.com/orhun/git-cliff/issues/1348)) - ([de7cf02](https://github.com/orhun/git-cliff/commit/de7cf022e9d33a8ecdaf44fe56445a9d02fc1f1a))\n- *(remote)* Remove reqwest::Response::error_for_status ([#1336](https://github.com/orhun/git-cliff/issues/1336)) - ([081ba68](https://github.com/orhun/git-cliff/commit/081ba68753d388d5d6369da4460fe56060d7b359))\n\n### 📚 Documentation\n\n- *(contributing)* Clarify Rust toolchain requirements ([#1344](https://github.com/orhun/git-cliff/issues/1344)) - ([97b0322](https://github.com/orhun/git-cliff/commit/97b0322210ceaaaf12c96ab2ae63646a4d844f1c))\n- *(install)* Add mise alternative method installation ([#1320](https://github.com/orhun/git-cliff/issues/1320)) - ([34b8d30](https://github.com/orhun/git-cliff/commit/34b8d30988ee486ff3e2462301f75488ab6dcfb7))\n- *(website)* Add highlights for 2.12.0 ([#1356](https://github.com/orhun/git-cliff/issues/1356)) - ([0228f43](https://github.com/orhun/git-cliff/commit/0228f438ec41614e53611928ade7d7a971211522))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(azure_devops)* [**breaking**] Rename azureDevops variable to azure_devops ([#1319](https://github.com/orhun/git-cliff/issues/1319)) - ([5d955c1](https://github.com/orhun/git-cliff/commit/5d955c1e5addc76a12ead7e4cc0fe08eabeeea2c))\n- *(ci)* Fix codecov action inputs and skip upload for dependabot PRs ([#1343](https://github.com/orhun/git-cliff/issues/1343)) - ([d7a47bb](https://github.com/orhun/git-cliff/commit/d7a47bb03ed794a9f8701f801600e06d8dbde834))\n- *(clippy)* Fix pedantic lints ([#1346](https://github.com/orhun/git-cliff/issues/1346)) - ([0260b0a](https://github.com/orhun/git-cliff/commit/0260b0a7ca4ea9281f5b9ca48709d46891376852))\n- Update yarn.lock ([#1322](https://github.com/orhun/git-cliff/issues/1322)) - ([0cec8a0](https://github.com/orhun/git-cliff/commit/0cec8a0c0dd2bc0ef94ab608f8d01f7482311792))\n\n## New Contributors ❤️\n\n* @taladar made their first contribution in [#1319](https://github.com/orhun/git-cliff/pull/1319)\n* @barskern made their first contribution in [#1321](https://github.com/orhun/git-cliff/pull/1321)\n* @ooooo-create made their first contribution in [#1334](https://github.com/orhun/git-cliff/pull/1334)\n* @jylenhof made their first contribution in [#1320](https://github.com/orhun/git-cliff/pull/1320)\n\n## [2.11.0](https://github.com/orhun/git-cliff/compare/v2.10.1..v2.11.0) - 2025-12-14\n\n### ⛰️ Features\n\n- *(changelog)* Support failing on unmatched commits ([#1298](https://github.com/orhun/git-cliff/issues/1298)) - ([a22a1a3](https://github.com/orhun/git-cliff/commit/a22a1a39975eb28af5a640266e8abb7c464b1c8d))\n- *(integration)* Add support for azure devops ([#1283](https://github.com/orhun/git-cliff/issues/1283)) - ([ef65be6](https://github.com/orhun/git-cliff/commit/ef65be6cfb024e99086f10ef7d533014dee3af33))\n- *(repo)* Improve repository/directory path resolution ([#1290](https://github.com/orhun/git-cliff/issues/1290)) - ([7b1825b](https://github.com/orhun/git-cliff/commit/7b1825bd7a10a10bee5b538337cce41edbe1880c))\n- *(template)* Add split_regex, replace_regex, find_regex filters ([#1287](https://github.com/orhun/git-cliff/issues/1287)) - ([8270084](https://github.com/orhun/git-cliff/commit/8270084ccd35e09a63d79132ad291b192f89e893))\n\n### 🐛 Bug Fixes\n\n- *(args)* Set the include-path if workdir is set ([#1293](https://github.com/orhun/git-cliff/issues/1293)) - ([50b8312](https://github.com/orhun/git-cliff/commit/50b8312adcf03992a2e9eb334c4c604450110d91))\n- *(bump)* Write bumped version to stdout even when output config is set ([#1307](https://github.com/orhun/git-cliff/issues/1307)) - ([314ff57](https://github.com/orhun/git-cliff/commit/314ff57d9138da86027164b7cbeb7045c6f550f7))\n- *(remote)* Use optional default branch for GitLab ([#1305](https://github.com/orhun/git-cliff/issues/1305)) - ([d3cb938](https://github.com/orhun/git-cliff/commit/d3cb93861037e722f10194b77a70d83489fabd02))\n- *(repo)* Always discover repositories - ([b4db79f](https://github.com/orhun/git-cliff/commit/b4db79f01a3e65fde5e9a9caf5d17a0a7a8fdac6))\n- *(workdir)* Use the correct glob value for include-path - ([0fbc625](https://github.com/orhun/git-cliff/commit/0fbc625616baecc14cfacb9d690f746448f39fec))\n\n### 🚜 Refactor\n\n- *(core)* Improve the generation API ([#1306](https://github.com/orhun/git-cliff/issues/1306)) - ([1e80739](https://github.com/orhun/git-cliff/commit/1e807398bd7d031cfb9df3054cdccba9817605ea))\n- *(remote)* Expose commits and PRs as streams ([#1272](https://github.com/orhun/git-cliff/issues/1272)) - ([b82221a](https://github.com/orhun/git-cliff/commit/b82221abd1981b6ecce8ab428fede8165ebb4246))\n\n### 📚 Documentation\n\n- *(config)* Fix comment for topo_order_commits ([#1314](https://github.com/orhun/git-cliff/issues/1314)) - ([c8aad00](https://github.com/orhun/git-cliff/commit/c8aad006c5f42df4659eb21a5feb7cf71a25c3e5))\n- *(installation)* Mention the side-bar ([#1226](https://github.com/orhun/git-cliff/issues/1226)) - ([16ca78e](https://github.com/orhun/git-cliff/commit/16ca78e82e28f404d2dc95d57b837c46cb760512))\n- *(website)* Add highlights for 2.11.0 ([#1316](https://github.com/orhun/git-cliff/issues/1316)) - ([5af715d](https://github.com/orhun/git-cliff/commit/5af715d3c0a0a907eaa35814a4a939936e9fc4b2))\n- *(website)* Fix styling in installation page - ([58c4cfb](https://github.com/orhun/git-cliff/commit/58c4cfbf0a5aaf497b33c225ec6987fcf0a8eeb8))\n- *(website)* Use the correct link for Github PR labels as groups ([#1285](https://github.com/orhun/git-cliff/issues/1285)) - ([85cc05d](https://github.com/orhun/git-cliff/commit/85cc05dda8a3b96864cbb62ca648275a1323e2fc))\n\n### 🎨 Styling\n\n- *(args)* Group remote-related CLI arguments under REMOTE OPTIONS heading ([#1271](https://github.com/orhun/git-cliff/issues/1271)) - ([0b6af12](https://github.com/orhun/git-cliff/commit/0b6af122bb8d39f000591a4a700f8c011ac1827d))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(ci)* Stabilize lychee link checking in CI ([#1295](https://github.com/orhun/git-cliff/issues/1295)) - ([7ed1db0](https://github.com/orhun/git-cliff/commit/7ed1db0527211c9be2f54425498f823c503482c2))\n- *(logging)* Increase log verbosity ([#1244](https://github.com/orhun/git-cliff/issues/1244)) - ([ee9f742](https://github.com/orhun/git-cliff/commit/ee9f7428958d2b602f0c82749f8ed8da7214fac8))\n- *(npm)* Update git-cliff to v2.10.1 ([#1265](https://github.com/orhun/git-cliff/issues/1265)) - ([3da8f26](https://github.com/orhun/git-cliff/commit/3da8f2678b872569a2875e1ca05707bc26124c78))\n\n## New Contributors ❤️\n\n* @Lewiscowles1986 made their first contribution in [#1226](https://github.com/orhun/git-cliff/pull/1226)\n* @OpenSauce made their first contribution in [#1314](https://github.com/orhun/git-cliff/pull/1314)\n* @amd989 made their first contribution in [#1283](https://github.com/orhun/git-cliff/pull/1283)\n* @asweet-confluent made their first contribution in [#1272](https://github.com/orhun/git-cliff/pull/1272)\n* @linus-skold made their first contribution in [#1287](https://github.com/orhun/git-cliff/pull/1287)\n* @simoncdna made their first contribution in [#1305](https://github.com/orhun/git-cliff/pull/1305)\n* @haidaraM made their first contribution in [#1285](https://github.com/orhun/git-cliff/pull/1285)\n* @ritoban23 made their first contribution in [#1271](https://github.com/orhun/git-cliff/pull/1271)\n\n## [2.10.1](https://github.com/orhun/git-cliff/compare/v2.10.0..v2.10.1) - 2025-09-21\n\n### ⛰️ Features\n\n- *(cli)* Honor XDG_CONFIG_HOME on macOS ([#1259](https://github.com/orhun/git-cliff/issues/1259)) - ([6b8f1dc](https://github.com/orhun/git-cliff/commit/6b8f1dc515ed18792128aeaecf6f483a47989165))\n- *(lib)* Add 'integrations' feature flag for enabling all integrations ([#1263](https://github.com/orhun/git-cliff/issues/1263)) - ([3b98d19](https://github.com/orhun/git-cliff/commit/3b98d19d25738f33be8c1f7ebb078987f97abc7f))\n\n### 🐛 Bug Fixes\n\n- *(config)* Link to tree link for first tag in keepachangelog template ([#1250](https://github.com/orhun/git-cliff/issues/1250)) - ([c0c4bf7](https://github.com/orhun/git-cliff/commit/c0c4bf71aaebb2d1ffa96edc117225b01b9a50d4))\n\n### 📚 Documentation\n\n- *(website)* Add a FAQ section for commit and PR strategies ([#1218](https://github.com/orhun/git-cliff/issues/1218)) - ([d822586](https://github.com/orhun/git-cliff/commit/d822586cc99d438136939f416d6e7eb1d6e27d36))\n- *(website)* Add missing gitea feature flag ([#1262](https://github.com/orhun/git-cliff/issues/1262)) - ([20295ac](https://github.com/orhun/git-cliff/commit/20295ac3409106c9a36f2fc0b866fdc30fb9d3a8))\n- *(website)* Add note about nested submodules - ([524f51f](https://github.com/orhun/git-cliff/commit/524f51fb60baf57b61b0df3ee56e8289fb50185f))\n- *(website)* Update git-cliff-action to v4 ([#1241](https://github.com/orhun/git-cliff/issues/1241)) - ([9857d86](https://github.com/orhun/git-cliff/commit/9857d8602129bd1a75144f5a55ba22876a6140a2))\n- *(website)* Add note about next version being checked - ([05eb192](https://github.com/orhun/git-cliff/commit/05eb1923aef586d7fabf14c9894af43da5124d76))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cd)* Update windows runners to windows-2025 - ([3819a0b](https://github.com/orhun/git-cliff/commit/3819a0bafb1afba67ceee48bc64c5c2d15e9cf15))\n- *(examples)* Improve the GitHub templates ([#1249](https://github.com/orhun/git-cliff/issues/1249)) - ([c86647d](https://github.com/orhun/git-cliff/commit/c86647d173b2e3640bdd86c982e485cdb94e7130))\n- *(typescript)* Update execa to v9 ([#1228](https://github.com/orhun/git-cliff/issues/1228)) - ([44c8eec](https://github.com/orhun/git-cliff/commit/44c8eecc134ae33627619bad0d79bf9653442805))\n\n### ◀️ Revert\n\n- *(repo)* Use the correct order while diffing paths ([#1188](https://github.com/orhun/git-cliff/issues/1188)) ([#1257](https://github.com/orhun/git-cliff/issues/1257)) - ([fb61cb5](https://github.com/orhun/git-cliff/commit/fb61cb51aa3223eca231f172f655c75ea03255b0))\n\n## New Contributors ❤️\n\n* @tessus made their first contribution in [#1263](https://github.com/orhun/git-cliff/pull/1263)\n* @mrdomino made their first contribution in [#1250](https://github.com/orhun/git-cliff/pull/1250)\n* @Oakchris1955 made their first contribution in [#1253](https://github.com/orhun/git-cliff/pull/1253)\n* @codemountains made their first contribution in [#1241](https://github.com/orhun/git-cliff/pull/1241)\n\n## [2.10.0](https://github.com/orhun/git-cliff/compare/v2.9.1..v2.10.0) - 2025-07-27\n\n### ⛰️ Features\n\n- *(config)* Support using include and exclude paths in the config ([#1173](https://github.com/orhun/git-cliff/issues/1173)) - ([7c2f922](https://github.com/orhun/git-cliff/commit/7c2f9225f363d5727dcb557b9c708f0023598777))\n- *(parser)* Support regex matching on JSON arrays with scalar elements ([#1163](https://github.com/orhun/git-cliff/issues/1163)) - ([dc458ea](https://github.com/orhun/git-cliff/commit/dc458eab65b711841ba996209404534a254b1775))\n- *(template)* Support adding commit statistics to the changelog ([#1151](https://github.com/orhun/git-cliff/issues/1151)) - ([05a50d7](https://github.com/orhun/git-cliff/commit/05a50d7d9aef7f80dede9a29eac079c4837d08f9))\n\n### 🐛 Bug Fixes\n\n- *(config)* [**breaking**] Use empty header and footer as default ([#1161](https://github.com/orhun/git-cliff/issues/1161)) ([#1172](https://github.com/orhun/git-cliff/issues/1172)) - ([3e9311e](https://github.com/orhun/git-cliff/commit/3e9311ea8ad23da7c09f0771686bd36b24e92265))\n- *(config)* Check if commit.footers is defined in detailed example ([#1170](https://github.com/orhun/git-cliff/issues/1170)) - ([078545f](https://github.com/orhun/git-cliff/commit/078545f55facbd0a82717b723e98589155bedd7e))\n- *(fixtures)* Update expected.md after config change ([#1176](https://github.com/orhun/git-cliff/issues/1176)) - ([76d3e81](https://github.com/orhun/git-cliff/commit/76d3e819b126837d7d8541c18c083cdd9f80ec62))\n- *(generation)* Ensure skip_tags condition is evaluated first ([#1190](https://github.com/orhun/git-cliff/issues/1190)) - ([318be66](https://github.com/orhun/git-cliff/commit/318be6637609c289cf58270222f1fcd29bf893ec))\n- *(repo)* Use the correct order while diffing paths ([#1188](https://github.com/orhun/git-cliff/issues/1188)) - ([ff6c310](https://github.com/orhun/git-cliff/commit/ff6c3105012b5827145ba4bf2bb660cce0b9c7bf))\n\n### 🚜 Refactor\n\n- *(ci)* Apply security best practices ([#1180](https://github.com/orhun/git-cliff/issues/1180)) - ([a32deca](https://github.com/orhun/git-cliff/commit/a32deca80823cf99fd968647217f72fa58c8ccc2))\n- *(config)* Implement FromStr instead of Config::parse_from_str() ([#1185](https://github.com/orhun/git-cliff/issues/1185)) - ([692345e](https://github.com/orhun/git-cliff/commit/692345e4454127e31c44fe46aaccc065ac0854cc))\n- *(test)* Standardize unit tests for commit module ([#1147](https://github.com/orhun/git-cliff/issues/1147)) - ([0446d6a](https://github.com/orhun/git-cliff/commit/0446d6a95fbba03ca17c14b2cc2da48aa06abe6f))\n\n### 📚 Documentation\n\n- *(context)* Add example usage for statistics ([#1162](https://github.com/orhun/git-cliff/issues/1162)) - ([4f7379a](https://github.com/orhun/git-cliff/commit/4f7379a73160d23dcdcca24b63758958e5ca974f))\n- *(quickstart)* Remove repetitive words ([#1200](https://github.com/orhun/git-cliff/issues/1200)) - ([434f9ee](https://github.com/orhun/git-cliff/commit/434f9ee50709ccb07d0b72fe717c6e2309de3320))\n- *(readme)* Fix twitter badge ([#1164](https://github.com/orhun/git-cliff/issues/1164)) - ([68bd85e](https://github.com/orhun/git-cliff/commit/68bd85ed8cd0277bdde19a252091e29ccd9fd8d7))\n- *(readme)* Polish badges ([#1159](https://github.com/orhun/git-cliff/issues/1159)) - ([941cc2b](https://github.com/orhun/git-cliff/commit/941cc2b76084d4e4ab177cbe548bdc5e687f9ae1))\n- *(remote)* Fix inconsistency in remote integration documentation ([#1165](https://github.com/orhun/git-cliff/issues/1165)) - ([deb29dc](https://github.com/orhun/git-cliff/commit/deb29dc3fc04b0aefb140bfed0fbbd795a8a2452))\n- *(website)* Add highlights for 2.10.0 ([#1225](https://github.com/orhun/git-cliff/issues/1225)) - ([a3fe8c9](https://github.com/orhun/git-cliff/commit/a3fe8c95fec8dad9f048626f4b2b1aec9b895cf4))\n- *(website)* Add installation instructions for gentoo-linux ([#1203](https://github.com/orhun/git-cliff/issues/1203)) - ([07fe6bf](https://github.com/orhun/git-cliff/commit/07fe6bfb7624688c99879e761e124ae092afb737))\n\n### 🎨 Styling\n\n- *(formatting)* Use spaces instead of tabs ([#1184](https://github.com/orhun/git-cliff/issues/1184)) - ([0027300](https://github.com/orhun/git-cliff/commit/00273009e7553229bccc02e9f4a00d6f8acb9cd5))\n\n### 🧪 Testing\n\n- *(fixture)* Add test fixture for overriding the conventional scope ([#1166](https://github.com/orhun/git-cliff/issues/1166)) - ([cb84a08](https://github.com/orhun/git-cliff/commit/cb84a08e60ca4c0f6108c95b4f2a62d47069014b))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(build)* Bump MSRV to 1.85.1 - ([d8279d4](https://github.com/orhun/git-cliff/commit/d8279d4d047ebf9e7c00948bbba266ccc75d262a))\n- *(cd)* Use macos-15 runner - ([c156fc5](https://github.com/orhun/git-cliff/commit/c156fc5edb405737b62a802ed9b1e91f9789ef9b))\n- *(cd)* Re-enable sccache for maturin - ([871c3c9](https://github.com/orhun/git-cliff/commit/871c3c949d9f0cb23600a0f4d16e360d20d32ad7))\n- *(crate)* Remove Rust nightly requirement - ([4f3e5af](https://github.com/orhun/git-cliff/commit/4f3e5af46bb51e412dff88001b3d135d8575bbe8))\n- *(fixture)* Update test-regex-json-array fixture ([#1178](https://github.com/orhun/git-cliff/issues/1178)) - ([95f4056](https://github.com/orhun/git-cliff/commit/95f40563a3a9607143e0acc03e81bdeef479bf09))\n- *(format)* Format module imports for readability ([#1183](https://github.com/orhun/git-cliff/issues/1183)) - ([6db7d49](https://github.com/orhun/git-cliff/commit/6db7d49488a248a2fab010480cb955621d4bcf5a))\n- *(git)* Add .git-blame-ignore-revs - ([5b64131](https://github.com/orhun/git-cliff/commit/5b641319336485bbf1294c5da2e9f95378799864))\n- *(npm)* Bump git-cliff to 2.9.1 ([#1156](https://github.com/orhun/git-cliff/issues/1156)) - ([e13b158](https://github.com/orhun/git-cliff/commit/e13b158744bddb17154963f777cb58b4ba424205))\n- *(website)* Update the node version - ([566c2a1](https://github.com/orhun/git-cliff/commit/566c2a11ebda002eae566b06d19263bdfa03af30))\n\n## New Contributors ❤️\n\n* @Nick2bad4u made their first contribution in [#1180](https://github.com/orhun/git-cliff/pull/1180)\n* @aspann made their first contribution in [#1203](https://github.com/orhun/git-cliff/pull/1203)\n* @muzimuzhi made their first contribution in [#1200](https://github.com/orhun/git-cliff/pull/1200)\n* @j-g00da made their first contribution in [#1188](https://github.com/orhun/git-cliff/pull/1188)\n* @Kriskras99 made their first contribution in [#1173](https://github.com/orhun/git-cliff/pull/1173)\n* @wetneb made their first contribution in [#1165](https://github.com/orhun/git-cliff/pull/1165)\n* @gmeligio made their first contribution in [#1170](https://github.com/orhun/git-cliff/pull/1170)\n* @LitoMore made their first contribution in [#1164](https://github.com/orhun/git-cliff/pull/1164)\n\n## [2.9.1](https://github.com/orhun/git-cliff/compare/v2.9.0..v2.9.1) - 2025-06-03\n\n### 🐛 Bug Fixes\n\n- *(cd)* Upgrade bump-homebrew-formula-action to fix import error - ([2da982f](https://github.com/orhun/git-cliff/commit/2da982f3e7c27ea86eb87625d7371a9bea6587db))\n- *(cd)* Disable sccache for maturin - ([f0a2dc6](https://github.com/orhun/git-cliff/commit/f0a2dc6b08f97f3d96e1a33d60a8a56c97c2339b))\n\n\n## [2.9.0](https://github.com/orhun/git-cliff/compare/v2.8.0..v2.9.0) - 2025-06-02\n\n### ⛰️ Features\n\n- *(changelog)* Support recursing into submodules ([#1082](https://github.com/orhun/git-cliff/issues/1082)) - ([4a3c0c0](https://github.com/orhun/git-cliff/commit/4a3c0c0312491a8767645ed4d41b2016049dbe4b))\n- *(config)* Support configuring with a remote URL ([#1083](https://github.com/orhun/git-cliff/issues/1083)) - ([eb9b6bd](https://github.com/orhun/git-cliff/commit/eb9b6bdff712f63bac74b76e3dfbdc8ef1b3ccc8))\n- *(config)* Add `require_conventional` option ([#1061](https://github.com/orhun/git-cliff/issues/1061)) - ([bf50336](https://github.com/orhun/git-cliff/commit/bf50336f5997c28fc95c03eb14b9e70d5d3edddf))\n- *(context)* Add release commit range ([#1138](https://github.com/orhun/git-cliff/issues/1138)) - ([3dab0d1](https://github.com/orhun/git-cliff/commit/3dab0d1a5dec3a54c390c1ebdee7ef5131afd162))\n- *(git)* Support disabling sorting commits topologically ([#804](https://github.com/orhun/git-cliff/issues/804)) ([#1121](https://github.com/orhun/git-cliff/issues/1121)) - ([c3e25c3](https://github.com/orhun/git-cliff/commit/c3e25c31ee66b86b0e631e023bb4b687f606c599))\n- *(remote)* Fetch commits from non-default branches using remotes ([#1086](https://github.com/orhun/git-cliff/issues/1086)) - ([aec41be](https://github.com/orhun/git-cliff/commit/aec41befc701e786c01ec4ba5399c67df1981779))\n\n### 🐛 Bug Fixes\n\n- *(bump)* Check the next version against tag_pattern regex ([#1070](https://github.com/orhun/git-cliff/issues/1070)) - ([c4f0d28](https://github.com/orhun/git-cliff/commit/c4f0d28c39f34bc886c00c51cdeff851beda93de))\n- *(bump)* Accept lowercase values for bump_type config ([#1101](https://github.com/orhun/git-cliff/issues/1101)) - ([77632b2](https://github.com/orhun/git-cliff/commit/77632b276001a879ed4e3328a38a1cedfef67ca3))\n- *(deps)* Make glob dependency mandatory ([#1035](https://github.com/orhun/git-cliff/issues/1035)) - ([0f653bf](https://github.com/orhun/git-cliff/commit/0f653bf13a52543c5ef492c2d4e81ad085b19321))\n- *(fixtures)* Evaluate the rc of git-cliff correctly ([#1104](https://github.com/orhun/git-cliff/issues/1104)) - ([fa54a6a](https://github.com/orhun/git-cliff/commit/fa54a6adbcb8704ee828450f110516ccbb4067de))\n- *(fixtures)* Use the correct syntax while checking fixture results ([#1099](https://github.com/orhun/git-cliff/issues/1099)) - ([51af66e](https://github.com/orhun/git-cliff/commit/51af66e30668c3ec8e1336d7a26a7a5d35fcdb76))\n- *(git)* Handle worktrees while retrieving the path of repository ([#1054](https://github.com/orhun/git-cliff/issues/1054)) - ([fab02b0](https://github.com/orhun/git-cliff/commit/fab02b09833eb18be6ca540a436b254d13d7c678))\n- *(remote)* Fix detection of GitLab merge request sha if commits were squashed ([#1043](https://github.com/orhun/git-cliff/issues/1043)) - ([5f3a3d0](https://github.com/orhun/git-cliff/commit/5f3a3d0b4dbae5ec3239c79148258ba4fb47f376))\n- *(submodules)* Fix submodules handling when using custom range ([#1136](https://github.com/orhun/git-cliff/issues/1136)) - ([451a694](https://github.com/orhun/git-cliff/commit/451a694ad4d9db1f0545ef92bd0c6643b3d26600))\n- *(template)* Correctly serialize JSON for the commit fields ([#1145](https://github.com/orhun/git-cliff/issues/1145)) - ([e981e1d](https://github.com/orhun/git-cliff/commit/e981e1d1b27a65fc2d2fd51b025c27692a6c8910))\n\n### 🚜 Refactor\n\n- *(config)* Initialize config structs with default values ([#1090](https://github.com/orhun/git-cliff/issues/1090)) - ([9e4bd07](https://github.com/orhun/git-cliff/commit/9e4bd077b5a18922021afd8ffd671b7d7958ee5c))\n- *(lint)* Apply clippy suggestions - ([4d3b2d5](https://github.com/orhun/git-cliff/commit/4d3b2d5abefeb3bccf8b8d9faf16d4efd572f3c4))\n- *(lint)* Use IOError::other ([#1074](https://github.com/orhun/git-cliff/issues/1074)) - ([30e8193](https://github.com/orhun/git-cliff/commit/30e81930860105f081205ba5c90d1ea5e4b81d48))\n\n### 📚 Documentation\n\n- *(config)* Fix typo on commit.links ([#1132](https://github.com/orhun/git-cliff/issues/1132)) - ([cbeca6d](https://github.com/orhun/git-cliff/commit/cbeca6da93b25a0f2fce38de6e87571268d8d17e))\n- *(config)* Update comments for all configuration options ([#1057](https://github.com/orhun/git-cliff/issues/1057)) - ([63129ce](https://github.com/orhun/git-cliff/commit/63129ce0c481c00c06bc9ee6271da76e99a6e933))\n- *(quickstart)* Clarify git-cliff command ([#1051](https://github.com/orhun/git-cliff/issues/1051)) - ([cd26bb2](https://github.com/orhun/git-cliff/commit/cd26bb2de35ebd6ba293ee969c3796ac32a08e21))\n- *(readme)* Add blog posts from the community ([#1102](https://github.com/orhun/git-cliff/issues/1102)) - ([f302e43](https://github.com/orhun/git-cliff/commit/f302e433d52bed284e97bd75e92589773b52f44f))\n- *(release)* Fix Docker Hub URL - ([9babe06](https://github.com/orhun/git-cliff/commit/9babe0649c365f6c499ec6db62450625d8a21987))\n- *(security)* Extend security policy ([#1142](https://github.com/orhun/git-cliff/issues/1142)) - ([4c3c946](https://github.com/orhun/git-cliff/commit/4c3c94692d88ee3d9d2931cabeeec67946aba381))\n- *(website)* Add highlights for 2.9.0 ([#1153](https://github.com/orhun/git-cliff/issues/1153)) - ([d7f9cf5](https://github.com/orhun/git-cliff/commit/d7f9cf5a02980289efdbf1999011cb69034dd4c7))\n- *(website)* Remove references of tj-actions ([#1097](https://github.com/orhun/git-cliff/issues/1097)) - ([729aa47](https://github.com/orhun/git-cliff/commit/729aa47797bfc073850eb24745e692244f4a6381))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(dependabot)* Make dependency updates less noisy - ([cdce20f](https://github.com/orhun/git-cliff/commit/cdce20f39104b797c17a85aa5988c608f3437e11))\n- *(dependabot)* Check dependency updates weekly - ([b8be055](https://github.com/orhun/git-cliff/commit/b8be05542f0f8362522794c155bf0e0445bcee22))\n- *(docs)* Fix some typos ([#1149](https://github.com/orhun/git-cliff/issues/1149)) - ([7148b2d](https://github.com/orhun/git-cliff/commit/7148b2dbff518eb71c276f3c256db49970730863))\n- *(project)* Migrate to Rust 2024 edition ([#1128](https://github.com/orhun/git-cliff/issues/1128)) - ([4445f06](https://github.com/orhun/git-cliff/commit/4445f063518bd8514ac19381e3ee6c61828c72a9))\n\n## New Contributors ❤️\n\n* @vardbabayan made their first contribution in [#1149](https://github.com/orhun/git-cliff/pull/1149)\n* @ognis1205 made their first contribution in [#1145](https://github.com/orhun/git-cliff/pull/1145)\n* @janderssonse made their first contribution in [#1142](https://github.com/orhun/git-cliff/pull/1142)\n* @jdrst made their first contribution in [#1138](https://github.com/orhun/git-cliff/pull/1138)\n* @lehmanju made their first contribution in [#1136](https://github.com/orhun/git-cliff/pull/1136)\n* @Jean-Beru made their first contribution in [#1132](https://github.com/orhun/git-cliff/pull/1132)\n* @william-stacken made their first contribution in [#1086](https://github.com/orhun/git-cliff/pull/1086)\n* @SebClapie made their first contribution in [#1121](https://github.com/orhun/git-cliff/pull/1121)\n* @okydk made their first contribution in [#1051](https://github.com/orhun/git-cliff/pull/1051)\n\n## [2.8.0](https://github.com/orhun/git-cliff/compare/v2.7.0..v2.8.0) - 2025-01-24\n\n### ⛰️ Features\n\n- *(cli)* Support initializing config with a custom filename ([#992](https://github.com/orhun/git-cliff/issues/992)) - ([76bf9cf](https://github.com/orhun/git-cliff/commit/76bf9cf7aa26b58f2ae68edd007c9885b02af616))\n- *(config)* Discover the configuration file when run in a sub directory - ([a23eeb4](https://github.com/orhun/git-cliff/commit/a23eeb480961cd2b252acb7e1e6dc38807458e57))\n- *(git)* Improve the set commit range error ([#990](https://github.com/orhun/git-cliff/issues/990)) - ([f29e815](https://github.com/orhun/git-cliff/commit/f29e8150a8166d7364ed71b24675136d2e9bd382))\n- *(monorepo)* Automatically set include-path for current directory - ([ceda1f7](https://github.com/orhun/git-cliff/commit/ceda1f753adc3459b88417ae363410d2586a33af))\n- *(remote)* Support enabling native TLS ([#1021](https://github.com/orhun/git-cliff/issues/1021)) - ([fe7c464](https://github.com/orhun/git-cliff/commit/fe7c464c3bdbfd4e49f596615d6736ea441a4d16))\n- *(repo)* Allow running from sub directories ([#975](https://github.com/orhun/git-cliff/issues/975)) - ([98453b3](https://github.com/orhun/git-cliff/commit/98453b3eee754e1ffe08b685d84c039b17ac8e5e))\n\n### 🐛 Bug Fixes\n\n- *(config)* Allow environment overwrites when using builtin config ([#961](https://github.com/orhun/git-cliff/issues/961)) - ([7ba3b55](https://github.com/orhun/git-cliff/commit/7ba3b55448bdbf7a4a475df2081b6d7c2e2ceb34))\n- *(docker)* Use the correct Debian runner - ([36ad993](https://github.com/orhun/git-cliff/commit/36ad993d5956270c0df8c12d201068c1b4d7c580))\n- *(fixtures)* Update the arguments for custom GitLab API fixture test - ([e522f8d](https://github.com/orhun/git-cliff/commit/e522f8d9f1efddc43a15120e52a2f1b426468b56))\n- *(monorepo)* Do not set include-path if workdir is set ([#1022](https://github.com/orhun/git-cliff/issues/1022)) - ([20483be](https://github.com/orhun/git-cliff/commit/20483be93fbcd33eae3b7b54f625e53796281aff))\n- *(remote)* Fix detection of GitLab merge request sha ([#968](https://github.com/orhun/git-cliff/issues/968)) - ([1297655](https://github.com/orhun/git-cliff/commit/12976550d35bad8d535518010046bd136875736b))\n\n### 🚜 Refactor\n\n- *(lib)* Add changelog modifier callback to run function ([#922](https://github.com/orhun/git-cliff/issues/922)) - ([2321882](https://github.com/orhun/git-cliff/commit/2321882b12cc6aae03fbd4f7ea3e131fc8763631))\n- *(lint)* Use a shared lint config for the workspace - ([bfc1d4f](https://github.com/orhun/git-cliff/commit/bfc1d4fb8f8bd8faa350ec217f4d09d57c20b12d))\n- *(lint)* Apply clippy suggestions - ([299a1c7](https://github.com/orhun/git-cliff/commit/299a1c74b28ac41015bc436de6d37b5ef5d59b04))\n\n### 📚 Documentation\n\n- *(docker)* Fix typo in comment ([#959](https://github.com/orhun/git-cliff/issues/959)) - ([dbda091](https://github.com/orhun/git-cliff/commit/dbda091aa15806523c2be371ec8a31fbba4ccdc7))\n- *(highlights)* Add link to the Nix flake - ([c449229](https://github.com/orhun/git-cliff/commit/c449229513da7444ea02fe275f410e4b2048c9ff))\n- *(jujutsu)* Update links to the upstream documentation - ([ed6b646](https://github.com/orhun/git-cliff/commit/ed6b64628f4bfd21b32021b3decf842ae14c9f51))\n- *(lib)* Allow doc lint - ([62a6d3e](https://github.com/orhun/git-cliff/commit/62a6d3e20cf72c8e2dcc7938894c5c65278e6c4e))\n- *(license)* Update copyright years - ([8178c9b](https://github.com/orhun/git-cliff/commit/8178c9b2ca41fb0b974d3387e07b3067256bdb0b))\n- *(tips)* Extend the merge commit filter example ([#963](https://github.com/orhun/git-cliff/issues/963)) - ([09c0f90](https://github.com/orhun/git-cliff/commit/09c0f905d8b20b585b0bc8183f14250d1a381ca0))\n- *(website)* Add highlights for 2.8.0 ([#1023](https://github.com/orhun/git-cliff/issues/1023)) - ([32dc15e](https://github.com/orhun/git-cliff/commit/32dc15efe5ea8be8f1691fbc16d9e5aaa1c5ebdc))\n\n### 🧪 Testing\n\n- *(fixture)* Add fixture for include-path - ([e85888f](https://github.com/orhun/git-cliff/commit/e85888f5d8dbd4db0674613c4c354416a9be84d1))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(build)* Bump MSRV to 1.83.0 - ([37598c2](https://github.com/orhun/git-cliff/commit/37598c2d417a1646ec90590ab2a1f6d9da66296c))\n- *(docker)* Bump the Rust version in Docker image - ([729f433](https://github.com/orhun/git-cliff/commit/729f4336d169e9fc5cdefdb201208638eee17995))\n- *(funding)* Add wellKnown directory - ([8704518](https://github.com/orhun/git-cliff/commit/8704518fb71b88fa8985c660e67f77d9a33431c8))\n- *(lint)* Allow false positive lint - ([1b779a6](https://github.com/orhun/git-cliff/commit/1b779a698f845cb449da0640aeac45d53c6c43b9))\n- *(nix)* Update flakes - ([22fbe9d](https://github.com/orhun/git-cliff/commit/22fbe9dafbbeaa4bd68082787ea8231dbe12c9ae))\n\n## New Contributors ❤️\n\n* @xsadia made their first contribution in [#992](https://github.com/orhun/git-cliff/pull/992)\n* @chenrui333 made their first contribution in [#1002](https://github.com/orhun/git-cliff/pull/1002)\n* @hackenbergstefan made their first contribution in [#968](https://github.com/orhun/git-cliff/pull/968)\n* @paul-uz made their first contribution in [#963](https://github.com/orhun/git-cliff/pull/963)\n* @jmartens made their first contribution in [#959](https://github.com/orhun/git-cliff/pull/959)\n\n## [2.7.0](https://github.com/orhun/git-cliff/compare/v2.6.1..v2.7.0) - 2024-11-20\n\n### ⛰️ Features\n\n- *(args)* Add color to the help text ([#897](https://github.com/orhun/git-cliff/issues/897)) - ([f423484](https://github.com/orhun/git-cliff/commit/f4234844bf66da3de8d5d6e1d6fd7a414d2e059a))\n- *(ci)* Add Nix CI ([#939](https://github.com/orhun/git-cliff/issues/939)) - ([d0848ff](https://github.com/orhun/git-cliff/commit/d0848ff04099a287157fbd22935f870e0636139d))\n- *(config)* Allow overriding the remote API URL via config ([#896](https://github.com/orhun/git-cliff/issues/896)) - ([6d86e2c](https://github.com/orhun/git-cliff/commit/6d86e2c9426f7f68207c2ea389629e67eca54277))\n- *(docker)* Build arm64 images again ([#879](https://github.com/orhun/git-cliff/issues/879)) ([#919](https://github.com/orhun/git-cliff/issues/919)) - ([84771f6](https://github.com/orhun/git-cliff/commit/84771f63d04bafec8023a7e9fd4694da6e4d9a25))\n- *(jujutsu)* Add jujustu support ([#930](https://github.com/orhun/git-cliff/issues/930)) - ([ab95626](https://github.com/orhun/git-cliff/commit/ab956263945798ec07214a5234ba6fafa8171ff7))\n- *(nix)* Add a basic Nix environment ([#918](https://github.com/orhun/git-cliff/issues/918)) - ([6b17736](https://github.com/orhun/git-cliff/commit/6b1773685f09a5e091b10f709b3a4f63b63c47b9))\n- *(website)* Add user testimonials ([#895](https://github.com/orhun/git-cliff/issues/895)) - ([ef2374c](https://github.com/orhun/git-cliff/commit/ef2374cab17e896b38b12bfe7d6b011f45e9f840))\n\n### 🐛 Bug Fixes\n\n- *(bitbucket)* Match PR and release metadata correctly ([#907](https://github.com/orhun/git-cliff/issues/907)) - ([e936ed5](https://github.com/orhun/git-cliff/commit/e936ed571533ea6c41a1dd2b1a29d085c8dbada5))\n- *(changelog)* Fix missing commit fields in context ([#837](https://github.com/orhun/git-cliff/issues/837)) ([#920](https://github.com/orhun/git-cliff/issues/920)) - ([f8641ee](https://github.com/orhun/git-cliff/commit/f8641ee8f75da74637ab1f0d3d7c11bfcda8acf9))\n- *(changelog)* Include the root commit when `--latest` is used with one tag ([#901](https://github.com/orhun/git-cliff/issues/901)) - ([508a97e](https://github.com/orhun/git-cliff/commit/508a97edb088f77d01f232676d1e3c7f129071b2))\n- *(remote)* Preserve first time contributors ([#925](https://github.com/orhun/git-cliff/issues/925)) - ([99b78b5](https://github.com/orhun/git-cliff/commit/99b78b52f2d81484fa4e5ea7a66de6e9bea2b3df))\n\n### 📚 Documentation\n\n- *(git)* Improve docs for commit_preprocessors and commit_parsers ([#928](https://github.com/orhun/git-cliff/issues/928)) - ([c1f1215](https://github.com/orhun/git-cliff/commit/c1f12154e7efa75f19ce632dc3052dae390c9211))\n- *(readme)* Add blog post about git-cliff - ([82b10ac](https://github.com/orhun/git-cliff/commit/82b10ac22c657113f8f7f215bdc1bee68ebe1e55))\n- *(website)* Add highlights for 2.7.0 ([#955](https://github.com/orhun/git-cliff/issues/955)) - ([b6b5449](https://github.com/orhun/git-cliff/commit/b6b544949d7763056fb87686f533ed814395f253))\n- *(website)* Add more testimonials - ([bfe9beb](https://github.com/orhun/git-cliff/commit/bfe9beb093df42badf762945cf04548fbe75949a))\n- *(website)* Update sourcehut ([#894](https://github.com/orhun/git-cliff/issues/894)) - ([bcc32ca](https://github.com/orhun/git-cliff/commit/bcc32ca5d1cc157902e04018655c5445237d1407))\n\n### ⚡ Performance\n\n- *(test)* Don't create regex inside a loop ([#937](https://github.com/orhun/git-cliff/issues/937)) - ([0fabf22](https://github.com/orhun/git-cliff/commit/0fabf22c526e1d4b8cb7c718dd0a5d0af99950f8))\n\n### 🧪 Testing\n\n- *(git)* Find upstream remote when using ssh ([#926](https://github.com/orhun/git-cliff/issues/926)) - ([2e65a72](https://github.com/orhun/git-cliff/commit/2e65a72bb044bad94f2568c491e4907f92331a56))\n- *(repo)* Expand unit tests of the repo module ([#909](https://github.com/orhun/git-cliff/issues/909)) - ([da1cb61](https://github.com/orhun/git-cliff/commit/da1cb61c9147631c9a2ba6598e3105132b41c2c3))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(config)* Add the 'other' parser to the default config - ([12cb1df](https://github.com/orhun/git-cliff/commit/12cb1df561cde39a9a0d0f719156a000f3f4d61b))\n- *(docker)* Upgrade Rust and libc version in Dockerfile - ([8bd0607](https://github.com/orhun/git-cliff/commit/8bd0607e231e219f9b60eb4c7f0d8353ef4462e0))\n- *(docker)* Bump the Rust version in Docker image - ([c28121c](https://github.com/orhun/git-cliff/commit/c28121c1aa427c3169df218a9803d838172f7c24))\n- *(integration)* Remove experimental feature disclaimer - ([237c327](https://github.com/orhun/git-cliff/commit/237c327839aa12672abe4255a62ce3c85737bd2c))\n- *(log)* Add trace log about which command is being run - ([a9b2690](https://github.com/orhun/git-cliff/commit/a9b26901e38aa3d3b1042d3bc10d2fe7c6c06565))\n- *(nix)* Update flakes - ([7654e67](https://github.com/orhun/git-cliff/commit/7654e67d971b795e238220dfabe894b2a1b23992))\n- *(website)* Add new testimonials - ([0c207d6](https://github.com/orhun/git-cliff/commit/0c207d606e5a65b4dca3287f2aa2b3c6d624f83d))\n\n### ◀️ Revert\n\n- *(docker)* Bump the Rust version in Docker image - ([fc142e4](https://github.com/orhun/git-cliff/commit/fc142e4b9d4b5b54bc8a0fca6e336345951c9c7b))\n\n## New Contributors ❤️\n\n* @pauliyobo made their first contribution in [#896](https://github.com/orhun/git-cliff/pull/896)\n* @blackheaven made their first contribution in [#939](https://github.com/orhun/git-cliff/pull/939)\n* @Muhammad-Owais-Warsi made their first contribution in [#928](https://github.com/orhun/git-cliff/pull/928)\n* @kemitix made their first contribution in [#930](https://github.com/orhun/git-cliff/pull/930)\n* @mcwarman made their first contribution in [#925](https://github.com/orhun/git-cliff/pull/925)\n* @LtdSauce made their first contribution in [#919](https://github.com/orhun/git-cliff/pull/919)\n* @dqkqd made their first contribution in [#920](https://github.com/orhun/git-cliff/pull/920)\n* @gsquire made their first contribution in [#909](https://github.com/orhun/git-cliff/pull/909)\n* @rarescosma made their first contribution in [#901](https://github.com/orhun/git-cliff/pull/901)\n* @vsn4ik made their first contribution in [#894](https://github.com/orhun/git-cliff/pull/894)\n\n## [2.6.1](https://github.com/orhun/git-cliff/compare/v2.6.0..v2.6.1) - 2024-09-27\n\n### 🐛 Bug Fixes\n\n- *(npm)* Add missing `--use-branch-tags` flag to TS options ([#874](https://github.com/orhun/git-cliff/issues/874)) - ([e21fb1d](https://github.com/orhun/git-cliff/commit/e21fb1d3895d893fd6a371ecd48aa4632cf4231d))\n- *(remote)* Avoid setting multiple remotes ([#885](https://github.com/orhun/git-cliff/issues/885)) - ([a344c68](https://github.com/orhun/git-cliff/commit/a344c68238cf3bb87d4f7eb9be46e97cc964eed9))\n\n### 📚 Documentation\n\n- *(website)* Add conversion to pdf to tips-and-tricks ([#889](https://github.com/orhun/git-cliff/issues/889)) - ([58dc108](https://github.com/orhun/git-cliff/commit/58dc1087ed86794c2f678707f2fbb8199167b0c3))\n- *(website)* Add get_env filter example for GitLab CI - ([dfe4459](https://github.com/orhun/git-cliff/commit/dfe4459c5cadd465dec4ea860580ecf82b2b8860))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(ci)* Update pedantic lint command ([#890](https://github.com/orhun/git-cliff/issues/890)) - ([8d10edb](https://github.com/orhun/git-cliff/commit/8d10edb7450aaf189fbce5f78a72274739f73ba9))\n- *(docker)* Disable building arm64 docker images temporarily ([#879](https://github.com/orhun/git-cliff/issues/879)) - ([cde2a8e](https://github.com/orhun/git-cliff/commit/cde2a8e3222f5e8f8bdd9ae841fd0e5c42f68846))\n- *(fixtures)* Build binaries using dev profile ([#886](https://github.com/orhun/git-cliff/issues/886)) - ([a394f88](https://github.com/orhun/git-cliff/commit/a394f88f1d1742dfa3d30887bcb387361de306bc))\n\n## New Contributors ❤️\n\n* @ckrenslehner made their first contribution in [#889](https://github.com/orhun/git-cliff/pull/889)\n\n## [2.6.0](https://github.com/orhun/git-cliff/compare/v2.5.0..v2.6.0) - 2024-09-22\n\n### ⛰️ Features\n\n- *(changelog)* Support generating changelog for different branches ([#808](https://github.com/orhun/git-cliff/issues/808)) - ([2a581a8](https://github.com/orhun/git-cliff/commit/2a581a82bbdee057eff8051b261edc9a8c7f4491))\n- *(config)* Add changelog.render_always option ([#859](https://github.com/orhun/git-cliff/issues/859)) - ([ad039d5](https://github.com/orhun/git-cliff/commit/ad039d56b66563cc0299035650582a0518e94679))\n- *(config)* Allow configuring output file from config ([#829](https://github.com/orhun/git-cliff/issues/829)) - ([c2db791](https://github.com/orhun/git-cliff/commit/c2db791a6e2891b5eb46f40d43a490fc6923d038))\n- *(core)* Add `remote` to commit and deprecate fields ([#822](https://github.com/orhun/git-cliff/issues/822)) - ([87e2c1d](https://github.com/orhun/git-cliff/commit/87e2c1d0dd251c81796f607699d2c85ee12584ac))\n- *(npm)* Add missing options and document all options with tsdoc comments - ([2eae2f1](https://github.com/orhun/git-cliff/commit/2eae2f1f1f258b6c270e544d12fae1b150fb2610))\n- *(npm)* Add possibility for `skipCommit` to take an array of values - ([a6e3b78](https://github.com/orhun/git-cliff/commit/a6e3b78948a730aae18f156b2fb787b7ff26bb64))\n\n### 🐛 Bug Fixes\n\n- *(args)* Support using use_branch_tags from both config and args ([#848](https://github.com/orhun/git-cliff/issues/848)) - ([35b7fd8](https://github.com/orhun/git-cliff/commit/35b7fd8007e781b65ef6c3112a349bfd8c8fda15))\n- *(bump)* Suppress template warning when `--bumped-version` is used ([#855](https://github.com/orhun/git-cliff/issues/855)) - ([8bebbf9](https://github.com/orhun/git-cliff/commit/8bebbf9f575e6e3f1bc50332e5703fde9dd1b55f))\n- *(changelog)* Do not change the tag date if tag already exists ([#861](https://github.com/orhun/git-cliff/issues/861)) - ([fbb643b](https://github.com/orhun/git-cliff/commit/fbb643b2e1096ac74a6ea9e9881ed4fd8161d3be))\n- *(changelog)* Correctly set the tag message for the latest release ([#854](https://github.com/orhun/git-cliff/issues/854)) - ([e41e8dd](https://github.com/orhun/git-cliff/commit/e41e8dd4a2e5ed12149078492cf6fd6eedebd0fa))\n- *(changelog)* Don't change the context when provided via `--from-context` ([#820](https://github.com/orhun/git-cliff/issues/820)) - ([ff72406](https://github.com/orhun/git-cliff/commit/ff7240633fcb46e6190dfed22150cbf8d3012df5))\n- *(commit)* Trim the trailing newline for git2 commits ([#872](https://github.com/orhun/git-cliff/issues/872)) - ([1cdbbf6](https://github.com/orhun/git-cliff/commit/1cdbbf604c27c8a597f72985b1d15359244e5186))\n- *(core)* Avoid the unnecessary loop when no remote feature is activated - ([1d8a2fe](https://github.com/orhun/git-cliff/commit/1d8a2fe84917d7bc7c0cb26afc559198ad806184))\n- *(template)* Resolve parsing issues with `raw`/`endraw` in Jinja ([#824](https://github.com/orhun/git-cliff/issues/824)) - ([63bf5b7](https://github.com/orhun/git-cliff/commit/63bf5b7438e2660d410ca825c63b1982fd4d43f5))\n\n### 🚜 Refactor\n\n- *(template)* [**breaking**] Add name parameter to the constructor - ([e577113](https://github.com/orhun/git-cliff/commit/e577113bd69147936e391976c8b06cba76764eec))\n\n### 📚 Documentation\n\n- *(args)* Fix copy-paste mistake where gitea mentioned gitlab - ([c41eacb](https://github.com/orhun/git-cliff/commit/c41eacb0b8181a26d95744e26965272cc105f629))\n- *(contributing)* Mention fetching the tags for running tests successfully ([#850](https://github.com/orhun/git-cliff/issues/850)) - ([a82dac3](https://github.com/orhun/git-cliff/commit/a82dac3cb15490f5b4e543d2f404e54a5126395c))\n- *(website)* Add highlights for 2.6.0 ([#873](https://github.com/orhun/git-cliff/issues/873)) - ([050fb55](https://github.com/orhun/git-cliff/commit/050fb55e86fd2f33fccd5760ddd4913602d5a552))\n- *(website)* Clarify comment about tag argument - ([e56cd8d](https://github.com/orhun/git-cliff/commit/e56cd8de17f08461dcff4ff88518872577fb73fb))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(ci)* Check pedantic lints ([#853](https://github.com/orhun/git-cliff/issues/853)) - ([c77420c](https://github.com/orhun/git-cliff/commit/c77420cf5a35e2658125030b6d9aee97a1e1bd57))\n- *(examples)* Improve example templates ([#835](https://github.com/orhun/git-cliff/issues/835)) - ([08e761c](https://github.com/orhun/git-cliff/commit/08e761c20fb98730249aef2047da02a7dfca86ad))\n- *(lib)* Fix typos in code comments - ([81854d2](https://github.com/orhun/git-cliff/commit/81854d2166fc265168effde50fa892265b83efdf))\n- *(npm)* Bump dev dependencies - ([61b86f1](https://github.com/orhun/git-cliff/commit/61b86f162bee28fffb3b3b06f19261d568fbf60b))\n\n## New Contributors ❤️\n\n* @nejcgalof made their first contribution in [#853](https://github.com/orhun/git-cliff/pull/853)\n* @pplmx made their first contribution in [#824](https://github.com/orhun/git-cliff/pull/824)\n\n## [2.5.0](https://github.com/orhun/git-cliff/compare/v2.4.0..v2.5.0) - 2024-08-24\n\n### ⛰️ Features\n\n- *(args)* Allow GitLab groups with `--gitlab-repo` ([#807](https://github.com/orhun/git-cliff/issues/807)) - ([6fbfdb5](https://github.com/orhun/git-cliff/commit/6fbfdb5963ad7d39a389001b660df5bf7f38dd37))\n- *(bump)* Support bumping to a specific semver type ([#744](https://github.com/orhun/git-cliff/issues/744)) - ([9dbf47b](https://github.com/orhun/git-cliff/commit/9dbf47bac596be7bacc335e8afa3cdc383dc8ebb))\n- *(changelog)* Support count_tags option ([#599](https://github.com/orhun/git-cliff/issues/599)) - ([b8045e9](https://github.com/orhun/git-cliff/commit/b8045e97ed2b50eee68cb29d5fd28e350c6ca745))\n- *(changelog)* Skip ssh and x509 signatures in tag messages ([#748](https://github.com/orhun/git-cliff/issues/748)) - ([ecbabbf](https://github.com/orhun/git-cliff/commit/ecbabbfb39b986e8445d2feb3189bab4307fd854))\n- *(cli)* Generate changelog from JSON context ([#784](https://github.com/orhun/git-cliff/issues/784)) - ([3b6156d](https://github.com/orhun/git-cliff/commit/3b6156ddd66a256a89e12da98b5cbc611a394c72))\n- *(parser)* Allow whole commit context to be used in commit parsers ([#758](https://github.com/orhun/git-cliff/issues/758)) - ([ccf2ab7](https://github.com/orhun/git-cliff/commit/ccf2ab769aef9fc6d9bbaebc02c41fe4105da24c))\n- *(profiler)* Support performance profiling via pprof ([#768](https://github.com/orhun/git-cliff/issues/768)) - ([35dc1e4](https://github.com/orhun/git-cliff/commit/35dc1e46fd57c32dc475ac545a86013a5c3258c8))\n- *(remote)* Activate integration if remote is set manually ([#782](https://github.com/orhun/git-cliff/issues/782)) - ([4b33e7e](https://github.com/orhun/git-cliff/commit/4b33e7e9869bde035d70ae9525c917340ff90bc3))\n\n### 🐛 Bug Fixes\n\n- *(changelog)* Allow using `--bumped-version` without conventional commits ([#806](https://github.com/orhun/git-cliff/issues/806)) - ([e74080c](https://github.com/orhun/git-cliff/commit/e74080cec4283a45f0f81b1b656af466ae4bd693))\n- *(config)* Allow using environment variables without config file present ([#783](https://github.com/orhun/git-cliff/issues/783)) - ([2471745](https://github.com/orhun/git-cliff/commit/2471745e110955be49310afe11e24719ab79b658))\n- *(fixture)* Fix fetching repository for gitlab integration test - ([72847c6](https://github.com/orhun/git-cliff/commit/72847c6c7e71bf8f5b452f4943f0ddfc99cf6cb5))\n- *(gitlab)* URL-encode the owner in remote requests for GitLab ([#742](https://github.com/orhun/git-cliff/issues/742)) - ([e3e7c07](https://github.com/orhun/git-cliff/commit/e3e7c0794082e418a78f99e7d9c09161f4d14d5f))\n- *(template)* Include for-loop arguments in template variables ([#812](https://github.com/orhun/git-cliff/issues/812)) - ([9a6430b](https://github.com/orhun/git-cliff/commit/9a6430bc5142d356d16df2ce96869f7a0af05493))\n\n### 🚜 Refactor\n\n- *(config)* Make example templates more user-friendly - ([6f8ea19](https://github.com/orhun/git-cliff/commit/6f8ea19baafea2718a00a046b74f0cbbfacc8d46))\n- *(gitlab)* Clean up url encoding for GitLab - ([c791418](https://github.com/orhun/git-cliff/commit/c791418c7e86def636ed2e0aac8d7cc30ef88791))\n- *(lib)* Clean up some code ([#709](https://github.com/orhun/git-cliff/issues/709)) - ([4b0c0eb](https://github.com/orhun/git-cliff/commit/4b0c0eb09abf1264b5cc92bf40f75c8e05e17da6))\n\n### 📚 Documentation\n\n- *(config)* Fix typo in comment of default config file ([#776](https://github.com/orhun/git-cliff/issues/776)) - ([e2fb043](https://github.com/orhun/git-cliff/commit/e2fb0430786c1f746a7eb2a1b299f8491df2c584))\n- *(readme)* Remove underscored spaces between badges ([#809](https://github.com/orhun/git-cliff/issues/809)) - ([1956c83](https://github.com/orhun/git-cliff/commit/1956c8321e4ef2c5ceb46631e5370fbb66a999b2))\n- *(readme)* Add git-changelog to similar projects section ([#774](https://github.com/orhun/git-cliff/issues/774)) - ([c208a97](https://github.com/orhun/git-cliff/commit/c208a9791e3899668d48947f59757613f4e5fba1))\n- *(readme)* Add KaiCode Open Source Festival link - ([58b729c](https://github.com/orhun/git-cliff/commit/58b729c71f7255589fa6645163d355309a04dd7a))\n- *(website)* Add highlights for 2.5.0 ([#815](https://github.com/orhun/git-cliff/issues/815)) - ([49df8cb](https://github.com/orhun/git-cliff/commit/49df8cb0d6880e5a1ef806d17b066070c7492f3a))\n- *(website)* Clarify authentication with GitHub token ([#787](https://github.com/orhun/git-cliff/issues/787)) - ([85bfa95](https://github.com/orhun/git-cliff/commit/85bfa952e48108dbdcfa49105d072b3170d08a0f))\n- *(website)* Correct inverted consequences of configuration value ([#760](https://github.com/orhun/git-cliff/issues/760)) - ([dc144dd](https://github.com/orhun/git-cliff/commit/dc144dd9d0451ec5240efa36d83c187720a17323))\n- *(website)* Add header to 2.4.0 blog post - ([227a307](https://github.com/orhun/git-cliff/commit/227a307d8563e942f4d1e97b53e21953148395f6))\n\n### ⚡ Performance\n\n- *(changelog)* Cache commit retain checks (258 times faster generation) ([#772](https://github.com/orhun/git-cliff/issues/772)) - ([8430c5c](https://github.com/orhun/git-cliff/commit/8430c5c539a8de34f465e33fe43aed560cd581ca))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cd)* Remove unnecessary git-cliff-action output file ([#738](https://github.com/orhun/git-cliff/issues/738)) - ([9f39bcb](https://github.com/orhun/git-cliff/commit/9f39bcb8bf87ede149c11be0eb913583ded191c5))\n- *(config)* Include new contributors in repository changelog - ([5474978](https://github.com/orhun/git-cliff/commit/5474978f8aa72112595e342864138b9b14fb6366))\n- *(config)* Check for null commit_id in detailed template ([#786](https://github.com/orhun/git-cliff/issues/786)) - ([388b007](https://github.com/orhun/git-cliff/commit/388b007b0f7a6beb66e045a6007f17c1642953e1))\n- *(config)* Fix comment for changelog header template - ([35b886e](https://github.com/orhun/git-cliff/commit/35b886e50dd13e85436b36d9b1280a88eafdccf8))\n- *(config)* Update keepachangelog.toml comment ([#779](https://github.com/orhun/git-cliff/issues/779)) - ([f9e500e](https://github.com/orhun/git-cliff/commit/f9e500e27c543807e28132aa6c34244cd3c4238b))\n- *(website)* Remove v2 announcement - ([a71649b](https://github.com/orhun/git-cliff/commit/a71649b6cd5a72c2a6b20c08dc1b8dfa37c19a6b))\n- *(website)* Add discord button to navbar - ([565b9c8](https://github.com/orhun/git-cliff/commit/565b9c8df0e1a3eb3b5a4415cadfcae065743a40))\n\n## New Contributors ❤️\n\n* @weichweich made their first contribution in [#807](https://github.com/orhun/git-cliff/pull/807)\n* @janbuchar made their first contribution in [#784](https://github.com/orhun/git-cliff/pull/784)\n* @rich-ayr made their first contribution in [#809](https://github.com/orhun/git-cliff/pull/809)\n* @tisonkun made their first contribution in [#599](https://github.com/orhun/git-cliff/pull/599)\n* @DerTiedemann made their first contribution in [#758](https://github.com/orhun/git-cliff/pull/758)\n* @DaniPopes made their first contribution in [#709](https://github.com/orhun/git-cliff/pull/709)\n* @artrz made their first contribution in [#779](https://github.com/orhun/git-cliff/pull/779)\n* @braineo made their first contribution in [#744](https://github.com/orhun/git-cliff/pull/744)\n* @myl7 made their first contribution in [#776](https://github.com/orhun/git-cliff/pull/776)\n* @pawamoy made their first contribution in [#774](https://github.com/orhun/git-cliff/pull/774)\n* @tonybutt made their first contribution in [#742](https://github.com/orhun/git-cliff/pull/742)\n* @PigeonF made their first contribution in [#748](https://github.com/orhun/git-cliff/pull/748)\n\n## [2.4.0](https://github.com/orhun/git-cliff/compare/v2.3.0..v2.4.0) - 2024-06-26\n\n### ⛰️ Features\n\n- *(args)* Add `--ignore-tags` argument ([#696](https://github.com/orhun/git-cliff/issues/696)) - ([94891c2](https://github.com/orhun/git-cliff/commit/94891c2c27b1f46cb840fbea1e167c161609cbcd))\n- *(bump)* Support bumping based on configurable custom pattern ([#725](https://github.com/orhun/git-cliff/issues/725)) - ([8e03356](https://github.com/orhun/git-cliff/commit/8e03356706c8aa89eac80953bc2a01ed3f93bb52))\n- *(bump)* Support setting the `initial_tag` ([#701](https://github.com/orhun/git-cliff/issues/701)) - ([7341500](https://github.com/orhun/git-cliff/commit/734150020e1e2763eaac7aa10acf80f82169b60e))\n- *(changelog)* Add tag message to release context ([#713](https://github.com/orhun/git-cliff/issues/713)) - ([3eb828e](https://github.com/orhun/git-cliff/commit/3eb828e69ad3a5b94833f67dfe287e7d8b31a274))\n- *(changelog)* Make `changelog.header` a template ([#698](https://github.com/orhun/git-cliff/issues/698)) - ([9fc12bb](https://github.com/orhun/git-cliff/commit/9fc12bb90cac732d8621446e4d4de775e7f0ba9a))\n- *(changelog)* Support parsing commits by footer ([#569](https://github.com/orhun/git-cliff/issues/569)) - ([50c240c](https://github.com/orhun/git-cliff/commit/50c240c25b632c670b23e0bac943ff94eeb3dfb7))\n- *(changelog)* Make remote data available in context ([#703](https://github.com/orhun/git-cliff/issues/703)) - ([d14774a](https://github.com/orhun/git-cliff/commit/d14774ae4afb086819d9669dfc050fac1c237de8))\n- *(codeberg)* Add Gitea support ([#680](https://github.com/orhun/git-cliff/issues/680)) - ([403d3dc](https://github.com/orhun/git-cliff/commit/403d3dcd32246fba5c1e1c50bc1f95410e3ee5e4))\n- *(context)* Add repository path to template context ([#721](https://github.com/orhun/git-cliff/issues/721)) - ([e7807e1](https://github.com/orhun/git-cliff/commit/e7807e13c4b38aaa4a735ff05b69fdd6b57a7a85))\n\n### 🐛 Bug Fixes\n\n- *(fixture)* Support running fixtures on mingw64 ([#708](https://github.com/orhun/git-cliff/issues/708)) - ([dabe716](https://github.com/orhun/git-cliff/commit/dabe716c201fedf3021d89c5a8564794bda07f2a))\n- *(website)* Update dependencies to fix search issue - ([8a9f9f4](https://github.com/orhun/git-cliff/commit/8a9f9f48da42ec95f47a169370c6c5cdf2a0b327))\n\n### 🚜 Refactor\n\n- *(bump)* Add documentation and simplify implementation - ([bea4916](https://github.com/orhun/git-cliff/commit/bea49161e9bd9bc999889aca22ed4c0f18f53ca1))\n\n### 📚 Documentation\n\n- *(website)* Add highlights for 2.4.0 ([#729](https://github.com/orhun/git-cliff/issues/729)) - ([5558cc5](https://github.com/orhun/git-cliff/commit/5558cc51b17cbc9c09bf9a2938ed227f1d1bda11))\n- *(website)* Add more context about `ignore_tags` matching commits ([#710](https://github.com/orhun/git-cliff/issues/710)) - ([854b411](https://github.com/orhun/git-cliff/commit/854b411e474b21c870afb0636512b471bf737c4c))\n- *(website)* Fix link to github-keepachangelog template ([#694](https://github.com/orhun/git-cliff/issues/694)) - ([eac2195](https://github.com/orhun/git-cliff/commit/eac2195963e1688cd865969a01cc944d6a4af7b4))\n- *(website)* Add information about `--bump` with `tag prefixes` ([#695](https://github.com/orhun/git-cliff/issues/695)) - ([4cd18c2](https://github.com/orhun/git-cliff/commit/4cd18c2bcdb2ce21234776364598d42261df004d))\n\n### 🎨 Styling\n\n- *(lint)* Fix formatting - ([5b58a37](https://github.com/orhun/git-cliff/commit/5b58a3771d056a95b9ec93ff4a7d0d5bf49b8473))\n- *(lint)* Fix formatting ([#702](https://github.com/orhun/git-cliff/issues/702)) - ([b7e323f](https://github.com/orhun/git-cliff/commit/b7e323f8ec948f7ab9d2f821e0da77e4d936475d))\n\n### 🧪 Testing\n\n- *(template)* Add tests ([#674](https://github.com/orhun/git-cliff/issues/674)) - ([a51422d](https://github.com/orhun/git-cliff/commit/a51422dda9431a3f24b4b061ab055ac97fa018de))\n\n## New Contributors ❤️\n\n* @bukowa made their first contribution in [#710](https://github.com/orhun/git-cliff/pull/710)\n* @MeitarR made their first contribution in [#713](https://github.com/orhun/git-cliff/pull/713)\n* @Cyclonit made their first contribution in [#698](https://github.com/orhun/git-cliff/pull/698)\n* @jan-ferdinand made their first contribution in [#569](https://github.com/orhun/git-cliff/pull/569)\n* @Theta-Dev made their first contribution in [#680](https://github.com/orhun/git-cliff/pull/680)\n* @tcarmet made their first contribution in [#694](https://github.com/orhun/git-cliff/pull/694)\n\n## [2.3.0](https://github.com/orhun/git-cliff/compare/v2.2.2..v2.3.0) - 2024-06-03\n\n### ⛰️ Features\n\n- *(bitbucket)* Add Bitbucket support ([#663](https://github.com/orhun/git-cliff/issues/663)) - ([8ffc054](https://github.com/orhun/git-cliff/commit/8ffc0548fe0fd8930627412fecb9bc08a7879504))\n- *(gitlab)* [**breaking**] Add GitLab support ([#654](https://github.com/orhun/git-cliff/issues/654)) - ([b490f2a](https://github.com/orhun/git-cliff/commit/b490f2a24e3ebeb6ee54382ce9aa642ecff17b01))\n- *(output)* Support using stdout via dash (`-o -`) ([#644](https://github.com/orhun/git-cliff/issues/644)) - ([df81f63](https://github.com/orhun/git-cliff/commit/df81f636f53e63d305d06944ff014a21612cb666))\n\n### 🐛 Bug Fixes\n\n- *(args)* Allow -o and -p together if they point to different files ([#653](https://github.com/orhun/git-cliff/issues/653)) - ([076f859](https://github.com/orhun/git-cliff/commit/076f85915386c4769c838ca9a359d216249d2a97))\n\n### 📚 Documentation\n\n- *(nix)* Add installation instructions for Nix ([#669](https://github.com/orhun/git-cliff/issues/669)) - ([63c8ad4](https://github.com/orhun/git-cliff/commit/63c8ad43e9ecaa825ef1f0a67164265497f3a1dd))\n- *(website)* Add highlights for 2.3.0 ([#670](https://github.com/orhun/git-cliff/issues/670)) - ([1338703](https://github.com/orhun/git-cliff/commit/1338703a2aedb4116dcae849ada4941432f57e74))\n- *(website)* Clean up Nix docs - ([2c2a300](https://github.com/orhun/git-cliff/commit/2c2a300616fa151b91858a2a7d88bdc9b9dae497))\n- *(website)* Add more git range examples ([#655](https://github.com/orhun/git-cliff/issues/655)) - ([d451252](https://github.com/orhun/git-cliff/commit/d4512521fbcfb971c94aa7794d78bced1ddec7a1))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cd)* Use macos-14 runner - ([22c94ed](https://github.com/orhun/git-cliff/commit/22c94ed8355d71a5fe99d8c1e9c8a3824338debf))\n- *(example)* Allow using github template without github variables ([#672](https://github.com/orhun/git-cliff/issues/672)) - ([6a9feba](https://github.com/orhun/git-cliff/commit/6a9feba98f36de1980bab313f6b0a861f5009d71))\n- *(links)* Ignore patreon links - ([bfe2774](https://github.com/orhun/git-cliff/commit/bfe27744701296185d2f1d37dba7cfb48bd70519))\n\n## New Contributors ❤️\n\n* @R11baka made their first contribution in [#672](https://github.com/orhun/git-cliff/pull/672)\n* @0x61nas made their first contribution in [#669](https://github.com/orhun/git-cliff/pull/669)\n* @dark0dave made their first contribution in [#663](https://github.com/orhun/git-cliff/pull/663)\n* @antonengelhardt made their first contribution in [#653](https://github.com/orhun/git-cliff/pull/653)\n\n## [2.2.2](https://github.com/orhun/git-cliff/compare/v2.2.1..v2.2.2) - 2024-05-11\n\n### ⛰️ Features\n\n- *(changelog)* Allow adding custom context ([#613](https://github.com/orhun/git-cliff/issues/613)) - ([522bd53](https://github.com/orhun/git-cliff/commit/522bd536a4ad63dfbfbaebcac8a92202b32b202f))\n\n### 🐛 Bug Fixes\n\n- *(changelog)* Ignore empty lines when using `split_commits` ([#608](https://github.com/orhun/git-cliff/issues/608)) - ([b8fb852](https://github.com/orhun/git-cliff/commit/b8fb85220e86138ad8b129ebf1e0599ce8aa5938))\n- *(parser)* Allow matching empty commit body ([#605](https://github.com/orhun/git-cliff/issues/605)) - ([1d1b3b8](https://github.com/orhun/git-cliff/commit/1d1b3b80e163baf34113456f24e3fbbc203e355d))\n\n### 📚 Documentation\n\n- *(readme)* Add social media badges - ([d53b905](https://github.com/orhun/git-cliff/commit/d53b9051840b46f41ccaeca6de3c37c1379a6e5a))\n- *(website)* Add note about supported platforms for NPM - ([4e4d7cd](https://github.com/orhun/git-cliff/commit/4e4d7cdbfced3618bdfaf392dbe0a3f4bbbba799))\n- *(website)* Add SourceHut builds example ([#617](https://github.com/orhun/git-cliff/issues/617)) - ([f636cfc](https://github.com/orhun/git-cliff/commit/f636cfc5ce0fdbe07d9010c1690876abcc017d29))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(npm)* Add minimum supported Node versions ([#621](https://github.com/orhun/git-cliff/issues/621)) - ([95bdf2d](https://github.com/orhun/git-cliff/commit/95bdf2db3724715f76a7b649367541ace5ca9d1f))\n- *(pypi)* Disable PyPi builds for x86_64-pc-windows-gnu - ([f675b0b](https://github.com/orhun/git-cliff/commit/f675b0b5bdbe57437e39dbe4c0b78e7c4f373936))\n- *(tests)* Don't check last commit ([#619](https://github.com/orhun/git-cliff/issues/619)) - ([68b9839](https://github.com/orhun/git-cliff/commit/68b98393e72d4a38a2e9166477784a9e1a55c9cf))\n\n## New Contributors ❤️\n\n* @lanesawyer made their first contribution in [#621](https://github.com/orhun/git-cliff/pull/621)\n* @timharek made their first contribution in [#617](https://github.com/orhun/git-cliff/pull/617)\n* @AntoineGS made their first contribution in [#608](https://github.com/orhun/git-cliff/pull/608)\n\n## [2.2.1](https://github.com/orhun/git-cliff/compare/v2.2.0..v2.2.1) - 2024-04-10\n\n### 🐛 Bug Fixes\n\n- *(npm)* Include the proper files in the npm tarball ([#594](https://github.com/orhun/git-cliff/issues/594)) - ([800c896](https://github.com/orhun/git-cliff/commit/800c8964933deda12ef17a27c566dde430a7cae9))\n\n### 📚 Documentation\n\n- *(readme)* Mention git-changelog-command-line tool ([#589](https://github.com/orhun/git-cliff/issues/589)) - ([d65b443](https://github.com/orhun/git-cliff/commit/d65b4433ce784a713355f47b30096031c7dc05f4))\n- *(website)* Add GITHUB_REPO variable to GitHub action ([#597](https://github.com/orhun/git-cliff/issues/597)) - ([3b74254](https://github.com/orhun/git-cliff/commit/3b742548cccf7a55bc071a7614fa224b41078aa2))\n- *(website)* Update release date - ([45132da](https://github.com/orhun/git-cliff/commit/45132da64284eb60330021ab8ca6d1db07206610))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(ci)* Remove audit check - ([6ba6809](https://github.com/orhun/git-cliff/commit/6ba6809ea1ff9b34f192b387e77da06cf0570606))\n\n## New Contributors ❤️\n\n* @clementnuss made their first contribution in [#597](https://github.com/orhun/git-cliff/pull/597)\n* @tomasbjerre made their first contribution in [#589](https://github.com/orhun/git-cliff/pull/589)\n\n## [2.2.0](https://github.com/orhun/git-cliff/compare/v2.1.2..v2.2.0) - 2024-03-30\n\n### ⛰️ Features\n\n- *(changelog)* Make rendering errors more verbose - ([7ee3c86](https://github.com/orhun/git-cliff/commit/7ee3c860afac12238d37141566759c17b38ac594))\n- *(config)* Support detecting config from project manifest ([#571](https://github.com/orhun/git-cliff/issues/571)) - ([9eb3d65](https://github.com/orhun/git-cliff/commit/9eb3d65945d70d04a99a2ea7a3042c404ea6f78b))\n- *(release)* Make the bump version rules configurable ([#530](https://github.com/orhun/git-cliff/issues/530)) - ([152414c](https://github.com/orhun/git-cliff/commit/152414cb817778a2deca320c034a97284d520d30))\n\n### 🐛 Bug Fixes\n\n- *(changelog)* Update the commit processing order ([#556](https://github.com/orhun/git-cliff/issues/556)) - ([c5ef9ab](https://github.com/orhun/git-cliff/commit/c5ef9ab2916552b92875a67ebb41460b9928a7fc))\n- *(changelog)* Return the last version if there is nothing to bump - ([45c87f2](https://github.com/orhun/git-cliff/commit/45c87f2f307e8441c128b81835b662362e6b380a))\n- *(command)* Add missing environment variables for Windows ([#532](https://github.com/orhun/git-cliff/issues/532)) - ([9722784](https://github.com/orhun/git-cliff/commit/972278439613d6187699fec02db8e1c4826ec92b))\n- *(commit)* Trim the text before matching with commit parser ([#573](https://github.com/orhun/git-cliff/issues/573)) - ([4971b23](https://github.com/orhun/git-cliff/commit/4971b236ace1d6a8af96f4527256ceeb8c8c4551))\n- *(config)* Drop extra '(' in first commit URL in github-keepachangelog ([#535](https://github.com/orhun/git-cliff/issues/535)) - ([8b3d09f](https://github.com/orhun/git-cliff/commit/8b3d09f7766f8dc2ae5ac1f5afab0dc51283ef3d))\n- *(npm)* Fix authenticating for `yarn npm publish` ([#574](https://github.com/orhun/git-cliff/issues/574)) - ([5a0ce6a](https://github.com/orhun/git-cliff/commit/5a0ce6acc1dab99698db73315215322d922dfde3))\n- *(release)* Fix typo in the installation of typos-cli ([#545](https://github.com/orhun/git-cliff/issues/545)) - ([700281a](https://github.com/orhun/git-cliff/commit/700281a25be52d896329027672a26b722c359283))\n\n### 📚 Documentation\n\n- *(website)* Add highlights for 2.2.0 ([#575](https://github.com/orhun/git-cliff/issues/575)) - ([2e81ad0](https://github.com/orhun/git-cliff/commit/2e81ad0022e6354a5af2d6110ea10e0e46079429))\n- *(website)* Fix the documentation for `--include-path` ([#567](https://github.com/orhun/git-cliff/issues/567)) - ([4a7aa7e](https://github.com/orhun/git-cliff/commit/4a7aa7e91f78d8d436842d289f5f61a4bd8e5a2f))\n- *(website)* Update setup-git-cliff action documentation - ([4f46396](https://github.com/orhun/git-cliff/commit/4f4639647bc73428c71ab1944b3e330023961924))\n- *(website)* Add documentation for taiki-e/install-action ([#563](https://github.com/orhun/git-cliff/issues/563)) - ([85db777](https://github.com/orhun/git-cliff/commit/85db77760914a2ac5e35d919613b744af15d0b05))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(ci)* Temporarily disable semver checks - ([f26fbe0](https://github.com/orhun/git-cliff/commit/f26fbe09ffc4ad0bf24260d7bd8a93d991817a2a))\n- *(ci)* Comment on pull requests about semver checks - ([ccdc152](https://github.com/orhun/git-cliff/commit/ccdc15217cfcc1c1c3bf09d4d997f7f99526b10e))\n- *(config)* Skip clippy commits in changelog - ([830528c](https://github.com/orhun/git-cliff/commit/830528c0c0c8d45362869df54c835afab2936c90))\n- *(github)* Remove cname - ([679aa46](https://github.com/orhun/git-cliff/commit/679aa4671984c8a5c1f5ea6929afa3fc26f667fc))\n- *(github)* Update funding options - ([4bedf76](https://github.com/orhun/git-cliff/commit/4bedf764e33454d44db9020a0dd3149df09489e2))\n- *(github)* Use form based issue templates ([#529](https://github.com/orhun/git-cliff/issues/529)) - ([8f8e221](https://github.com/orhun/git-cliff/commit/8f8e2215636262b21074963ac0d846edc55a80ab))\n- *(npm)* Publish rc version for prereleases ([#528](https://github.com/orhun/git-cliff/issues/528)) - ([16bea51](https://github.com/orhun/git-cliff/commit/16bea5179a89af26dd0bfb07c7d6b7d1efa3c54e))\n- *(pypi)* Update maturin version ([#539](https://github.com/orhun/git-cliff/issues/539)) - ([10b7ab8](https://github.com/orhun/git-cliff/commit/10b7ab829f30beba19d13437ebafc35b9bb38476))\n- *(website)* Allow deploying website manually - ([0b64bc0](https://github.com/orhun/git-cliff/commit/0b64bc032523f6565e47352cccd0d92f8bf9eae9))\n- *(website)* Only deploy website when there is a new release - ([8651832](https://github.com/orhun/git-cliff/commit/8651832926afa83dac4b9cbb5d298bbea5e7af6d))\n\n## New Contributors ❤️\n\n* @aminya made their first contribution in [#567](https://github.com/orhun/git-cliff/pull/567)\n* @jsurkont made their first contribution in [#530](https://github.com/orhun/git-cliff/pull/530)\n* @dupuy made their first contribution in [#535](https://github.com/orhun/git-cliff/pull/535)\n* @daniel-carr-3000 made their first contribution in [#532](https://github.com/orhun/git-cliff/pull/532)\n\n## [2.1.2](https://github.com/orhun/git-cliff/compare/v2.0.4..v2.1.2) - 2024-03-03\n\n### ⛰️ Features\n\n- *(args)* Add `--tag-pattern` argument ([#526](https://github.com/orhun/git-cliff/issues/526)) - ([b4e7a34](https://github.com/orhun/git-cliff/commit/b4e7a3400f0675bba63339cd89513ffcb7acb688))\n- *(npm)* Add programmatic API for TypeScript ([#523](https://github.com/orhun/git-cliff/issues/523)) - ([8b33267](https://github.com/orhun/git-cliff/commit/8b332679677ab7690d718d0d81954bff8d4cc585))\n\n### 🐛 Bug Fixes\n\n- *(cd)* Set the correct GitHub repository URL - ([7f379a9](https://github.com/orhun/git-cliff/commit/7f379a9c8377baa206d05c5cb0dfc6150905b19a))\n- *(cd)* Set a flag as a workaround for the NPM package - ([717abce](https://github.com/orhun/git-cliff/commit/717abce767906f752408e2745f47d0fc9013699c))\n- *(cd)* Set node version to 18 for building NPM packages - ([5dd0d2e](https://github.com/orhun/git-cliff/commit/5dd0d2ebf8f1e9fa81d8b933c33ed62654039ce6))\n- *(cd)* Explicitly set the Homebrew formula path - ([8d2f1fa](https://github.com/orhun/git-cliff/commit/8d2f1fab2b70da990921dfc55202ef1413ec63f1))\n- *(cd)* Set the GitHub repository explicitly - ([0e46500](https://github.com/orhun/git-cliff/commit/0e46500199f9b7cc7c83a51499f6e90a2adf5888))\n- *(config)* Fix commit parser regex in the default config - ([110b9b8](https://github.com/orhun/git-cliff/commit/110b9b8d2676800ebe169287fa5d2a93c9f6b55f))\n- *(github)* Sanitize the GitHub token in debug logs - ([be34949](https://github.com/orhun/git-cliff/commit/be34949df76f9f174dce0b9e593bda594a9d33a5))\n\n### 🚜 Refactor\n\n- *(cd)* Simplify checking pre-releases - ([87a04fb](https://github.com/orhun/git-cliff/commit/87a04fb437ce8d74c53461f2a46316ff611f074f))\n- *(changelog)* Do not output to stdout when prepend is used - ([8ee0da1](https://github.com/orhun/git-cliff/commit/8ee0da1f74a0f2cae699ce19accc073434f5b538))\n\n### 📚 Documentation\n\n- *(website)* Add tip about skipping commits by PR label - ([6d3354c](https://github.com/orhun/git-cliff/commit/6d3354ca1b0e401e5374f0cd28b2f96753ac4f2b))\n- *(website)* Add instructions for installing from WinGet ([#520](https://github.com/orhun/git-cliff/issues/520)) - ([eeaa406](https://github.com/orhun/git-cliff/commit/eeaa40673fbf28eafef462fbc61506e7d9f97678))\n\n### 🎨 Styling\n\n- *(website)* Use a short link for reporting issues - ([ba83c8a](https://github.com/orhun/git-cliff/commit/ba83c8ae71b838137682ff0c92424e064ca4f62e))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(ci)* Auto-bump the homebrew formula - ([61d055b](https://github.com/orhun/git-cliff/commit/61d055b9169b9eb3d5a458b1dc1cb6ff8d919807))\n- *(ci)* Enable default features for windows builds - ([18f4923](https://github.com/orhun/git-cliff/commit/18f4923897a4f54ebe9870014463a67f3a655c9d))\n- *(ci)* Check semver violations via CI - ([a25a114](https://github.com/orhun/git-cliff/commit/a25a1148d92ee07402c9069eaad74574e392339c))\n- *(fixtures)* Enable verbose logging for output - ([2927231](https://github.com/orhun/git-cliff/commit/292723109f328f96b84a629d61fd38b02ceef4e8))\n\n## New Contributors ❤️\n\n* @lloydjatkinson made their first contribution in [#520](https://github.com/orhun/git-cliff/pull/520)\n\n## [2.0.4](https://github.com/orhun/git-cliff/compare/v2.0.2..v2.0.4) - 2024-02-22\n\n### ⛰️ Features\n\n- *(docker)* Enable github feature for the docker image - ([bc882e3](https://github.com/orhun/git-cliff/commit/bc882e3884ca8ce1391fc70e3dcaa02204de0dd4))\n- *(github)* Support overriding the GitHub API URL ([#512](https://github.com/orhun/git-cliff/issues/512)) - ([8199699](https://github.com/orhun/git-cliff/commit/819969924bbad25484971c84a4c8d02ae48f1db9))\n\n### 🐛 Bug Fixes\n\n- *(cd)* Do not execute commands for the release changelog - ([1aaa9b2](https://github.com/orhun/git-cliff/commit/1aaa9b2150f539116007afc199f57a61bbe4ee20))\n\n### 📚 Documentation\n\n- *(website)* Add instructions for installing from conda-forge ([#511](https://github.com/orhun/git-cliff/issues/511)) - ([75a04bb](https://github.com/orhun/git-cliff/commit/75a04bb1b0d929f03a2bd224fc728dcf14b6e896))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(config)* Add animation to the header of the changelog - ([4f741a7](https://github.com/orhun/git-cliff/commit/4f741a7c9ebd52404503c60dc91e053f1b9c0171))\n- *(website)* Bump the version of git-cliff-action - ([f255ad3](https://github.com/orhun/git-cliff/commit/f255ad38b2640b3f42a40eda3b76cddb6c06d2ff))\n- *(website)* Add announcement bar for the new release - ([1d32a14](https://github.com/orhun/git-cliff/commit/1d32a14175355ef83dbaa0dd80f17a9c2493e7de))\n\n\n## [2.0.2](https://github.com/orhun/git-cliff/compare/v2.0.1..v2.0.2) - 2024-02-19\n\n### 📚 Documentation\n\n- *(release)* Add note about GitHub variables - ([54e21de](https://github.com/orhun/git-cliff/commit/54e21de5eebe61f23328e92c6fb8f8de7fd900fd))\n\n\n## [2.0.1](https://github.com/orhun/git-cliff/compare/v2.0.0..v2.0.1) - 2024-02-19\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cd)* Disable PyPI builds for linux-x86-glibc - ([30d8e41](https://github.com/orhun/git-cliff/commit/30d8e41b06e2b277e700731fe193906e49e2509a))\n\n\n## [2.0.0](https://github.com/orhun/git-cliff/compare/v1.4.0..v2.0.0) - 2024-02-19\n\n### ⛰️ Features\n\n- *(args)* Add `--no-exec` flag for skipping command execution ([#458](https://github.com/orhun/git-cliff/issues/458)) - ([7ae77ff](https://github.com/orhun/git-cliff/commit/7ae77ff0e0a22b5f5e42737204cbf0ab8680f9d7))\n- *(args)* Add `-x` short argument for `--context` - ([327512a](https://github.com/orhun/git-cliff/commit/327512a9d522e67252becd46628ef5ebe95539d7))\n- *(args)* Support initialization with built-in templates ([#370](https://github.com/orhun/git-cliff/issues/370)) - ([4bee628](https://github.com/orhun/git-cliff/commit/4bee628867a242a0165829db2ca70bfba964e345))\n- *(args)* Allow returning the bumped version ([#362](https://github.com/orhun/git-cliff/issues/362)) - ([5e01e4c](https://github.com/orhun/git-cliff/commit/5e01e4c775d1e3e7d2caa52d5bafed99dcfa0660))\n- *(args)* Set `CHANGELOG.md` as default missing value for output option ([#354](https://github.com/orhun/git-cliff/issues/354)) - ([04d149e](https://github.com/orhun/git-cliff/commit/04d149e1245d892a50307f9637b5f665b47b50d4))\n- *(changelog)* Set the timestamp of the previous release - ([d408e63](https://github.com/orhun/git-cliff/commit/d408e6377a5157f6d285b2733e6640d36316cfd4))\n- *(changelog)* Improve skipping via `.cliffignore` and `--skip-commit` ([#413](https://github.com/orhun/git-cliff/issues/413)) - ([faa00c6](https://github.com/orhun/git-cliff/commit/faa00c6e6cee3c4fa7bd06e5dd409d81ca4b6b8f))\n- *(changelog)* Support tag prefixes with `--bump` ([#347](https://github.com/orhun/git-cliff/issues/347)) - ([2399e57](https://github.com/orhun/git-cliff/commit/2399e57fd3b715875d5dc3897fad85a70cc199eb))\n- *(changelog)* [**breaking**] Set tag to `0.0.1` via `--bump` if no tags exist - ([3291eb9](https://github.com/orhun/git-cliff/commit/3291eb99acf228086633852fac9b78c30e0db673))\n- *(changelog)* [**breaking**] Support templating in the footer ([#369](https://github.com/orhun/git-cliff/issues/369)) - ([0945fa8](https://github.com/orhun/git-cliff/commit/0945fa806cc1714f92277142d974e4591c55e04f))\n- *(commit)* Add merge_commit flag to the context ([#389](https://github.com/orhun/git-cliff/issues/389)) - ([dd27a9a](https://github.com/orhun/git-cliff/commit/dd27a9a404272f3e4ea40bbfcb30a07929014442))\n- *(github)* [**breaking**] Support integration with GitHub repos ([#363](https://github.com/orhun/git-cliff/issues/363)) - ([5238326](https://github.com/orhun/git-cliff/commit/52383267905e8d007b60e4b2e21cbe2280952d72))\n- *(parser)* Support using SHA1 of the commit ([#385](https://github.com/orhun/git-cliff/issues/385)) - ([1039f85](https://github.com/orhun/git-cliff/commit/1039f8575ad5e956355bfbf0394e49d8557faa2e))\n- *(parser)* Support using regex scope values ([#372](https://github.com/orhun/git-cliff/issues/372)) - ([19e65c2](https://github.com/orhun/git-cliff/commit/19e65c25b3631004bdd032ee36eccdf79dfb618d))\n- *(template)* Support using PR labels in the GitHub template ([#467](https://github.com/orhun/git-cliff/issues/467)) - ([30d15bb](https://github.com/orhun/git-cliff/commit/30d15bbab77efecda9941bf885cb93bedbd0563c))\n- *(template)* Support using PR title in the GitHub template ([#418](https://github.com/orhun/git-cliff/issues/418)) - ([6f32f33](https://github.com/orhun/git-cliff/commit/6f32f3376e2b0b85206bc33795be57b0dad16afe))\n- *(website)* Add search bar to the website - ([2d30491](https://github.com/orhun/git-cliff/commit/2d30491bdb7914229ba417e29aa5b813b056b6ef))\n\n### 🐛 Bug Fixes\n\n- *(cd)* Use workaround for linux-arm64-glibc maturin builds - ([dc79ed5](https://github.com/orhun/git-cliff/commit/dc79ed5fe25afd6255b2d93d06d2b47016769c4b))\n- *(cd)* Disable PyPI publish for linux-arm64-glibc - ([e24af12](https://github.com/orhun/git-cliff/commit/e24af123dbd2c242f2aa98c67f98cc82ae9a3f78))\n- *(cd)* Avoid creating artifacts with the same name - ([1647fd8](https://github.com/orhun/git-cliff/commit/1647fd82e901f66e3ca00fae2688fd31fe238149))\n- *(cd)* Fix embedding examples for crates.io release - ([46b7d88](https://github.com/orhun/git-cliff/commit/46b7d880cf4f6e2ed30946f7f10a46d82f96af9a))\n- *(changelog)* Fix previous version links ([#364](https://github.com/orhun/git-cliff/issues/364)) - ([44c93b7](https://github.com/orhun/git-cliff/commit/44c93b7c704b01d371eb826fc9ffcb459f7370b1))\n- *(changelog)* Set the correct previous tag when a custom tag is given - ([6203f77](https://github.com/orhun/git-cliff/commit/6203f77dab5c19981f9dc8f8408c97344eb73003))\n- *(ci)* Update cargo-msrv arguments - ([131dd10](https://github.com/orhun/git-cliff/commit/131dd10c53087ce1ceaea07f030478fca393c253))\n- *(cli)* Fix broken pipe when stdout is interrupted ([#407](https://github.com/orhun/git-cliff/issues/407)) - ([bdce4b5](https://github.com/orhun/git-cliff/commit/bdce4b504e0b1984283ad056931fc4fe7b893dc3))\n- *(commit)* Trim the trailing newline from message ([#403](https://github.com/orhun/git-cliff/issues/403)) - ([514ca4b](https://github.com/orhun/git-cliff/commit/514ca4bda172d8fdfb612dd28f4bde8aae9e29fe))\n- *(git)* Sort commits in topological order ([#415](https://github.com/orhun/git-cliff/issues/415)) - ([29bf355](https://github.com/orhun/git-cliff/commit/29bf355205da4860ceb3777de983beb93ec47a08))\n- *(links)* Skip checking the GitHub commit URLs - ([273d6dc](https://github.com/orhun/git-cliff/commit/273d6dc14b000ab556ac7af5732e75f8857020f7))\n- *(website)* Use node version 18 - ([46dcce3](https://github.com/orhun/git-cliff/commit/46dcce38444132f851bc9dff2bdd994632c56e1c))\n- *(website)* Use prism-react-renderer v2 with docusaurus - ([664ff9b](https://github.com/orhun/git-cliff/commit/664ff9bc14e2da3c44b7cf5f11c780223c25ce53))\n- Allow version bump with a single previous release - ([d65aec9](https://github.com/orhun/git-cliff/commit/d65aec9d249b3ad941ccfac77c3248d12d3d30d3))\n\n### 🚜 Refactor\n\n- *(changelog)* Support `--bump` for processed releases ([#408](https://github.com/orhun/git-cliff/issues/408)) - ([89e4c72](https://github.com/orhun/git-cliff/commit/89e4c729a915d456c1b83f666637bf85c7125350))\n- *(ci)* Use hardcoded workspace members for cargo-msrv command - ([ec6035a](https://github.com/orhun/git-cliff/commit/ec6035a7e77c60e8b7f752619aeee36f08c80aad))\n- *(ci)* Simplify cargo-msrv installation - ([f04bf6e](https://github.com/orhun/git-cliff/commit/f04bf6eca155eec32f82aca482e5c00ab16d61a9))\n- *(config)* Use postprocessors for checking the typos - ([764e858](https://github.com/orhun/git-cliff/commit/764e858a1e948dbc507cde3264a72e3458c98833))\n- *(config)* Remove unnecessary newline from configs - ([8edec7f](https://github.com/orhun/git-cliff/commit/8edec7fd50f703811d55f14a3c5f0fd02b43d9e7))\n\n### 📚 Documentation\n\n- *(configuration)* Fix typo ([#466](https://github.com/orhun/git-cliff/issues/466)) - ([34a58e6](https://github.com/orhun/git-cliff/commit/34a58e6e2bea34bbcc5190fd10fddd0fb3e7e73f))\n- *(fixtures)* Add instructions for adding new fixtures - ([8290769](https://github.com/orhun/git-cliff/commit/82907693c19a38699c57f9206564e8a9c7d9d705))\n- *(readme)* Mention RustLab 2023 talk - ([668a957](https://github.com/orhun/git-cliff/commit/668a95774c076b53f719cdd0708b9385168dbc6e))\n- *(readme)* Use the raw link for the animation - ([2c524b8](https://github.com/orhun/git-cliff/commit/2c524b8e64a8d248a6345b4eee3afbde21bf38a8))\n- *(security)* Update security policy - ([fcaa502](https://github.com/orhun/git-cliff/commit/fcaa5021083ff7cb8f70044801fff19e1b012493))\n- *(website)* Add highlights for 2.0.0 ([#504](https://github.com/orhun/git-cliff/issues/504)) - ([49684d0](https://github.com/orhun/git-cliff/commit/49684d0fd8a6876cf09f29f3b860c2851fe7a992))\n- *(website)* Improve matching gitmoji tip ([#486](https://github.com/orhun/git-cliff/issues/486)) - ([0731646](https://github.com/orhun/git-cliff/commit/0731646c26142a92f90a6b567dfeee877d45f3c5))\n- *(website)* Add tips and tricks section - ([82e93c2](https://github.com/orhun/git-cliff/commit/82e93c26deaa0eeebe0f46f91fa2d35154bcfe2c))\n- *(website)* Add tip about link parsers - ([4bd47a6](https://github.com/orhun/git-cliff/commit/4bd47a69e9d0fbd2656fb43abab930225411259b))\n- *(website)* Add git-cliff animation to the website ([#404](https://github.com/orhun/git-cliff/issues/404)) - ([0561124](https://github.com/orhun/git-cliff/commit/05611245d9ee42d5eff7e2a64eb041b452129356))\n- *(website)* Split the configuration section - ([67486cc](https://github.com/orhun/git-cliff/commit/67486ccb72882562d94718afc4f5db3b631d49f6))\n- *(website)* Add installation instructions for Homebrew ([#357](https://github.com/orhun/git-cliff/issues/357)) - ([b2f8091](https://github.com/orhun/git-cliff/commit/b2f8091bd485a81add367a8a01066c7957e45772))\n\n### 🎨 Styling\n\n- *(website)* Add GitHub logo to the header - ([1da7cac](https://github.com/orhun/git-cliff/commit/1da7cac7ce5df4de0a49ddbb9a52621ffa849124))\n- *(website)* [**breaking**] Use dark theme as default - ([dcc5116](https://github.com/orhun/git-cliff/commit/dcc511609f42a7ae10069cd31a50540a77b59234))\n\n### 🧪 Testing\n\n- *(changelog)* Use the correct version for missing tags - ([0ca4cdb](https://github.com/orhun/git-cliff/commit/0ca4cdb45d9f910adb4d52cb6c58ec6539dabca6))\n- *(fixture)* Update the date for example test fixture - ([991a035](https://github.com/orhun/git-cliff/commit/991a035e0e070416bbde7769ac3646ae563d1f13))\n- *(fixture)* Add test fixture for bumping version - ([c94cb6a](https://github.com/orhun/git-cliff/commit/c94cb6a37ae268953ab29dd35cb43b6a4fec47cc))\n- *(fixtures)* Update the bumped value output to add prefix - ([f635bae](https://github.com/orhun/git-cliff/commit/f635bae964386c42474659f3d7903258f4ef8ee9))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(changelog)* Disable the default behavior of next-version ([#343](https://github.com/orhun/git-cliff/issues/343)) - ([4eef684](https://github.com/orhun/git-cliff/commit/4eef684c568ad16357e5d256180a51b1a46dd0cb))\n- *(changelog)* Use 0.1.0 as default next release if no tag is found - ([3123fd2](https://github.com/orhun/git-cliff/commit/3123fd2eac0da0e800923d8b9f3c86bc6814edd4))\n- *(command)* Explicitly set the directory of command to current dir - ([722efd6](https://github.com/orhun/git-cliff/commit/722efd6598a580f995bf282184c400c095c49eae))\n- *(config)* Skip dependabot commits for dev updates - ([7f89160](https://github.com/orhun/git-cliff/commit/7f891602e4818f612ef928e84488053c7aad56d9))\n- *(config)* Revamp the configuration files - ([9500bf8](https://github.com/orhun/git-cliff/commit/9500bf8ef88df8ff0fbfaf08d2eb531d09e472ef))\n- *(dependabot)* Group the dependency updates for creating less PRs - ([c6a92bf](https://github.com/orhun/git-cliff/commit/c6a92bf6871a436e60ca9774d0b0df770727e664))\n- *(docker)* Update versions in Dockerfile - ([51198a5](https://github.com/orhun/git-cliff/commit/51198a5a56ca1f8a09d527c37695231520a130d4))\n- *(embed)* Do not allow missing docs - ([7754cab](https://github.com/orhun/git-cliff/commit/7754cab1c8a53ce8703596bbc921a2a3867a4155))\n- *(example)* Use full links in GitHub templates ([#503](https://github.com/orhun/git-cliff/issues/503)) - ([a521891](https://github.com/orhun/git-cliff/commit/a521891b557772451f37a791bde04067d3f20626))\n- *(example)* Remove limited commits example - ([8e1e0d7](https://github.com/orhun/git-cliff/commit/8e1e0d73c3bb7a0294bc20c01a0a6800ebbfbb1a))\n- *(github)* Update templates about GitHub integration - ([3f5107a](https://github.com/orhun/git-cliff/commit/3f5107a02c3bb50bbd7712e81c95eeb7344e01f6))\n- *(mergify)* Don't update PRs for the main branch - ([96a220c](https://github.com/orhun/git-cliff/commit/96a220c8e9b665f96c6794ca423f04464007fe0f))\n- *(project)* Add readme to core package - ([9e6bad2](https://github.com/orhun/git-cliff/commit/9e6bad28db23b39311c4231c96f1d7805296c3b9))\n- *(project)* Bump MSRV to 1.74.1 - ([bd5e4d2](https://github.com/orhun/git-cliff/commit/bd5e4d2217c307177f6f1de99cae5f5ae5024b33))\n- *(project)* Update copyright years - ([edc6bc0](https://github.com/orhun/git-cliff/commit/edc6bc0adbf2952b8a532a44ccf11f6f1b5448f2))\n- *(website)* Fix URLs in navigation bar ([#438](https://github.com/orhun/git-cliff/issues/438)) - ([70cab99](https://github.com/orhun/git-cliff/commit/70cab990cce4ba4e9077fb69cef385e2ec209080))\n- *(website)* Rename the header for GitHub integration - ([3fd9476](https://github.com/orhun/git-cliff/commit/3fd9476a565212343d3af4e2d7387d7ef265b4f1))\n- *(website)* Fix broken anchors - ([34593dd](https://github.com/orhun/git-cliff/commit/34593dd46f3ce0f0ab809416fc37294a62658036))\n- *(website)* Bump docusaurus to 3.1.0 - ([af4482b](https://github.com/orhun/git-cliff/commit/af4482b4158ccdee71912d78f5fb0a1c280e6ed6))\n- *(website)* Update the titles for distro installations - ([ff2881b](https://github.com/orhun/git-cliff/commit/ff2881bebd1020420db04927b2ac7893edf973a6))\n- *(website)* Add Mastodon link to the website - ([2e761c9](https://github.com/orhun/git-cliff/commit/2e761c936dbe54b1c9a683f67d4556d2e64b2fec))\n\n### ◀️ Revert\n\n- *(config)* Use postprocessors for checking the typos - ([5212cc9](https://github.com/orhun/git-cliff/commit/5212cc9446bc1389274516ed3d7eb7b334b1b606))\n\n## New Contributors ❤️\n\n* @welpo made their first contribution in [#486](https://github.com/orhun/git-cliff/pull/486)\n* @bobrik made their first contribution in [#415](https://github.com/orhun/git-cliff/pull/415)\n* @vbx made their first contribution in [#403](https://github.com/orhun/git-cliff/pull/403)\n* @nappa85 made their first contribution in [#362](https://github.com/orhun/git-cliff/pull/362)\n* @sh-cho made their first contribution in [#357](https://github.com/orhun/git-cliff/pull/357)\n\n## [1.4.0](https://github.com/orhun/git-cliff/compare/v1.3.1..v1.4.0) - 2023-10-29\n\n### ⛰️ Features\n\n- *(changelog)* Support bumping the semantic version via `--bump` ([#309](https://github.com/orhun/git-cliff/issues/309)) - ([bcfcd1f](https://github.com/orhun/git-cliff/commit/bcfcd1fd59fa2c1ef3222d588f3a563c3e10027e))\n- *(ci)* Add 'typos' check ([#317](https://github.com/orhun/git-cliff/issues/317)) - ([88c34ab](https://github.com/orhun/git-cliff/commit/88c34abe2c6572d401e0bd77d2aec4138bd2c88b))\n- *(command)* Log the output of failed external commands - ([205cdbb](https://github.com/orhun/git-cliff/commit/205cdbb391b03244abaf2e5e0651976544c78ff4))\n- *(config)* [**breaking**] Support regex in 'tag_pattern' configuration ([#318](https://github.com/orhun/git-cliff/issues/318)) - ([3c2fb60](https://github.com/orhun/git-cliff/commit/3c2fb6072612a38ab7c6ea41e7c2ae34435fde99))\n- *(config)* Add field and value matchers to the commit parser ([#312](https://github.com/orhun/git-cliff/issues/312)) - ([04fbcb8](https://github.com/orhun/git-cliff/commit/04fbcb88a5cb85a2f192b3ecc7261bd55548be9e))\n\n### 📚 Documentation\n\n- *(blog)* Fix the TOML format in 1.4.0 blog post - ([4d691d2](https://github.com/orhun/git-cliff/commit/4d691d2620f6fcd574c2be64c6a8f6023db063c2))\n- *(blog)* Add blog post for 1.4.0 release - ([e3f1b3b](https://github.com/orhun/git-cliff/commit/e3f1b3bdb3d7f8a0dce695fed18077aacdc1d3bd))\n- *(changelog)* Fix typos ([#316](https://github.com/orhun/git-cliff/issues/316)) - ([edd3c30](https://github.com/orhun/git-cliff/commit/edd3c30000af1542c0df5b3ca5e0ea4fcc6efb74))\n- *(config)* Update the comment for tag_pattern - ([596fd4d](https://github.com/orhun/git-cliff/commit/596fd4d14d57ce6357c299181c523a00af11b36c))\n- *(core)* Update the doc comment for commit preprocessors - ([7faccc6](https://github.com/orhun/git-cliff/commit/7faccc65a87fe29aa26cdfce63880899a0e8bf3d))\n- *(image)* Use images from the repository - ([91c0cda](https://github.com/orhun/git-cliff/commit/91c0cda9dc79740d322275f45184facfc8300163))\n- *(lib)* Extract feature documentation from Cargo.toml - ([1f8098c](https://github.com/orhun/git-cliff/commit/1f8098cd7f0f5473a3a7f847aaaa62b1cfdc7759))\n- *(lib)* Add logo and favicon to docs.rs page - ([32b1fe1](https://github.com/orhun/git-cliff/commit/32b1fe1556e25c2a29adffe0a68e68183bc9ae63))\n- *(readme)* Add link to emacs package support git-cliff ([#307](https://github.com/orhun/git-cliff/issues/307)) - ([fa471c7](https://github.com/orhun/git-cliff/commit/fa471c7178dce184ca6fe5bbb24b9c2db96d68ce))\n- *(website)* Fix typos in configuration docs ([#329](https://github.com/orhun/git-cliff/issues/329)) - ([d863c94](https://github.com/orhun/git-cliff/commit/d863c9481a7882a1a1ecc59050c2d30b2b9a1728))\n- *(website)* Add instructions for installing the latest git version - ([be87608](https://github.com/orhun/git-cliff/commit/be87608002d6beba58368af4fed73e746cde352a))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(ci)* Update the link checker configuration ([#315](https://github.com/orhun/git-cliff/issues/315)) - ([32cbea8](https://github.com/orhun/git-cliff/commit/32cbea8e48300746879e754618672c5a1270ba95))\n- *(config)* Update tag_pattern value for backwards compatibility - ([2c621f7](https://github.com/orhun/git-cliff/commit/2c621f71e6cdca05b17516d2a9ba80fbabd4d3f8))\n- *(img)* Add more images - ([2792362](https://github.com/orhun/git-cliff/commit/2792362a52a8fc862fa7899cda911ce7e56786b1))\n- *(img)* Add git-cliff logo - ([51f5e5b](https://github.com/orhun/git-cliff/commit/51f5e5b16f7f509c59bd1d6e990989ba33581e7b))\n- *(release)* Update cargo-deb usage - ([213f383](https://github.com/orhun/git-cliff/commit/213f383b54c9a40a351f341c28bbdf03b73f701d))\n- *(website)* Update the tracking link - ([eb9f8e9](https://github.com/orhun/git-cliff/commit/eb9f8e970d2adcb6c6f512b20ca8a9f77d09ff54))\n\n## New Contributors ❤️\n\n* @woshilapin made their first contribution in [#318](https://github.com/orhun/git-cliff/pull/318)\n* @debghs made their first contribution in [#329](https://github.com/orhun/git-cliff/pull/329)\n* @dpecos made their first contribution in [#312](https://github.com/orhun/git-cliff/pull/312)\n* @eki3z made their first contribution in [#307](https://github.com/orhun/git-cliff/pull/307)\n\n## [1.3.1](https://github.com/orhun/git-cliff/compare/v1.3.0..v1.3.1) - 2023-09-30\n\n### ⛰️ Features\n\n- *(args)* Support tilde for options ([#266](https://github.com/orhun/git-cliff/issues/266)) - ([8698bc2](https://github.com/orhun/git-cliff/commit/8698bc2ce4d58fdeb9563c18f7430798b6359029))\n- *(ci)* Distribute RPM package ([#159](https://github.com/orhun/git-cliff/issues/159)) - ([baf4da8](https://github.com/orhun/git-cliff/commit/baf4da80639682628ca4ae538b4555ff1b6262da))\n\n### 🐛 Bug Fixes\n\n- *(ci)* Update cargo-tarpaulin arguments - ([83a0371](https://github.com/orhun/git-cliff/commit/83a03711185df20f37bbcbad955e7783b8bdb662))\n\n### 🚜 Refactor\n\n- *(ci)* Simplify cargo-tarpaulin installation - ([95f8d53](https://github.com/orhun/git-cliff/commit/95f8d53ac158d81433f6a49cf0794d92b0eb21ef))\n\n### 📚 Documentation\n\n- *(installation)* Update instructions for Arch Linux - ([291a928](https://github.com/orhun/git-cliff/commit/291a9282888547b4c45d64ccb8f1495448544201))\n- *(installation)* Add instructions for Alpine Linux - ([3199bba](https://github.com/orhun/git-cliff/commit/3199bba672e8045141debf1268873811f17ac405))\n- *(license)* Re-license under the MIT + Apache 2.0 license ([#303](https://github.com/orhun/git-cliff/issues/303)) - ([cd56344](https://github.com/orhun/git-cliff/commit/cd563444dec852bacc2586dea55a7b0d5dcdc844))\n- Update Tera links to the new URL ([#272](https://github.com/orhun/git-cliff/issues/272)) - ([890de00](https://github.com/orhun/git-cliff/commit/890de0007e108059378b134e9b9d0af2a6965027))\n\n### ⚙️ Miscellaneous Tasks\n\n- Remove GPL code ([#293](https://github.com/orhun/git-cliff/issues/293)) - ([e3606ba](https://github.com/orhun/git-cliff/commit/e3606babdf35022b662c870cb720c1f5339e1543))\n\n### ◀️ Revert\n\n- *(args)* Update clap and clap extras to v4 ([#137](https://github.com/orhun/git-cliff/issues/137)) ([#292](https://github.com/orhun/git-cliff/issues/292)) - ([fb4c733](https://github.com/orhun/git-cliff/commit/fb4c733a70a4dbc25060481ee5f3c644bb0bb83b))\n\n## New Contributors ❤️\n\n* @joshka made their first contribution in [#293](https://github.com/orhun/git-cliff/pull/293)\n* @dnaka91 made their first contribution in [#272](https://github.com/orhun/git-cliff/pull/272)\n\n## [1.3.0](https://github.com/orhun/git-cliff/compare/v1.2.0..v1.3.0) - 2023-08-31\n\n### ⛰️ Features\n\n- *(changelog)* [**breaking**] Add postprocessors ([#155](https://github.com/orhun/git-cliff/issues/155)) - ([5dc5fb7](https://github.com/orhun/git-cliff/commit/5dc5fb786db922322faacf928cc571a2d785cab2))\n\n### 🐛 Bug Fixes\n\n- *(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))\n- *(cd)* Disable win32-arm64 PyPI builds - ([baf34a8](https://github.com/orhun/git-cliff/commit/baf34a81f0b27be30f24f8899d44dfd1f3afaa13))\n- *(deps)* Avoid problematic serde release - ([87f74bc](https://github.com/orhun/git-cliff/commit/87f74bc78feb94c390ad421849e9b356e71657ca))\n- *(examples)* Add missing newline ([#253](https://github.com/orhun/git-cliff/issues/253)) - ([aad4222](https://github.com/orhun/git-cliff/commit/aad4222986ea9d65807f3dcb06446d19455e3865))\n- *(informer)* Do not inform about pre-releases ([#249](https://github.com/orhun/git-cliff/issues/249)) - ([87e47e6](https://github.com/orhun/git-cliff/commit/87e47e68b6154a4da870342e0973123a974cb105))\n- Fix previous release references - ([fbb605e](https://github.com/orhun/git-cliff/commit/fbb605e4f663d96ad140767bf816b5af8c97a92e))\n\n### 🚜 Refactor\n\n- *(config)* Use a macro for generating commit list - ([c695ca3](https://github.com/orhun/git-cliff/commit/c695ca308e5aada03cbd65085497436ac5c341e9))\n- *(docker)* Avoid copying volume inside container ([#142](https://github.com/orhun/git-cliff/issues/142)) - ([65d365c](https://github.com/orhun/git-cliff/commit/65d365c7b521e30ebc173d97f10c41da604582ae))\n- *(lib)* Use implicit serde imports - ([c8cf855](https://github.com/orhun/git-cliff/commit/c8cf855939ce588824d7a4109ddf0f1c0828b6c6))\n\n### 📚 Documentation\n\n- *(blog)* Add blog post for 1.3.0 release ([#264](https://github.com/orhun/git-cliff/issues/264)) - ([93d4aa4](https://github.com/orhun/git-cliff/commit/93d4aa41e362d8f1c332930a8a400a2781146625))\n- *(example)* Update the header of configuration examples - ([0bf5ebe](https://github.com/orhun/git-cliff/commit/0bf5ebe79b293d28a3ed168ef26e4d7c2477614a))\n- *(example)* Add example for generating changelog similar to cocogitto - ([e1cf26e](https://github.com/orhun/git-cliff/commit/e1cf26e2a57266e786b395a76f0fc95a7b723cc3))\n- *(readme)* Add contributors graph - ([3c9ced0](https://github.com/orhun/git-cliff/commit/3c9ced0b0526c5f5c63c160a03ae06076624eb6c))\n\n### 🎨 Styling\n\n- *(config)* Further beautify the changelog in this repo - ([fd7446c](https://github.com/orhun/git-cliff/commit/fd7446ce2f977da44620dc61a95a7e642f6fd000))\n- *(config)* Apply formatting to configuration files - ([e9aa991](https://github.com/orhun/git-cliff/commit/e9aa9918b650cc88b53e4c96783d5161a94cee9a))\n- Fix formatting - ([14725e5](https://github.com/orhun/git-cliff/commit/14725e547bb40cd4c3c152515b7c5994eed4a49e))\n\n### 🧪 Testing\n\n- *(changelog)* Add cases for `docs:` prefix ([#167](https://github.com/orhun/git-cliff/issues/167)) - ([3a717e2](https://github.com/orhun/git-cliff/commit/3a717e25aa8fb757dd7af80463938be426313139))\n- *(repo)* Add an informative error message to failing test - ([7d7470b](https://github.com/orhun/git-cliff/commit/7d7470b2d0d030135aab09369d6484837c2bd6c7))\n- Fix keep a changelog test case - ([0a6ed62](https://github.com/orhun/git-cliff/commit/0a6ed62f57929657c1c464c371c100217f7eeb50))\n- Fix keep a changelog test case - ([f5d3365](https://github.com/orhun/git-cliff/commit/f5d336522682d31ba5f4486c6ef0880e8160de95))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cargo)* Update MSRV to 1.70.0 - ([1068912](https://github.com/orhun/git-cliff/commit/10689128222865515c32c9730fc5742beb7e6b03))\n- *(cd)* Use the latest git-cliff-action for releases - ([3eb97b8](https://github.com/orhun/git-cliff/commit/3eb97b8426ec42e28ed1d623f8d8a15a7a64756e))\n- *(cd)* Support creating prereleases on GitHub - ([a22426a](https://github.com/orhun/git-cliff/commit/a22426a37d6278f1d348751d00928a20057b578c))\n- *(config)* Add additional parsers for default config - ([b745778](https://github.com/orhun/git-cliff/commit/b7457785e6b753ccd9c163b18ad557a0a621f87c))\n- *(config)* Update configuration for alpha/beta/rc releases - ([7e7e5a7](https://github.com/orhun/git-cliff/commit/7e7e5a7e09acf6e91e45b25cb567a8f9bdd56bb5))\n- *(config)* Skip dependency updates in the changelog - ([b2edc23](https://github.com/orhun/git-cliff/commit/b2edc231a6d999f3af737a2bff00309b499e13d7))\n- *(core)* Make git2 optional - ([5fdf39a](https://github.com/orhun/git-cliff/commit/5fdf39ae32441ce70a942e577e31ba0cd2323137))\n- *(docker)* Update versions in Dockerfile - ([0ccab91](https://github.com/orhun/git-cliff/commit/0ccab915868b2e594e7bef0b9e56eb290ca500dc))\n- *(github)* Add config for welcome bot - ([a4725d4](https://github.com/orhun/git-cliff/commit/a4725d4ce43340cdb0483ac2bb7566c00dc7a991))\n- *(mergify)* Rename mergify configuration file - ([9fd1be6](https://github.com/orhun/git-cliff/commit/9fd1be6dc6a5189911572caab99f13c72903af09))\n- *(mergify)* Add configuration file for automatic merge ([#245](https://github.com/orhun/git-cliff/issues/245)) - ([0a79aae](https://github.com/orhun/git-cliff/commit/0a79aae3576aaa17385d17d114ef6d3f3aa1fb48))\n- *(pypi)* Publish `git-cliff` on PyPI ([#158](https://github.com/orhun/git-cliff/issues/158)) - ([2b7a1ef](https://github.com/orhun/git-cliff/commit/2b7a1efaafca017c4a21f1af25c6047347119e8d))\n- Check without default features - ([e323621](https://github.com/orhun/git-cliff/commit/e323621094141acaab360d6fa42990c7cdd4bac4))\n\n## New Contributors ❤️\n\n* @alexfertel made their first contribution in [#253](https://github.com/orhun/git-cliff/pull/253)\n* @tvcsantos made their first contribution\n* @beeb made their first contribution in [#167](https://github.com/orhun/git-cliff/pull/167)\n* @PSeitz made their first contribution in [#155](https://github.com/orhun/git-cliff/pull/155)\n* @alerque made their first contribution in [#142](https://github.com/orhun/git-cliff/pull/142)\n\n## [1.2.0](https://github.com/orhun/git-cliff/compare/v1.1.2..v1.2.0) - 2023-04-28\n\n### ⛰️ Features\n\n- *(args)* Update clap and clap extras to v4 ([#137](https://github.com/orhun/git-cliff/issues/137)) - ([0e710c2](https://github.com/orhun/git-cliff/commit/0e710c256b1bbb7e0ab9e4cd5e16e01bac037d42))\n- *(commit)* Make the fields of `Signature` public - ([104aac9](https://github.com/orhun/git-cliff/commit/104aac93b468071c107e95ba0d377a69993e3403))\n- *(config)* Add a custom configuration file for the repository - ([0d4e689](https://github.com/orhun/git-cliff/commit/0d4e689115bdef19b3c44d110bde81820201518f))\n- *(config)* Support placing configuration inside pyproject.toml ([#147](https://github.com/orhun/git-cliff/issues/147)) - ([fe5e5b8](https://github.com/orhun/git-cliff/commit/fe5e5b841a27b48c9b9d49483deaf72431c771c4))\n- *(docker)* Generate SBOM/provenance for the Docker image - ([2ef259e](https://github.com/orhun/git-cliff/commit/2ef259e8cc79cfaabd5b51cccf85dde3c381e7c6))\n- *(parser)* Support using regex group values ([#145](https://github.com/orhun/git-cliff/issues/145)) - ([7767ace](https://github.com/orhun/git-cliff/commit/7767ace8f8c7a38a27c9850438f7fcc752502c81))\n\n### 🐛 Bug Fixes\n\n- *(ci)* Use MUSL build of cargo-tarpaulin - ([98c9e00](https://github.com/orhun/git-cliff/commit/98c9e00aefcf625a27ee335927a24d36dbf25f75))\n- *(ci)* Update cargo-tarpaulin installation command for CI - ([3019eff](https://github.com/orhun/git-cliff/commit/3019eff86929289b8f1d6b13705d95a9a3cc7952))\n- *(config)* [**breaking**] Nested environment config overrides ([#157](https://github.com/orhun/git-cliff/issues/157)) - ([bb9a889](https://github.com/orhun/git-cliff/commit/bb9a889f1b06dd44f7183771644ce95520995e58))\n- *(config)* Set max of `limit_commits` to the number of commits ([#140](https://github.com/orhun/git-cliff/issues/140)) - ([06f6732](https://github.com/orhun/git-cliff/commit/06f6732b77c19e69333fe53196e2d3b4ac5eb557))\n- *(deploy)* Set the node cache dependency path - ([020b02d](https://github.com/orhun/git-cliff/commit/020b02d3e3fa2ea40057d001028f38335d402dbf))\n- *(docker)* Remove target directory from .dockerignore - ([c0f97bd](https://github.com/orhun/git-cliff/commit/c0f97bd0b7a4ffbfd898dfefa614bf5a928d75f0))\n- *(release)* Use the correct argument in release script - ([b3eef4a](https://github.com/orhun/git-cliff/commit/b3eef4a6889cdedac1c0760455849067ef2d887d))\n- *(website)* Fix broken links - ([77dda53](https://github.com/orhun/git-cliff/commit/77dda538431b94b4577223ea381db9f756519e3d))\n\n### 🚜 Refactor\n\n- *(cd)* Remove unnecessary config update - ([e42f910](https://github.com/orhun/git-cliff/commit/e42f91013b8be1d0cba55fa638f702b9bfa85df2))\n- *(ci)* Test the website deployment with a different job - ([2d72125](https://github.com/orhun/git-cliff/commit/2d721259ca747813c8f9502d84f41b69d5fc685c))\n- *(lib)* [**breaking**] Move changelog module to git-cliff-core - ([2ab2c8f](https://github.com/orhun/git-cliff/commit/2ab2c8fb5e0c56b5ec51689ea33ebd4ec98a5310))\n- *(test)* Handle errors for changelog module tests - ([ed389b7](https://github.com/orhun/git-cliff/commit/ed389b70e22f056549637573917a23adcb345733))\n- *(website)* Update header location - ([72af8ac](https://github.com/orhun/git-cliff/commit/72af8ac129bce5cb1dee119d3e8743112506a939))\n\n### 📚 Documentation\n\n- *(blog)* Add blog post about what's new in 1.2.0 - ([e0a29ef](https://github.com/orhun/git-cliff/commit/e0a29efe3f4cc6a4162727f7322af2aaf73da619))\n- *(blog)* Update the blog post style - ([74cf47e](https://github.com/orhun/git-cliff/commit/74cf47e380d3dae4622a54ad1f0b3e31a96c59c6))\n- *(config)* Update the sections - ([c402452](https://github.com/orhun/git-cliff/commit/c4024523fac06f1a886979d2fe748078f7b3267d))\n- *(config)* Add comments to the default configuration file - ([7e3adb0](https://github.com/orhun/git-cliff/commit/7e3adb0442384e76219dc5f92083f6cbd2a59968))\n- *(contributing)* Mention the nightly requirement for rustfmt - ([a5a78fc](https://github.com/orhun/git-cliff/commit/a5a78fc4c5a44353b570327e7c21d51266d8e712))\n- *(contributing)* Update MSRV - ([a824f48](https://github.com/orhun/git-cliff/commit/a824f48f12842ed730fd46413937212763cb38c9))\n- *(examples)* Move examples to separate file - ([db43437](https://github.com/orhun/git-cliff/commit/db434371518005d43819fd361617d94ac9e613f7))\n- *(github)* Update the pull request template about GitHub labels - ([54f735a](https://github.com/orhun/git-cliff/commit/54f735ab1ab0528447b4a3cd70f583d563b99d8c))\n- *(github)* Update pull request template - ([c261fad](https://github.com/orhun/git-cliff/commit/c261fad137a5332cd1ab611970c845565a3b57fe))\n- *(github)* Update issue templates - ([6a076ca](https://github.com/orhun/git-cliff/commit/6a076cabeb725a851530cda707355f6493a9fd68))\n- *(github)* Update funding options - ([6e35834](https://github.com/orhun/git-cliff/commit/6e3583423698f0b9b18bef236e9f22f30272e848))\n- *(github)* Add security policy - ([823d272](https://github.com/orhun/git-cliff/commit/823d272a9e54faae287cd9b782855026b1476567))\n- *(readme)* Update README.md about documentation website - ([56240fd](https://github.com/orhun/git-cliff/commit/56240fd11f4d7142d1b734f1afdd419ba2a6e6d8))\n- *(readme)* Add tj-actions/git-cliff to the list of actions ([#152](https://github.com/orhun/git-cliff/issues/152)) - ([2520dd2](https://github.com/orhun/git-cliff/commit/2520dd2fda2e88aa3dd1888e559260c9819c4844))\n- *(readme)* Add discord badge - ([9fa5dd4](https://github.com/orhun/git-cliff/commit/9fa5dd44c1b65cd801db6d4a677e77ba12ddf9d8))\n- *(readme)* Add release-plz to related projects ([#151](https://github.com/orhun/git-cliff/issues/151)) - ([f781e29](https://github.com/orhun/git-cliff/commit/f781e299ca4a631dbd0c686e640804a98d85fbf6))\n- *(readme)* Fix typos in README.md - ([38943e8](https://github.com/orhun/git-cliff/commit/38943e8bac1d9535118121a4fea1821f85b93566))\n- *(readme)* Remove unneeded word in README.md ([#141](https://github.com/orhun/git-cliff/issues/141)) - ([6f1459b](https://github.com/orhun/git-cliff/commit/6f1459bcc06f06b72e33bf450bd57958cbdf5830))\n- *(readme)* Add link to the Console #141 interview about git-cliff - ([d057390](https://github.com/orhun/git-cliff/commit/d057390b14cb72db2a6b159790d1b4bdb0cb2b55))\n- *(website)* Add Twitter link to banner - ([ee5ea85](https://github.com/orhun/git-cliff/commit/ee5ea855b85ac809b9b732165f71dd84471e4ec5))\n- *(website)* Move documentation to the website ([#153](https://github.com/orhun/git-cliff/issues/153)) - ([56d3544](https://github.com/orhun/git-cliff/commit/56d3544454633927b889d8b921a465b967b4e002))\n\n### 🎨 Styling\n\n- *(docs)* Fix the grammar for tj-actions - ([53c0c1d](https://github.com/orhun/git-cliff/commit/53c0c1d0758fe20734d4b7ec792faa5413d4c533))\n- *(docs)* Update the formatting for python integration example - ([3ee6724](https://github.com/orhun/git-cliff/commit/3ee672483790ec71c700907a6e93af4698492026))\n- *(readme)* Update the style for project name - ([c41bbe0](https://github.com/orhun/git-cliff/commit/c41bbe05a2594ea945994de97f77b1ec292f49b1))\n- *(readme)* Apply formatting - ([a4290c7](https://github.com/orhun/git-cliff/commit/a4290c7be832aaac894f9b4e69837f0eb13d9287))\n- *(website)* Update the style for environment variable section - ([24ba433](https://github.com/orhun/git-cliff/commit/24ba43330a3b98d1d2c11dfa2e92c44eeabe2b7d))\n\n### 🧪 Testing\n\n- *(deploy)* Test the website deployment for pull requests - ([6f8a2f9](https://github.com/orhun/git-cliff/commit/6f8a2f96da1239f1261e597a6a358d9261f2c5e0))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cargo)* Update MSRV to 1.64.0 - ([84f20f9](https://github.com/orhun/git-cliff/commit/84f20f906fbb7995c656bd0ea14432ff6ff8d969))\n- *(cd)* Temporarily switch back to action-rs/toolchain - ([1f897e3](https://github.com/orhun/git-cliff/commit/1f897e3d70dfe278de824c508febec42855878f3))\n- *(ci)* Switch to dtolnay/rust-toolchain action - ([d54f72a](https://github.com/orhun/git-cliff/commit/d54f72aff416fcf6f4897ff69b0c114796f154e1))\n- *(ci)* Update runner images - ([07e7938](https://github.com/orhun/git-cliff/commit/07e7938b6eb4dc9cf789e84bd007f02c500d31e9))\n- *(docker)* Update versions in Dockerfile - ([95e8408](https://github.com/orhun/git-cliff/commit/95e8408ae661bb5fe003e2388d8449b1eb7f168c))\n- *(docker)* Bump the action versions in docker workflow - ([c02538f](https://github.com/orhun/git-cliff/commit/c02538f85c1cf4e8ecba8556dad9c9e806de9e49))\n- *(docker)* Bump build-push-action to v4 - ([0c84ed8](https://github.com/orhun/git-cliff/commit/0c84ed8eea663d9d78912080d3fe953f35c39216))\n- *(editorconfig)* Fix editorconfig syntax - ([e35d83d](https://github.com/orhun/git-cliff/commit/e35d83d2cfb88b0552f648eda9193ffab9f0bbd4))\n- *(editorconfig)* Update editorconfig for better code readability - ([8a4f928](https://github.com/orhun/git-cliff/commit/8a4f928f9e925cbf70ad373d71b4f677817ac8f2))\n- *(examples)* Remove EXAMPLES.md - ([8038659](https://github.com/orhun/git-cliff/commit/80386597033090e427d1359b4797ee5dbbf113e5))\n- *(github)* Integrate Dependabot - ([fe5a4dd](https://github.com/orhun/git-cliff/commit/fe5a4dd8f0fe4997f340967082ee9204f345a2a4))\n- *(github)* Integrate bors - ([1ab6f39](https://github.com/orhun/git-cliff/commit/1ab6f39c849fe191992257622ea03618d76b3464))\n- *(github)* Add contact links for issues - ([d3cb25b](https://github.com/orhun/git-cliff/commit/d3cb25bc9962b348e240b73ccd513b90c2b765e0))\n- *(website)* Add workflow file for deploying the website - ([f550458](https://github.com/orhun/git-cliff/commit/f550458414f4c35dd1c23e3d05d1115424404a3c))\n- *(website)* Move website to website folder - ([5644d10](https://github.com/orhun/git-cliff/commit/5644d1036508ffb420e12503adb671708e087cd9))\n- *(website)* Move website to docs for GitHub pages deployment - ([b6e52e1](https://github.com/orhun/git-cliff/commit/b6e52e128e7a105682adf885850d14deefdff3ec))\n\n## New Contributors ❤️\n\n* @bors[bot] made their first contribution in [#161](https://github.com/orhun/git-cliff/pull/161)\n* @dependabot[bot] made their first contribution\n* @mackness made their first contribution in [#157](https://github.com/orhun/git-cliff/pull/157)\n* @jackton1 made their first contribution in [#152](https://github.com/orhun/git-cliff/pull/152)\n* @radusuciu made their first contribution in [#147](https://github.com/orhun/git-cliff/pull/147)\n* @lbowenwest made their first contribution in [#137](https://github.com/orhun/git-cliff/pull/137)\n* @jankatins made their first contribution in [#141](https://github.com/orhun/git-cliff/pull/141)\n* @saidsay-so made their first contribution in [#140](https://github.com/orhun/git-cliff/pull/140)\n\n## [1.1.2](https://github.com/orhun/git-cliff/compare/v1.1.1..v1.1.2) - 2023-01-20\n\n### 🐛 Bug Fixes\n\n- *(changelog)* Allow saving context to a file ([#138](https://github.com/orhun/git-cliff/issues/138)) - ([08ea900](https://github.com/orhun/git-cliff/commit/08ea900de09a124710d07783b2271cdbf453dd94))\n- *(changelog)* Do not skip all tags when `skip_tags` is empty ([#136](https://github.com/orhun/git-cliff/issues/136)) - ([eee35ad](https://github.com/orhun/git-cliff/commit/eee35ad1eeeb89313e69086ad265ab400a6b4898))\n- *(git)* Derive the tag order from commits instead of timestamp ([#139](https://github.com/orhun/git-cliff/issues/139)) - ([4df5656](https://github.com/orhun/git-cliff/commit/4df5656c1239b0252ce9e7571efa06e9d11490ea))\n\n### 🎨 Styling\n\n- *(fmt)* Update the derives in config module - ([336b25f](https://github.com/orhun/git-cliff/commit/336b25f3ae9da5d972304662fcdb88f4719c721d))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cargo)* Add metadata for cargo-binstall - ([31dac34](https://github.com/orhun/git-cliff/commit/31dac3410c04b837c7ede271faf9d862c58966af))\n- *(docker)* Update versions in Dockerfile - ([353ca62](https://github.com/orhun/git-cliff/commit/353ca62260e8d71c68ec5a3a4ce1abe795f2cab5))\n\n### ◀️ Revert\n\n- *(git)* Use timestamp for deriving the tag order ([#139](https://github.com/orhun/git-cliff/issues/139)) - ([accfb0f](https://github.com/orhun/git-cliff/commit/accfb0fcdd06c66d3e9d98f8848cbb9ab0944d09))\n\n\n## [1.1.1](https://github.com/orhun/git-cliff/compare/v1.1.0..v1.1.1) - 2023-01-09\n\n### 🐛 Bug Fixes\n\n- *(npm)* Fix the type casting in base NPM package - ([bc0807f](https://github.com/orhun/git-cliff/commit/bc0807fe935d1ea1b1fe81025f8f4da0aad3387c))\n- *(npm)* Fix the variable declaration for NPM package OS - ([f40a565](https://github.com/orhun/git-cliff/commit/f40a56588e22de2f6ed83e9d7b333da11cc0a797))\n- *(npm)* Rename the NPM binary package for Windows - ([ce1d468](https://github.com/orhun/git-cliff/commit/ce1d468f0bd045f584d2ce4c0ed5f046cdc13777))\n\n### 📚 Documentation\n\n- *(readme)* Update README.md about the NPM package - ([e0177c2](https://github.com/orhun/git-cliff/commit/e0177c25e13812306aab0b0991562d58b6d14767))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cd)* Parallelize releasing on crates.io - ([24c8e3e](https://github.com/orhun/git-cliff/commit/24c8e3e4cf092dc347f90c6621238d86f0001f2a))\n- *(cd)* Add README.md to the base NPM package - ([e2e124e](https://github.com/orhun/git-cliff/commit/e2e124ed4bc9ff77413af1b5cd075f5a55ca98de))\n- *(npm)* Add more keywords to the base NPM package - ([abe68a2](https://github.com/orhun/git-cliff/commit/abe68a28847ec9d444337fb1adec522fca7aac1b))\n- *(npm)* Package `git-cliff` for npm ([#133](https://github.com/orhun/git-cliff/issues/133)) - ([b7dd592](https://github.com/orhun/git-cliff/commit/b7dd592653a722a764609a3eacff5e1eee58c07e))\n\n\n## [1.1.0](https://github.com/orhun/git-cliff/compare/v1.0.0..v1.1.0) - 2023-01-08\n\n### ⛰️ Features\n\n- *(git)* Support generating changelog for multiple git repositories ([#13](https://github.com/orhun/git-cliff/issues/13)) - ([8b17a1f](https://github.com/orhun/git-cliff/commit/8b17a1f02619027bebc5df1a8938aaf76adcd631))\n\n### 🚜 Refactor\n\n- *(cd)* Use the git-cliff-action output for GitHub release body - ([03cf3a7](https://github.com/orhun/git-cliff/commit/03cf3a7028ec273bf23085d4bdac729422d83b42))\n\n### 📚 Documentation\n\n- *(readme)* Update copyright years - ([261ee4f](https://github.com/orhun/git-cliff/commit/261ee4f146ac7d68353dd052c62a510aadebfad4))\n- *(readme)* Disable Liquid parsing in README.md by using raw blocks - ([6e8c7ed](https://github.com/orhun/git-cliff/commit/6e8c7edd3ab3a7efb53bb8197407c295a8252396))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cd)* Publish binaries for more platforms/architectures - ([ce1b7c3](https://github.com/orhun/git-cliff/commit/ce1b7c3d7b7622af03994bd7a2fbcbb00a7be8bf))\n- *(cd)* Bump git-cliff-action to v2 - ([1b3cba8](https://github.com/orhun/git-cliff/commit/1b3cba8dca0d8e9da76c9d7c2444d04a3cd30528))\n- *(config)* Update the description in the default config - ([0350bfd](https://github.com/orhun/git-cliff/commit/0350bfdee229ee50bb289b68190b9737d7ab572c))\n- *(docker)* Add Jekyll configuration to .dockerignore - ([5dd1a15](https://github.com/orhun/git-cliff/commit/5dd1a15a6cf393de8efd1a63de5374f65e706120))\n- *(github)* Add Jekyll theme configuration for GitHub pages - ([81e5720](https://github.com/orhun/git-cliff/commit/81e5720376346a2b0d3ef5a3ef4408507044f6e0))\n- *(release)* Improve the release script with additional messages - ([09ab59f](https://github.com/orhun/git-cliff/commit/09ab59f12e8d295e607966f295b39d3ad2457fd0))\n\n\n## [1.0.0](https://github.com/orhun/git-cliff/compare/v0.10.0..v1.0.0) - 2022-12-25\n\n### ⛰️ Features\n\n- *(cd)* Publish Debian package via release workflow ([#113](https://github.com/orhun/git-cliff/issues/113)) - ([efd827f](https://github.com/orhun/git-cliff/commit/efd827f59f8394dd894ebd35a5d630ff558a3ebe))\n- *(cd)* Include completions and mangen in binary releases ([#115](https://github.com/orhun/git-cliff/issues/115)) - ([9a070b2](https://github.com/orhun/git-cliff/commit/9a070b248d4ae0b58c9463f0627c87ca647c3023))\n- *(changelog)* [**breaking**] Use current time for `--tag` argument ([#107](https://github.com/orhun/git-cliff/issues/107)) - ([e2cd07b](https://github.com/orhun/git-cliff/commit/e2cd07bcc92a6bdd011bbbb34843f22e6c4da271))\n- *(changelog)* Allow running with `--prepend` and `--output` ([#120](https://github.com/orhun/git-cliff/issues/120)) - ([7325be8](https://github.com/orhun/git-cliff/commit/7325be84045ad376e0989a111ed3c44a3e1400ea))\n- *(changelog, config)* [**breaking**] Replace `--date-order` by `--topo-order` - ([77731ec](https://github.com/orhun/git-cliff/commit/77731ec7aeb279b5b7a49b5f7d17cc51009afca2))\n\n### 🐛 Bug Fixes\n\n- *(fixtures)* Fix test fixture failures - ([29b3dd1](https://github.com/orhun/git-cliff/commit/29b3dd15982f8645d3f75c185d7a5adbfbb2a06f))\n\n### 📚 Documentation\n\n- *(readme)* Fix GitHub badges in README.md - ([acf2d52](https://github.com/orhun/git-cliff/commit/acf2d52602c008352de9ef98df7bb8d6f19b5222))\n\n### 🎨 Styling\n\n- *(readme)* Update README.md about the styling of footer field - ([47a7345](https://github.com/orhun/git-cliff/commit/47a7345167b78f824c80e41f9f8e2bf9df53d654))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cd)* Remove deprecated set-output usage - ([5187f02](https://github.com/orhun/git-cliff/commit/5187f029ec3d004a0acf7ffacec4621cce3ec1f1))\n- *(ci)* Update actions/checkout to v3 - ([6c37611](https://github.com/orhun/git-cliff/commit/6c37611e162adb71d78203ad7d24d7c7f17774e3))\n- *(config)* Comment out custom commit preprocessor ([#112](https://github.com/orhun/git-cliff/issues/112)) - ([8f77caf](https://github.com/orhun/git-cliff/commit/8f77caf86a1e5dd23eda1b9e9b5a7a6606642b8a))\n- *(fixtures)* Run all test fixtures - ([53c1c50](https://github.com/orhun/git-cliff/commit/53c1c50a1e1a66c684bb1319c0bf48648ed01eab))\n\n\n## [0.10.0](https://github.com/orhun/git-cliff/compare/v0.9.2..v0.10.0) - 2022-11-20\n\n### ⛰️ Features\n\n- *(args)* Add a short variant `-d` for specifying `--date-order` flag - ([5913e24](https://github.com/orhun/git-cliff/commit/5913e24596a32625ce59ca819cbcf3329e7b3b5b))\n- *(changelog)* Do not skip breaking changes if configured ([#114](https://github.com/orhun/git-cliff/issues/114)) - ([1c98995](https://github.com/orhun/git-cliff/commit/1c98995454f2df1e6766d55e026c16e857aa938b))\n- *(config)* Changelog for the last n commits ([#116](https://github.com/orhun/git-cliff/issues/116)) - ([0c7769b](https://github.com/orhun/git-cliff/commit/0c7769b52fe3dee6afd0321c58021cf157acb964))\n\n### 🐛 Bug Fixes\n\n- *(changelog)* Warn against invalid tag range for `--current` flag ([#124](https://github.com/orhun/git-cliff/issues/124)) - ([e73fd9f](https://github.com/orhun/git-cliff/commit/e73fd9f821a5f16ab2581839be17c0c5ade85dc6))\n- *(docker)* Fix syntax error in Dockerfile - ([5f9b2d5](https://github.com/orhun/git-cliff/commit/5f9b2d5d02d75c49d11e930ac80657eabb882140))\n- *(docker)* Use an alternative method to fetch registry - ([876b13b](https://github.com/orhun/git-cliff/commit/876b13b1deea184cb423b82bccec7d6b7bf5bde4))\n\n### 🚜 Refactor\n\n- *(deps)* Utilize workspace dependencies - ([f2def40](https://github.com/orhun/git-cliff/commit/f2def401ba0b2b5aa4092b7167cd334d5bd54cd8))\n- *(docker)* Improve cargo-chef caching in Dockerfile - ([0f38960](https://github.com/orhun/git-cliff/commit/0f38960851ac0fd159727d5dffb36f50268eec18))\n\n### 📚 Documentation\n\n- *(readme)* Update badge URL for Docker builds - ([a8fa7f9](https://github.com/orhun/git-cliff/commit/a8fa7f9fb5e334ff58e9ae371cc2ffb0a873c345))\n- *(readme)* Add MacPorts install info ([#111](https://github.com/orhun/git-cliff/issues/111)) - ([f9d4b88](https://github.com/orhun/git-cliff/commit/f9d4b88a3324a10b918bab8c272a60214bcdcd13))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(docker)* Update versions in Dockerfile - ([02e2b8e](https://github.com/orhun/git-cliff/commit/02e2b8e58e0e4a518fe5318be2bec6d1360ad34e))\n\n## New Contributors ❤️\n\n* @FlrnFrmm made their first contribution in [#116](https://github.com/orhun/git-cliff/pull/116)\n* @sbmueller made their first contribution in [#114](https://github.com/orhun/git-cliff/pull/114)\n* @herbygillot made their first contribution in [#111](https://github.com/orhun/git-cliff/pull/111)\n\n## [0.9.2](https://github.com/orhun/git-cliff/compare/v0.9.1..v0.9.2) - 2022-09-24\n\n### 🐛 Bug Fixes\n\n- *(docker)* Remove custom user creation from the Dockerfile ([#109](https://github.com/orhun/git-cliff/issues/109)) - ([5cb991d](https://github.com/orhun/git-cliff/commit/5cb991d4e3a39dd15ae22b661c23d18ccbd45004))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(audit)* Remove cargo-audit config - ([078bdc3](https://github.com/orhun/git-cliff/commit/078bdc3f7a482e752bb983fad057a37f15528698))\n- *(ci)* Switch to cargo-tarpaulin for measuring code coverage ([#110](https://github.com/orhun/git-cliff/issues/110)) - ([17f3a09](https://github.com/orhun/git-cliff/commit/17f3a0994d85022650170ff3a9fef942aa414303))\n\n\n## [0.9.1](https://github.com/orhun/git-cliff/compare/v0.9.0..v0.9.1) - 2022-09-20\n\n### 🐛 Bug Fixes\n\n- *(docker)* Configure git safe.directory for Docker image ([#108](https://github.com/orhun/git-cliff/issues/108)) - ([4fc2217](https://github.com/orhun/git-cliff/commit/4fc2217868fceea81ab5e6aeeb63ca719a07fe91))\n\n### 🎨 Styling\n\n- *(readme)* Update styling for with-commit example - ([8247301](https://github.com/orhun/git-cliff/commit/82473017ca627a8d736099a928f03cfb56c895dc))\n\n\n## [0.9.0](https://github.com/orhun/git-cliff/compare/v0.8.1..v0.9.0) - 2022-08-16\n\n### ⛰️ Features\n\n- *(changelog)* Support setting commit SHA while using `--with-commit` - ([d453d4c](https://github.com/orhun/git-cliff/commit/d453d4cbebbb607ff7dbe530542802e8ca60b585))\n- *(changelog)* Support splitting commits by lines ([#101](https://github.com/orhun/git-cliff/issues/101)) - ([e3eae33](https://github.com/orhun/git-cliff/commit/e3eae33abcf212e56efcdbb873411e7d8e761b4f))\n- *(commit)* Add commit author and committer to the context ([#100](https://github.com/orhun/git-cliff/issues/100)) - ([940065b](https://github.com/orhun/git-cliff/commit/940065b5754d4db4d6bb24c1ac8c7c5ddba75af0))\n\n### 🚜 Refactor\n\n- *(commit)* Use a more concise conversion for string - ([1b13b97](https://github.com/orhun/git-cliff/commit/1b13b97f7359987e027cfc55dc52b3ea40894d5b))\n\n### 📚 Documentation\n\n- *(readme)* Add test repository link to README.md - ([da484a3](https://github.com/orhun/git-cliff/commit/da484a33644acda9f93f46e48fae2186ce0397e2))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(build)* Enable strip option for release profile - ([f70fefd](https://github.com/orhun/git-cliff/commit/f70fefd88acae2e599880af5a8bcff7710fbe6c1))\n- *(docker)* Upgrade versions in Dockerfile - ([6bb4f5b](https://github.com/orhun/git-cliff/commit/6bb4f5b43e257941191a49756e3388aacb5f4978))\n- *(docker)* Disable updating the description on Docker Hub - ([cd1306c](https://github.com/orhun/git-cliff/commit/cd1306cffdd01cc002c68d0e2297fa5a4589766b))\n- *(docker)* Update the description on Docker Hub on push - ([9c0e7a2](https://github.com/orhun/git-cliff/commit/9c0e7a2ab8c3efdfb1be66ac55fba519b9bbb20c))\n- *(docker)* Enable building arm64 docker images - ([f2968cd](https://github.com/orhun/git-cliff/commit/f2968cdf6ca1bfc9126c07af0894c0b2bd7f9a64))\n- *(docker)* Use an alternative method to fetch registry - ([220d6e6](https://github.com/orhun/git-cliff/commit/220d6e64f4c786f1e4e353e506f98cb9eefb34ec))\n- *(funding)* Add GitHub Sponsors option for funding - ([f3fada7](https://github.com/orhun/git-cliff/commit/f3fada723d680dab4f0cd435dc0430425a7fe995))\n- *(project)* Update MSRV to 1.60.0 - ([b55e678](https://github.com/orhun/git-cliff/commit/b55e678a4ea669e195d0adae0694a340ab724c31))\n\n## New Contributors ❤️\n\n* @AaronFriel made their first contribution in [#101](https://github.com/orhun/git-cliff/pull/101)\n\n## [0.8.1](https://github.com/orhun/git-cliff/compare/v0.8.0..v0.8.1) - 2022-07-12\n\n### 🐛 Bug Fixes\n\n- *(cd)* Set fail-fast strategy to false - ([4b2ded0](https://github.com/orhun/git-cliff/commit/4b2ded0cf17d57b76c505372bebd098256200c5a))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cd)* Update windows runners to windows-2022 - ([8621a59](https://github.com/orhun/git-cliff/commit/8621a59d47b9e13dd449e6c781e847086e501153))\n\n\n## [0.8.0](https://github.com/orhun/git-cliff/compare/v0.7.0..v0.8.0) - 2022-07-12\n\n### ⛰️ Features\n\n- *(changelog)* Support external commands for commit preprocessors ([#86](https://github.com/orhun/git-cliff/issues/86)) - ([7d0786c](https://github.com/orhun/git-cliff/commit/7d0786ca55423950f0779de4e6a907fc25ae203a))\n- *(commit)* [**breaking**] Pass footer token and separator to template ([#97](https://github.com/orhun/git-cliff/issues/97)) - ([0bf499e](https://github.com/orhun/git-cliff/commit/0bf499ec940a22a2bed052db21e89f7fc4b824ba))\n- *(config)* Support changing commit scope with `commit_parsers` ([#94](https://github.com/orhun/git-cliff/issues/94)) - ([e220768](https://github.com/orhun/git-cliff/commit/e22076843b91be3680617db5686e070dedcfef29))\n\n### 🐛 Bug Fixes\n\n- *(ci)* Update lychee arguments to skip checking protonmail - ([a5aaca1](https://github.com/orhun/git-cliff/commit/a5aaca1a01e6e380c35a70bc512cb11d17e4b964))\n\n### 📚 Documentation\n\n- *(readme)* Switch chronological and topological ([#99](https://github.com/orhun/git-cliff/issues/99)) - ([2289199](https://github.com/orhun/git-cliff/commit/22891992a2e7898238b9d4e154bfffc6d84b180f))\n- *(readme)* Clarify that `--tag` argument can be an unexisting tag - ([d540f5d](https://github.com/orhun/git-cliff/commit/d540f5d8938bc84b01b4fafaa69c3290eb72cd08))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(docker)* Disable building arm64 docker images temporarily - ([175f7d7](https://github.com/orhun/git-cliff/commit/175f7d70559c642721c0c82215224cfba2cb0221))\n- *(project)* Set MSRV to 1.58.1 ([#87](https://github.com/orhun/git-cliff/issues/87)) - ([bfcd0d9](https://github.com/orhun/git-cliff/commit/bfcd0d97ba2fc2271e754f6c9ecb834edf7f1190))\n\n## New Contributors ❤️\n\n* @hawkw made their first contribution in [#97](https://github.com/orhun/git-cliff/pull/97)\n* @7596ff made their first contribution in [#99](https://github.com/orhun/git-cliff/pull/99)\n* @ofsahof made their first contribution in [#94](https://github.com/orhun/git-cliff/pull/94)\n\n## [0.7.0](https://github.com/orhun/git-cliff/compare/v0.6.1..v0.7.0) - 2022-04-24\n\n### ⛰️ Features\n\n- *(args)* [**breaking**] Prefix environment variables with `GIT_CLIFF_` ([#76](https://github.com/orhun/git-cliff/issues/76)) - ([84507dd](https://github.com/orhun/git-cliff/commit/84507dd361f4c1ba37bfdb7005714bb817afb6b0))\n- *(args)* Add `--context` flag for outputting context ([#71](https://github.com/orhun/git-cliff/issues/71)) - ([95ad55d](https://github.com/orhun/git-cliff/commit/95ad55d542cb772881f12ae2a25f7e06202c8587))\n- *(cli)* Show a message if a newer version is available ([#69](https://github.com/orhun/git-cliff/issues/69)) - ([720a7c1](https://github.com/orhun/git-cliff/commit/720a7c1ec2cde510733d119b7b3b8a938ff945ff))\n- *(config)* Support placing configuration inside Cargo.toml ([#46](https://github.com/orhun/git-cliff/issues/46)) - ([f48d207](https://github.com/orhun/git-cliff/commit/f48d2077c33b878337edc2e5fe8a97be990b4773))\n- *(git)* Support preprocessing commit messages using regex ([#62](https://github.com/orhun/git-cliff/issues/62)) - ([64317f2](https://github.com/orhun/git-cliff/commit/64317f21168a9e9aa088befbd2841632f72e13a3))\n- *(log)* Print more debug information when `-vv` is used ([#79](https://github.com/orhun/git-cliff/issues/79)) - ([a8efffc](https://github.com/orhun/git-cliff/commit/a8efffc7d57691999583a5a13bfd5d0e48aca095))\n- *(man)* Add man page generation script ([#35](https://github.com/orhun/git-cliff/issues/35)) - ([03d55c8](https://github.com/orhun/git-cliff/commit/03d55c8eb1483fa783ea724b12bdd209fc2eaca2))\n\n### 🐛 Bug Fixes\n\n- *(build)* Pin the Rust nightly version - ([97c3044](https://github.com/orhun/git-cliff/commit/97c30449a1b7f9a551c5c57fc7518027aaf52f3b))\n- *(changelog)* Allow custom commit range while prepending ([#68](https://github.com/orhun/git-cliff/issues/68)) - ([1bacc7f](https://github.com/orhun/git-cliff/commit/1bacc7f194f70fea5378d2609dd72e64eb62bdfb))\n- *(ci)* Pin the Rust nightly version - ([1b04dbf](https://github.com/orhun/git-cliff/commit/1b04dbf1a8760281babcf699c0126063c131d6fe))\n- *(fixtures)* Update expected changelog date - ([2b484f0](https://github.com/orhun/git-cliff/commit/2b484f078cb0c5236aa10fbb8c375e5b368ec0a1))\n- *(log)* Remove redundant logging while using `--context` ([#71](https://github.com/orhun/git-cliff/issues/71)) - ([efd40e0](https://github.com/orhun/git-cliff/commit/efd40e02b3c7be29da6e2a161423b92a74c4f46e))\n\n### 🚜 Refactor\n\n- *(cli)* Make update-informer opt-out via feature flag ([#69](https://github.com/orhun/git-cliff/issues/69)) - ([cddb4d4](https://github.com/orhun/git-cliff/commit/cddb4d49fb03191208bc61d00cbaafde62ad8f92))\n- *(completions)* Use implicit Result type in completions script - ([fa2639a](https://github.com/orhun/git-cliff/commit/fa2639aafe6082d937534d77f8ae3268f718b722))\n\n### 📚 Documentation\n\n- *(readme)* Update the title of projects section - ([4f4a82c](https://github.com/orhun/git-cliff/commit/4f4a82cbe3d7e03058a77f7757cf138716353b2a))\n- *(readme)* Add `cliff-jumper` to similar projects ([#83](https://github.com/orhun/git-cliff/issues/83)) - ([2a21890](https://github.com/orhun/git-cliff/commit/2a218902d3d42ea233d8cf087944b575d05399c3))\n- *(readme)* Update GitHub Actions reference link in README.md - ([9801963](https://github.com/orhun/git-cliff/commit/980196357bbf41c4b7596b81237ce36051196b6f))\n- *(readme)* Add more regex examples for commit_preprocessors - ([9b83518](https://github.com/orhun/git-cliff/commit/9b83518a59cb8275f58f6076bd5ff23be606df2a))\n\n### 🎨 Styling\n\n- *(release)* Update the changelog template for tag message - ([72544b1](https://github.com/orhun/git-cliff/commit/72544b18073295362174200189a0f4e165c6d296))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cd)* Include man page in the release assets - ([a5ddf75](https://github.com/orhun/git-cliff/commit/a5ddf75152764bce42b9b5484989aea227d175b2))\n- *(ci)* Return to nightly builds ([#73](https://github.com/orhun/git-cliff/issues/73)) - ([312b654](https://github.com/orhun/git-cliff/commit/312b654b07f000f49a7d1a3d1b9b4649c37842fe))\n- *(docker)* Strip the binaries in Docker image - ([aca4ccf](https://github.com/orhun/git-cliff/commit/aca4ccfb7ff8c47bbe3c16203ef617dde94d3ad5))\n- *(docker)* Disable default features for the Docker image - ([e6fb20d](https://github.com/orhun/git-cliff/commit/e6fb20d11c50c2989abecd27b7fb325d9d3ac490))\n- *(docker)* Build Docker images for arm64 - ([8475e1f](https://github.com/orhun/git-cliff/commit/8475e1fd63b89bb56c2cf68de62dbb4d9e66b4bb))\n- *(docker)* Upgrade versions in Dockerfile - ([3aa9a1a](https://github.com/orhun/git-cliff/commit/3aa9a1a059f876b66ce03bc1a4a7735a2c27e146))\n\n## New Contributors ❤️\n\n* @favna made their first contribution in [#83](https://github.com/orhun/git-cliff/pull/83)\n* @kaushalmodi made their first contribution in [#80](https://github.com/orhun/git-cliff/pull/80)\n* @uyha made their first contribution in [#76](https://github.com/orhun/git-cliff/pull/76)\n* @mgrachev made their first contribution in [#73](https://github.com/orhun/git-cliff/pull/73)\n\n## [0.6.1](https://github.com/orhun/git-cliff/compare/v0.6.0..v0.6.1) - 2022-03-13\n\n### 🐛 Bug Fixes\n\n- *(changelog)* Use root commit when --latest and there is only one tag ([#59](https://github.com/orhun/git-cliff/issues/59)) - ([3ccec7f](https://github.com/orhun/git-cliff/commit/3ccec7f93a917a4feaa5baf17b604fe3de76b0e1))\n- *(changelog)* Do not skip all tags when `skip_tags` is empty ([#63](https://github.com/orhun/git-cliff/issues/63)) - ([ff1d981](https://github.com/orhun/git-cliff/commit/ff1d981fd9a5dba26422f56582e06b3b463eb8a3))\n- *(example)* Fix `keepachangelog` config example ([#66](https://github.com/orhun/git-cliff/issues/66)) - ([9b5f0bb](https://github.com/orhun/git-cliff/commit/9b5f0bb5fdadf15cccb738f1bb96937be058795e))\n- *(project)* Use the correct branch for codecov ([#65](https://github.com/orhun/git-cliff/issues/65)) - ([8f3325e](https://github.com/orhun/git-cliff/commit/8f3325e758d25d814c5c9831d128907696a12536))\n\n### 📚 Documentation\n\n- *(core)* Document timestamp format of `Release` struct ([#67](https://github.com/orhun/git-cliff/issues/67)) - ([d68eb12](https://github.com/orhun/git-cliff/commit/d68eb120c0a0a98bc1e7264a3aede17b5f5c54be))\n- *(readme)* Add another option of GitHub Actions ([#64](https://github.com/orhun/git-cliff/issues/64)) - ([db7edf5](https://github.com/orhun/git-cliff/commit/db7edf5707f2bfdf49c749026969fd1833530ed7))\n\n## New Contributors ❤️\n\n* @marcoieni made their first contribution in [#67](https://github.com/orhun/git-cliff/pull/67)\n\n## [0.6.0](https://github.com/orhun/git-cliff/compare/v0.5.0..v0.6.0) - 2022-02-12\n\n### ⛰️ Features\n\n- *(changelog)* [**breaking**] Use conventional commit body to check against commit parsers - ([e1da611](https://github.com/orhun/git-cliff/commit/e1da61150f07f641dfe471e240033e13cc19d089))\n- *(changelog)* Add `link_parsers` for parsing/extracting links ([#42](https://github.com/orhun/git-cliff/issues/42)) - ([b88e7d3](https://github.com/orhun/git-cliff/commit/b88e7d30bee74667028602fed1337ceb24829145))\n- *(changelog, config)* [**breaking**] Replace --topo-order by --date-order ([#58](https://github.com/orhun/git-cliff/issues/58)) - ([a3980f4](https://github.com/orhun/git-cliff/commit/a3980f4632cea95d939c044ef5687123f5b91546))\n- *(config)* Make the `changelog` section optional ([#45](https://github.com/orhun/git-cliff/issues/45)) - ([e02ae0b](https://github.com/orhun/git-cliff/commit/e02ae0b3661b3379175a10cb273a9c7744747765))\n- *(config)* Make the `git` section optional ([#45](https://github.com/orhun/git-cliff/issues/45)) - ([8202e37](https://github.com/orhun/git-cliff/commit/8202e37dbd5dd98b3f9de8470e41776b5afb1b51))\n\n### 🐛 Bug Fixes\n\n- *(changelog)* Set the previous release when using `--unreleased` ([#47](https://github.com/orhun/git-cliff/issues/47)) - ([2be04f8](https://github.com/orhun/git-cliff/commit/2be04f8b2214513d08d349b254a97a8c783073fb))\n- *(changelog)* Only drop previous releases if skipped ([#44](https://github.com/orhun/git-cliff/issues/44)) - ([943c23f](https://github.com/orhun/git-cliff/commit/943c23fd350eea1154deb2e294257c22d2bc76e5))\n- *(ci)* Update grcov download command - ([5bfb454](https://github.com/orhun/git-cliff/commit/5bfb45411da940eb7d0df874558b31b50911bb59))\n- *(ci)* Use the correct tar command for extracting grcov archive - ([a3f3aa6](https://github.com/orhun/git-cliff/commit/a3f3aa6405846419fabeafab5fea204ec0e4be9b))\n- *(ci)* Update the download link of latest grcov release - ([c47133a](https://github.com/orhun/git-cliff/commit/c47133ac2423f7581b711fa97f1b30094907a3c2))\n- *(ci)* Run clippy from nightly toolchain - ([7d766d7](https://github.com/orhun/git-cliff/commit/7d766d7e34726faf69f91a3941f1470356e4dda5))\n- *(config)* Lower the priority of global configuration file ([#51](https://github.com/orhun/git-cliff/issues/51)) - ([2595952](https://github.com/orhun/git-cliff/commit/25959529d60340caac668e0dd3e5c5b105ab4290))\n- *(test)* Update tests about optional config values - ([8bb48b0](https://github.com/orhun/git-cliff/commit/8bb48b09ef4488e4fb6b03a43e1d862b4645971b))\n- *(tests)* Update custom error tests - ([58165c7](https://github.com/orhun/git-cliff/commit/58165c730e4ef370a448001193d90ff29a57449d))\n\n### 🚜 Refactor\n\n- *(config)* [**breaking**] Change the default value of `trim` to `true` - ([3b3ef7e](https://github.com/orhun/git-cliff/commit/3b3ef7e4d8d2cb680419e7175bc948b895c7de24))\n- *(lib)* Unify serde and serde_derive using derive feature ([#57](https://github.com/orhun/git-cliff/issues/57)) - ([bedabc9](https://github.com/orhun/git-cliff/commit/bedabc93ddc30be69d27cbb42b23d3ff68e96f95))\n\n### 📚 Documentation\n\n- *(config)* Add minimal example - ([848d8a5](https://github.com/orhun/git-cliff/commit/848d8a587efd5f611a98b647b954c06938fac24a))\n- *(readme)* Update copyright years - ([0a3c56c](https://github.com/orhun/git-cliff/commit/0a3c56c7ecdf01133d0e857269076052febadd91))\n- *(readme)* Update template contexts about link_parsers - ([dce09d7](https://github.com/orhun/git-cliff/commit/dce09d71a05f5d1e1d8939d688d19c4740ba6a93))\n\n### 🎨 Styling\n\n- *(changelog)* Comply with MD022 and fix minor typos ([#61](https://github.com/orhun/git-cliff/issues/61)) - ([0293b28](https://github.com/orhun/git-cliff/commit/0293b281090f74a5855678acbb3dc9a259ba7126))\n- *(readme)* Update the styling - ([dcb3141](https://github.com/orhun/git-cliff/commit/dcb3141ac969c52009f3f13314da65f1cf0e2604))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(args)* Update arg parsing to clap v3 ([#49](https://github.com/orhun/git-cliff/issues/49)) - ([d961b53](https://github.com/orhun/git-cliff/commit/d961b53ba5ceb99adccfc5df3909c96cda682341))\n- *(cd)* Update the runner to macos-11 - ([960cb4a](https://github.com/orhun/git-cliff/commit/960cb4ac6f4ffb0398a39c36637f53c1307d44ab))\n- *(ci)* Run cargo-audit for checking vulnerabilities - ([cfe41fe](https://github.com/orhun/git-cliff/commit/cfe41fe56eddb38c109e178e02d3567d10ad78ff))\n- *(docker)* Bump the Rust version in Dockerfile - ([d4cbb85](https://github.com/orhun/git-cliff/commit/d4cbb857388f8d5686715fcba62f8adaeb92230a))\n\n## New Contributors ❤️\n\n* @tranzystorekk made their first contribution in [#57](https://github.com/orhun/git-cliff/pull/57)\n* @bachp made their first contribution in [#42](https://github.com/orhun/git-cliff/pull/42)\n\n## [0.5.0](https://github.com/orhun/git-cliff/compare/v0.4.2..v0.5.0) - 2021-12-15\n\n### ⛰️ Features\n\n- *(args)* Add `--with-commit` argument for including custom commit messages in changelog - ([e4c60b2](https://github.com/orhun/git-cliff/commit/e4c60b20be8b7f1fa19429b1b1f984dc4caf9340))\n- *(args)* Add `--current` flag for processing the current tag ([#37](https://github.com/orhun/git-cliff/issues/37)) - ([02a6187](https://github.com/orhun/git-cliff/commit/02a6187a58583f27e4604d7ea518b52b4bc7a833))\n- *(args)* Add `--exclude-path` argument for excluding related commits - ([25a1d49](https://github.com/orhun/git-cliff/commit/25a1d49c0993685d8bf95225e81ee7d614131115))\n- *(args)* Support multiple values for `--commit-path` argument - ([edb343a](https://github.com/orhun/git-cliff/commit/edb343a10e76a33b7223aa36d37df350d4ac6df1))\n- *(args)* Accept glob patterns for `--commit-path` argument - ([ad11cbf](https://github.com/orhun/git-cliff/commit/ad11cbf6c528e1cf80075d986658774be3fabff7))\n- *(changelog)* Support having both conventional and unconventional commits in the changelog - ([8445313](https://github.com/orhun/git-cliff/commit/8445313b13f6f087f79ea73bc1c12b0340a87d92))\n- *(changelog)* Add `--topo-order` flag for sorting tags ([#29](https://github.com/orhun/git-cliff/issues/29)) - ([cc09d63](https://github.com/orhun/git-cliff/commit/cc09d637ff4edfcba625e469dcd3eb0062ac2a4f))\n- *(config)* Add `ignore_tags` option ([#40](https://github.com/orhun/git-cliff/issues/40)) - ([de11cce](https://github.com/orhun/git-cliff/commit/de11ccecac10de6069d7a1ba0a1013582fc8bd25))\n- *(config)* Support specifying the sorting methods in config ([#31](https://github.com/orhun/git-cliff/issues/31)) - ([4eb334d](https://github.com/orhun/git-cliff/commit/4eb334da06c1bde3b53d95ea50d086daab07e4bb))\n- *(template)* Use more explanatory error messages about templates - ([1a9c3e3](https://github.com/orhun/git-cliff/commit/1a9c3e310f1b7ae8de6f5d62bd2095afd616c463))\n\n### 🐛 Bug Fixes\n\n- *(args)* Override the sort related config if args are present ([#39](https://github.com/orhun/git-cliff/issues/39)) - ([ef63727](https://github.com/orhun/git-cliff/commit/ef63727b5f0a5aba7024e2afe5dc24a1b218d978))\n- *(changelog)* Drop the skipped releases from 'previous' field - ([7f867ae](https://github.com/orhun/git-cliff/commit/7f867ae647ff30f54aae314596cbc7c7ce4f50c1))\n- *(fixtures)* Strip the carriage return on fixtures while comparing - ([d7e8ce2](https://github.com/orhun/git-cliff/commit/d7e8ce25286a2dc1ce5d134df871cdc07f4a9211))\n- *(fixtures)* Update the multi line docker command - ([c8d288c](https://github.com/orhun/git-cliff/commit/c8d288c4c8dafd011b2d324d3ba3052b0fe11794))\n- *(fixtures)* Use the defined configuration file for fixtures - ([bbc58d7](https://github.com/orhun/git-cliff/commit/bbc58d7bd01091b71c38323ba71cc07b97285c19))\n- *(fixtures)* Checkout the repository before running fixtures - ([cb412a9](https://github.com/orhun/git-cliff/commit/cb412a905f7121bb3277de1086fb48f34bbb7319))\n- *(tests)* Update log test about exclude path - ([9d213f5](https://github.com/orhun/git-cliff/commit/9d213f5713af3a27e1026d275be1676a739d6c3a))\n\n### 🚜 Refactor\n\n- *(config)* Rename the config value for commit order - ([6cec37d](https://github.com/orhun/git-cliff/commit/6cec37d1ecb23507f0bf47cd7fe942368faca92d))\n\n### 📚 Documentation\n\n- *(readme)* Update `--with-commit` example in README.md - ([47d124a](https://github.com/orhun/git-cliff/commit/47d124add2669e541d992aba83759dc31cd9d18d))\n\n### 🎨 Styling\n\n- *(args)* [**breaking**] Rename `--commit-path` argument to `--include-path` - ([7b000ad](https://github.com/orhun/git-cliff/commit/7b000ad43ef5d25941057b38bb6747f9f1514b17))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(config)* Indicate the breaking changes via default config - ([316c11b](https://github.com/orhun/git-cliff/commit/316c11b60756f8b38174433450d42f25919368b7))\n- *(fixtures)* Run test fixtures on ubuntu-latest - ([dea65f2](https://github.com/orhun/git-cliff/commit/dea65f235e2091001d8de41794bf3c98a7223917))\n- *(fixtures)* Improve the workflow for test fixtures - ([92a54d6](https://github.com/orhun/git-cliff/commit/92a54d67b825b53b6993a769ea9d5cf37ea2e43e))\n\n## New Contributors ❤️\n\n* @kenji-miyake made their first contribution in [#40](https://github.com/orhun/git-cliff/pull/40)\n\n## [0.4.2](https://github.com/orhun/git-cliff/compare/v0.4.1..v0.4.2) - 2021-10-22\n\n### 🐛 Bug Fixes\n\n- *(cd)* Install the Rust toolchain explicitly for crates.io releases - ([2cee3bf](https://github.com/orhun/git-cliff/commit/2cee3bf9ecc00e21b871e88a34a949fbca6b646b))\n\n\n## [0.4.1](https://github.com/orhun/git-cliff/compare/v0.4.0..v0.4.1) - 2021-10-22\n\n### 🐛 Bug Fixes\n\n- *(changelog)* Add support for special characters in scopes ([#26](https://github.com/orhun/git-cliff/issues/26)) - ([10771f4](https://github.com/orhun/git-cliff/commit/10771f43c0f252dec9ad414b780bb22d866d00e2))\n\n### 🚜 Refactor\n\n- *(git)* Use a better error message for invalid repo path - ([f447cc2](https://github.com/orhun/git-cliff/commit/f447cc2e73ea707c2f4694507e9c7847fcff29e9))\n\n### 📚 Documentation\n\n- *(readme)* Update GitLab CI/CD section - ([2925340](https://github.com/orhun/git-cliff/commit/2925340368da5c74104f7c9befa47ee27f49c02d))\n- *(readme)* Add GitLab CI/CD section to README.md ([#24](https://github.com/orhun/git-cliff/issues/24)) - ([90a87c5](https://github.com/orhun/git-cliff/commit/90a87c58741b3cdeee87a3c162cd10ddef59adaf))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(ci)* Run CI workflows periodically - ([627d4ef](https://github.com/orhun/git-cliff/commit/627d4eff7f6e4da9ea942ac05c6743a4153f4cc2))\n- *(docker)* Bump the Rust version in Dockerfile - ([fc33efd](https://github.com/orhun/git-cliff/commit/fc33efde85fb6c3a8c82c37e795b598706aea609))\n- *(project)* Migrate to Rust 2021 edition - ([0000000](https://github.com/orhun/git-cliff/commit/0000000ef0e2d0710f4c1294408da2639f6f3217))\n- *(project)* Remove unnecessary Cargo.lock entry from .gitignore - ([481713c](https://github.com/orhun/git-cliff/commit/481713cbb74fc2bce4a46ab6f8d4649b03d96fc2))\n\n## New Contributors ❤️\n\n* @pataar made their first contribution in [#26](https://github.com/orhun/git-cliff/pull/26)\n* @alteregoart made their first contribution in [#24](https://github.com/orhun/git-cliff/pull/24)\n\n## [0.4.0](https://github.com/orhun/git-cliff/compare/v0.3.0..v0.4.0) - 2021-10-01\n\n### ⛰️ Features\n\n- *(changelog)* Add `--sort` argument for sorting commits ([#15](https://github.com/orhun/git-cliff/issues/15)) - ([2950a41](https://github.com/orhun/git-cliff/commit/2950a412c2aaa0d96609753129047cef39fd3e1c))\n\n### 🐛 Bug Fixes\n\n- *(ci)* Update lychee arguments to skip checking files - ([ba3f1ca](https://github.com/orhun/git-cliff/commit/ba3f1cac50338672c555581659e098e11796f466))\n- *(config)* Remove only the leading \"v\" from tags ([#18](https://github.com/orhun/git-cliff/issues/18)) - ([e444615](https://github.com/orhun/git-cliff/commit/e444615c02749da5fc64ae3286bfde1b616e7271))\n- *(docker)* Remove tags from the base image names - ([ece0481](https://github.com/orhun/git-cliff/commit/ece0481e73e63371dab87ec6a71da59999db7d47))\n\n### 📚 Documentation\n\n- *(config)* Add scope-sorted example ([#16](https://github.com/orhun/git-cliff/issues/16)) - ([05584b6](https://github.com/orhun/git-cliff/commit/05584b614aa593558674243cfbf14dafe7b6b8db))\n- *(readme)* Add \"build from source\" section to README.md - ([b193f42](https://github.com/orhun/git-cliff/commit/b193f42e258e8fdee8b1b645d5a614d606f7e079))\n- *(readme)* Mention the signing key for binary releases ([#17](https://github.com/orhun/git-cliff/issues/17)) - ([9022af5](https://github.com/orhun/git-cliff/commit/9022af533d3d967a09352a1bdf542f8ba97e9930))\n- *(readme)* Add packaging status badge to installation section - ([5409e06](https://github.com/orhun/git-cliff/commit/5409e06e4cf3b6833ba3a9b1eb224014280069dd))\n- *(readme)* Add raw/rendered output for scoped-sorted example - ([f64459d](https://github.com/orhun/git-cliff/commit/f64459dd9f6030697e51903f91136fa857332425))\n\n### 🎨 Styling\n\n- *(config)* Fix the newline issues in scoped-sorted example - ([428d407](https://github.com/orhun/git-cliff/commit/428d407df581dd00e26b320c3872eb21cfc8c803))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(docker)* Use docker.yml workflow for CI/CD - ([7756266](https://github.com/orhun/git-cliff/commit/7756266b17f3c3ba55f5d00f8e55aea0a3a68ef2))\n- *(docker)* Use explicit image name for docker automated builds - ([777375f](https://github.com/orhun/git-cliff/commit/777375f67703b2833509700273cb0bec9a659525))\n- *(docker)* Specify the latest tag explicitly - ([6bafc5d](https://github.com/orhun/git-cliff/commit/6bafc5d1a124dea5423338afd75a5136944bebb5))\n- *(docker)* Rename the GHCR package due to legacy reasons - ([71b8846](https://github.com/orhun/git-cliff/commit/71b88466ebd37b2bf5f0489afed117417ad20b24))\n- *(docker)* Extend the tags for docker meta - ([dff2e62](https://github.com/orhun/git-cliff/commit/dff2e62edc3886346375a2451faabe5e8cf679f9))\n- *(docker)* Use docker meta for tagging for GHCR - ([081b2d2](https://github.com/orhun/git-cliff/commit/081b2d257ba853c1d31d35ebfeae1cb92a641746))\n- *(docker)* Use cache for docker builds - ([d3140ed](https://github.com/orhun/git-cliff/commit/d3140ed9882b6df8c07196c8f68bae67ab8da684))\n- *(workflow)* Update the runner to ubuntu-20.04 - ([5069594](https://github.com/orhun/git-cliff/commit/5069594f1800e409665609224995b25dcb9df438))\n- *(workflow)* Set a version for the checkout action - ([b323e60](https://github.com/orhun/git-cliff/commit/b323e60996595976fbe8261b5f8c4a9f67d2a8f8))\n\n## New Contributors ❤️\n\n* @FoxxMD made their first contribution in [#16](https://github.com/orhun/git-cliff/pull/16)\n\n## [0.3.0](https://github.com/orhun/git-cliff/compare/v0.2.6..v0.3.0) - 2021-09-10\n\n### ⛰️ Features\n\n- *(changelog)* Support generating a changelog scoped to a directory ([#11](https://github.com/orhun/git-cliff/issues/11)) - ([0bb7c91](https://github.com/orhun/git-cliff/commit/0bb7c910b45436cbf69b444ccb29a530ede4aea0))\n- *(changelog)* Support parsing the missing scopes with `default_scope` ([#8](https://github.com/orhun/git-cliff/issues/8)) - ([b5df656](https://github.com/orhun/git-cliff/commit/b5df656e61035f6230f2613f3dba6a92f88708cd))\n\n### 🐛 Bug Fixes\n\n- *(config)* Fix default regexes and references in docs ([#7](https://github.com/orhun/git-cliff/issues/7)) - ([8a18e4d](https://github.com/orhun/git-cliff/commit/8a18e4d48debbe522cefa9acd662bcc9a825c74e))\n\n### 📚 Documentation\n\n- *(config)* Update the default regex in scoped config example - ([0d793ad](https://github.com/orhun/git-cliff/commit/0d793ad9db43f0290ff6286f6aa1a618feb714ea))\n- *(readme)* Update example regexes - ([f420a5a](https://github.com/orhun/git-cliff/commit/f420a5ac6cf56f3167cac23d40b43ec9aa370005))\n- *(readme)* Add badge for joining the Matrix chat - ([b5edfc2](https://github.com/orhun/git-cliff/commit/b5edfc279d0290fecaacab469ecccdadf63eb3ab))\n- *(readme)* Update installation instructions for Arch Linux - ([8fb18b7](https://github.com/orhun/git-cliff/commit/8fb18b784808222fdf3c4328ac9c871b93524fee))\n\n## New Contributors ❤️\n\n* @Groxx made their first contribution in [#7](https://github.com/orhun/git-cliff/pull/7)\n\n## [0.2.6](https://github.com/orhun/git-cliff/compare/v0.2.5..v0.2.6) - 2021-09-04\n\n### 🐛 Bug Fixes\n\n- *(docker)* Pin the cargo-chef version in Dockerfile - ([af1851c](https://github.com/orhun/git-cliff/commit/af1851c0111d66ec3dd190baf7a456bcf44fdcdc))\n\n### 📚 Documentation\n\n- *(readme)* Update docker commands to only mount the .git directory - ([4398828](https://github.com/orhun/git-cliff/commit/4398828df7b3710550adee8ec09a34a59783265b))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(docker)* Bump cargo-chef version in Dockerfile - ([612192b](https://github.com/orhun/git-cliff/commit/612192b3aa638be9ccd38ecda27bdee6b6ff6655))\n\n\n## [0.2.5](https://github.com/orhun/git-cliff/compare/v0.2.4..v0.2.5) - 2021-08-20\n\n### ⛰️ Features\n\n- *(template)* Add `breaking_description` to the template context ([#4](https://github.com/orhun/git-cliff/issues/4)) - ([e0f6ca1](https://github.com/orhun/git-cliff/commit/e0f6ca151af1b0561cfcc4b757e430923f3d81b5))\n\n### 📚 Documentation\n\n- *(readme)* Update template examples to mention how to contribute - ([4c6e64b](https://github.com/orhun/git-cliff/commit/4c6e64bd13badf6bff55d608fcff4a06585f226c))\n- *(readme)* Mention breaking changes for templating - ([6fa5d28](https://github.com/orhun/git-cliff/commit/6fa5d288d35c9f4218e33631b942bdd0cc381d3c))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(release)* Show the committed changes before creating a tag - ([59ffe53](https://github.com/orhun/git-cliff/commit/59ffe53a7cb4791e4877a74f2e14d15139d2aca9))\n\n\n## [0.2.4](https://github.com/orhun/git-cliff/compare/v0.2.3..v0.2.4) - 2021-08-20\n\n### 🐛 Bug Fixes\n\n- *(cd)* Change the config file location for crates.io release - ([a9b286c](https://github.com/orhun/git-cliff/commit/a9b286cf023148da0800c2a0408d87571c239847))\n\n\n## [0.2.3](https://github.com/orhun/git-cliff/compare/v0.2.2..v0.2.3) - 2021-08-18\n\n### 🐛 Bug Fixes\n\n- *(cd)* Fetch the dependencies before copying the file to embed - ([9e29c95](https://github.com/orhun/git-cliff/commit/9e29c95319abd1747fbf6fd1e205d414617b0447))\n\n\n## [0.2.2](https://github.com/orhun/git-cliff/compare/v0.2.1..v0.2.2) - 2021-08-18\n\n### 🐛 Bug Fixes\n\n- *(cd)* Copy the config file into registry to resolve it for embed - ([48ea157](https://github.com/orhun/git-cliff/commit/48ea1578b5ecc17f5cc9a4249fb7b38610028fc6))\n\n\n## [0.2.1](https://github.com/orhun/git-cliff/compare/v0.2.0..v0.2.1) - 2021-08-18\n\n### 🐛 Bug Fixes\n\n- *(cd)* Copy the configuration file to embed into package - ([68dda36](https://github.com/orhun/git-cliff/commit/68dda364278870df84891495a3ff546ddbcae6a1))\n\n\n## [0.2.0](https://github.com/orhun/git-cliff/compare/v0.1.2..v0.2.0) - 2021-08-18\n\n### ⛰️ Features\n\n- *(config)* Support a global location for configuration file ([#2](https://github.com/orhun/git-cliff/issues/2)) - ([210b634](https://github.com/orhun/git-cliff/commit/210b6341137016b902b20736f76c358e47d53c97))\n- *(config)* Add `--init` flag for creating the default config - ([183481b](https://github.com/orhun/git-cliff/commit/183481bac374707fbb7c579e2df83296e27f7251))\n- *(config)* Embed the default configuration file into the binary - ([e5148e3](https://github.com/orhun/git-cliff/commit/e5148e3ae1f6d459c0faeba6b6a78cf221f6f7ff))\n\n### 🐛 Bug Fixes\n\n- *(config)* Use custom error type for UTF-8 errors - ([45889c0](https://github.com/orhun/git-cliff/commit/45889c0a05ad64598d4e6b053bc0d90ff5449b51))\n\n### 🚜 Refactor\n\n- *(lib)* Update the log message for unprocessed tags - ([6f154ce](https://github.com/orhun/git-cliff/commit/6f154ce4eef33e5d36e07a6c78878eb01ebc024f))\n- *(lib)* Create a constant for default configuration file - ([c478f2c](https://github.com/orhun/git-cliff/commit/c478f2c6167c53a814810eb65ab96084f020d928))\n\n### 📚 Documentation\n\n- *(changelog)* Update the doc comment of `prepend` - ([e7ae5a0](https://github.com/orhun/git-cliff/commit/e7ae5a062d3c446c6a0bc7d2784c52b63485259f))\n\n### 🎨 Styling\n\n- *(args)* Update the message of `--init` flag - ([927776b](https://github.com/orhun/git-cliff/commit/927776b9db06ff2de8555b57c862c4a9e4991469))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(config)* Move `cliff.toml` to config/ - ([acda195](https://github.com/orhun/git-cliff/commit/acda1954dc192a3b706c21a48821f75e5a8e0d22))\n\n\n## [0.1.2](https://github.com/orhun/git-cliff/compare/v0.1.1..v0.1.2) - 2021-08-14\n\n### 🐛 Bug Fixes\n\n- *(cd)* Use the correct name of completions binary - ([3ae64f4](https://github.com/orhun/git-cliff/commit/3ae64f4dd01f05a7896821c55642b8cac6e59bec))\n\n### 📚 Documentation\n\n- *(completions)* Update the example completion command - ([f1fd88a](https://github.com/orhun/git-cliff/commit/f1fd88af8f7fdfb021109ed9a24bd3d43045d534))\n\n\n## [0.1.1](https://github.com/orhun/git-cliff/compare/v0.1.0..v0.1.1) - 2021-08-14\n\n### 🐛 Bug Fixes\n\n- *(changelog)* Set the previous release when using `--latest` ([#3](https://github.com/orhun/git-cliff/issues/3)) - ([29db41a](https://github.com/orhun/git-cliff/commit/29db41aa12332f14a421109fe8d6d09b549abd61))\n\n### 📚 Documentation\n\n- *(readme)* Add installation instructions for the AUR - ([f1b495d](https://github.com/orhun/git-cliff/commit/f1b495d7b1aeb016911150faa0d49f847cc7b17c))\n\n### ⚡ Performance\n\n- *(changelog)* Optimize the release vector size - ([7e84797](https://github.com/orhun/git-cliff/commit/7e84797900f1b6f61e16d8a4766b8209673a7acb))\n- *(changelog)* Process only the last 'previous' release - ([f859747](https://github.com/orhun/git-cliff/commit/f85974761be11e0ecc85575bc4b6d5a02e438fd2))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(project)* Rename the shell completions binary - ([718f535](https://github.com/orhun/git-cliff/commit/718f53573b9f48a60ad1930cd9555063414f8b96))\n\n\n## [0.1.0] - 2021-08-12\n\n### ⛰️ Features\n\n- *(args)* Add `--output` argument - ([e0cda23](https://github.com/orhun/git-cliff/commit/e0cda238105e0ce22ac71409d6e3ee0e32a6bad7))\n- *(args)* Add `--workdir` argument - ([de439be](https://github.com/orhun/git-cliff/commit/de439bef01e0e1209b8517ce7b241bb0db2cb530))\n- *(changelog)* Support setting the body template via args - ([9fc08f4](https://github.com/orhun/git-cliff/commit/9fc08f4c50160374298bf77701ee5e299fa435a0))\n- *(logs)* Show the processed commit message - ([45dccf7](https://github.com/orhun/git-cliff/commit/45dccf74a4a5449d92d453d21b6566acd8f30ebe))\n\n### 🐛 Bug Fixes\n\n- *(cd)* Wait for core library to update on crates.io before publish - ([e795460](https://github.com/orhun/git-cliff/commit/e795460c9bb7275294d1fa53a9d73258fb51eb10))\n- *(cd)* Wait between publishing crates - ([777b3e5](https://github.com/orhun/git-cliff/commit/777b3e573f20e913a68293eb155076d52914b4d4))\n- *(cd)* Generate changelog on a dedicated/different job - ([2f16dd5](https://github.com/orhun/git-cliff/commit/2f16dd5ae7f4bbff7b9944db039192d8ce148655))\n- *(cd)* Fix the syntax of publish step arguments - ([6414789](https://github.com/orhun/git-cliff/commit/6414789067780d0551292c004a8aaff04483906d))\n- *(cd)* Use a separate step for setting the changelog body - ([f038054](https://github.com/orhun/git-cliff/commit/f038054417f608b5792b89f60b4d384b74b317dd))\n- *(cd)* Publish the cargo workspace members separately - ([acc1d34](https://github.com/orhun/git-cliff/commit/acc1d3453ca865ddbf3e8e786fcc157c8e31eae6))\n- *(cd)* Strip the changelog header before escaping - ([6b97c2d](https://github.com/orhun/git-cliff/commit/6b97c2d18c05fb9cf27088a39b24d12ab1b0c556))\n- *(cd)* Use printf to prevent field splitting the variable - ([92a4b0d](https://github.com/orhun/git-cliff/commit/92a4b0d5bfb8c27627886005d0e6d823a3cc6476))\n- *(cd)* Double quote the environment variable - ([85aa1cd](https://github.com/orhun/git-cliff/commit/85aa1cdc688b74d1d2df46dc61e6aa5561fc6ace))\n- *(changelog)* Return error if there is not a latest tag to process - ([8232111](https://github.com/orhun/git-cliff/commit/8232111aa1fab0089fdb3b025202729b59dcf906))\n- *(changelog)* Use footers field as an array for the context - ([3e5c23d](https://github.com/orhun/git-cliff/commit/3e5c23d342ef96bececf41254cb609025a012fb3))\n- *(ci)* Update lychee arguments to exclude invalid links - ([e1d604c](https://github.com/orhun/git-cliff/commit/e1d604cbdf049f30c33380c591bfedf0baa3f0a7))\n- *(config)* Update the environment variable parsing settings - ([9984abf](https://github.com/orhun/git-cliff/commit/9984abfe04e6bed0745b52701ce3f45dd92529f6))\n- *(config)* Update config to skip release commits - ([2e5f30a](https://github.com/orhun/git-cliff/commit/2e5f30a5c3b920dc2b52fe12774fccb2fb3fd124))\n- *(config)* Update commit parsers to match the commit type - ([24b9068](https://github.com/orhun/git-cliff/commit/24b9068d308b9818fab8fd631120a79e4069521d))\n- *(example)* Remove symbolic link - ([ed010be](https://github.com/orhun/git-cliff/commit/ed010be74fb745a9147315bcbbe0f9ac0aae85fb))\n- *(example)* Update symbolic link to the default config - ([ee377cc](https://github.com/orhun/git-cliff/commit/ee377cc42d2d8771d67b0907151b1bb2ee012d69))\n- *(git)* Sort the commits in topological order - ([a1b4b5b](https://github.com/orhun/git-cliff/commit/a1b4b5b18a6061392fc27b66a5726824212c114c))\n- *(git)* Return tags by their creation order - ([000a67c](https://github.com/orhun/git-cliff/commit/000a67cd8aae7ae20848baa04cd6212376dcde12))\n- *(release)* Fix the character escape in release script - ([5d616ee](https://github.com/orhun/git-cliff/commit/5d616ee249aaee9f38d6d9b7a9e14170b9b7405a))\n- *(release)* Specify the committer email in release script - ([381c941](https://github.com/orhun/git-cliff/commit/381c941a94188fb40bcce1129c29e6a5379ac7a7))\n- *(release)* Strip the unreleased title from tag message - ([c7f08fe](https://github.com/orhun/git-cliff/commit/c7f08fe4a3113f656bb45a29141aa127d4e453e5))\n- *(template)* Use 7 digits for short SHA - ([1f85263](https://github.com/orhun/git-cliff/commit/1f85263f84bf15285fd3fd75af00fa21b12e9738))\n- *(test)* Use default tag_pattern for tests - ([e6fb8de](https://github.com/orhun/git-cliff/commit/e6fb8de5d834eb5fe5ff3b5fab1986fcf5e720b6))\n\n### 🚜 Refactor\n\n- *(args)* Rename changelog argument to prepend - ([5a5a042](https://github.com/orhun/git-cliff/commit/5a5a042134c4829d98271607f697f77701f80860))\n- *(args)* Update value names and description - ([c697b17](https://github.com/orhun/git-cliff/commit/c697b17f67c9438a1fb159db74b1e225aeb28853))\n- *(args)* Update the value name for `--strip` - ([e8a3c35](https://github.com/orhun/git-cliff/commit/e8a3c35fa1f2a9a1a99ad8c60b82899c2af212eb))\n- *(config)* Make tag_pattern optional - ([3a27a3e](https://github.com/orhun/git-cliff/commit/3a27a3e1a2d3813def0405ddf89914c5f10f7b36))\n- *(error)* Use custom error message for GroupError - ([1be66ee](https://github.com/orhun/git-cliff/commit/1be66eebebaa3a5849399433ad5823345668ffb1))\n- *(logs)* Improve logging - ([5333453](https://github.com/orhun/git-cliff/commit/53334533eb6399dc4b931fa3f61c32b5e28bd9e7))\n\n### 📚 Documentation\n\n- *(bin)* Update the doc comment for completions script - ([c056196](https://github.com/orhun/git-cliff/commit/c056196af9ee3f7109876639a0fb3b230661e1e4))\n- *(contributing)* Add CONTRIBUTING.md - ([0fe28b3](https://github.com/orhun/git-cliff/commit/0fe28b322e4dd83bef1ba39d1028922065aa8aee))\n- *(readme)* Add preview image to README.md - ([6e6bdde](https://github.com/orhun/git-cliff/commit/6e6bddeadd3ee43ac6bb626ce5ebd582ffd1f7cb))\n- *(readme)* Update detailed template example - ([441ed4d](https://github.com/orhun/git-cliff/commit/441ed4d8b499a46ce22800da3d969ea6165d6ddf))\n- *(readme)* Add examples for templating - ([a406158](https://github.com/orhun/git-cliff/commit/a40615860871d4bbb351ae1571192a624b1b539d))\n- *(readme)* Add examples for CLI usage - ([32f837e](https://github.com/orhun/git-cliff/commit/32f837e3f0d642f5dc16f1e144ef5040652173ec))\n- *(readme)* Update README.md about template and examples - ([2f2b2fc](https://github.com/orhun/git-cliff/commit/2f2b2fc50a5aa4cdd7842448b9fde7f73564f5d7))\n- *(readme)* Update README.md about usage - ([7f4a9c2](https://github.com/orhun/git-cliff/commit/7f4a9c20128af75a8972e58130ac0ed4ce52d995))\n- *(readme)* Add usage section - ([c87fbbe](https://github.com/orhun/git-cliff/commit/c87fbbe7cf869dd343269f6f23d9e4776a7d952b))\n- *(release)* Add RELEASE.md - ([ce2246b](https://github.com/orhun/git-cliff/commit/ce2246bcfdcbce2e2ef30ec44fbfae26d3914139))\n- *(release)* Add link to the signer key of the tag - ([59b7c6e](https://github.com/orhun/git-cliff/commit/59b7c6ef79c6377b3de26247a232412c765ab6a8))\n\n### 🎨 Styling\n\n- *(config)* Update the order of entries in config - ([9f84fe5](https://github.com/orhun/git-cliff/commit/9f84fe58a76c4aed97844e648bf42ad0c1d46303))\n- *(readme)* Remove quotes from rendered output - ([dfab978](https://github.com/orhun/git-cliff/commit/dfab97842fe78fb8f217a5185fb6ec92682a53ca))\n- *(readme)* Wrap table of contents into summary - ([fa6a38b](https://github.com/orhun/git-cliff/commit/fa6a38b339d7a56e976820b363f48d5c13d5cdf5))\n- *(readme)* Remove comments from template context - ([1cf1ac7](https://github.com/orhun/git-cliff/commit/1cf1ac73fa26d015f7316c7c27639c1c7f4a7995))\n- *(readme)* Update the comments in template context - ([3749490](https://github.com/orhun/git-cliff/commit/37494901ef4826b57f82946a6cd6c7cd21f5ca2c))\n- *(readme)* Center the badges - ([f08ff0c](https://github.com/orhun/git-cliff/commit/f08ff0c4136a2257bfe7e586c03bcf7a520f06bd))\n\n### 🧪 Testing\n\n- *(config)* Add tests - ([11a7a7e](https://github.com/orhun/git-cliff/commit/11a7a7eb3eec4e801b6ab6576db2849bc771987f))\n- *(git)* Update repository tests about getting the latest tag - ([9cf9ac1](https://github.com/orhun/git-cliff/commit/9cf9ac1586cf0f582b9a48bc5ce6f351d8350721))\n\n### ⚙️ Miscellaneous Tasks\n\n- *(cargo)* Update project details - ([22f0a7e](https://github.com/orhun/git-cliff/commit/22f0a7ef73cb1649d9ed59e43ee0e410b456233d))\n- *(cd)* Enable crates.io releases - ([31ecfd8](https://github.com/orhun/git-cliff/commit/31ecfd8ad041e36090575e5851ff00d491ccebca))\n- *(cd)* Use only one step for uploading releases - ([42a714f](https://github.com/orhun/git-cliff/commit/42a714f31cf5b6f924fe68d966189e2c278a11a6))\n- *(cd)* Use separate steps for uploading releases - ([0182533](https://github.com/orhun/git-cliff/commit/01825330d90a9399c9285b5a286b1d69aa1494e7))\n- *(cd)* Remove the custom changelog template - ([d826b9d](https://github.com/orhun/git-cliff/commit/d826b9d2e5bdd30b132731ff6d1dc87748543ccb))\n- *(cd)* Override the changelog template - ([41053fb](https://github.com/orhun/git-cliff/commit/41053fbe90a08648b70e5cca6a2504e94202bd06))\n- *(cd)* Set the release body on linux - ([7623977](https://github.com/orhun/git-cliff/commit/76239771662bf342d742c12907619eece1bf946d))\n- *(cd)* Fix setting the release body - ([62403be](https://github.com/orhun/git-cliff/commit/62403be828ac75f5689f27ad5d5e0421b514be62))\n- *(cd)* Set the changelog as release body - ([66dfbf4](https://github.com/orhun/git-cliff/commit/66dfbf40ec0ef91dc2016c1bdf2044a07e4580d5))\n- *(cd)* Set the release name explicitly - ([0e5a7b1](https://github.com/orhun/git-cliff/commit/0e5a7b1dd54afff0085930bf8c058803cfe3ea03))\n- *(config)* Update template to include commit ids - ([e3d3482](https://github.com/orhun/git-cliff/commit/e3d34821911ffb44e4c6e61e8d0c6ecd2d31a341))\n- *(config)* Update the skip_tags regex - ([28171f0](https://github.com/orhun/git-cliff/commit/28171f0f98f0980f9b0a6d3ca89ed3d6c70eb0ef))\n- *(docker)* Bump the rust version - ([a2df26f](https://github.com/orhun/git-cliff/commit/a2df26ff8602095707ebcfcfc4c278d12a9463f4))\n- *(docker)* Rename the docker automated builds action - ([ad3126e](https://github.com/orhun/git-cliff/commit/ad3126e15144f98b5845c31149214cdce5ffb3d5))\n- *(docker)* Remove user directive from Dockerfile - ([076fc85](https://github.com/orhun/git-cliff/commit/076fc8580aee74755003d99d902b3e64abcad535))\n- *(git)* Remove etc directory from .gitignore - ([8881083](https://github.com/orhun/git-cliff/commit/8881083520e5fcdbdfa27520f0a1aa29752067cc))\n- *(project)* Update .editorconfig about shell scripts - ([c898912](https://github.com/orhun/git-cliff/commit/c8989122d06af2abb70edf5d42d7297411d0b093))\n- *(project)* Update the release script about arguments - ([098c6ad](https://github.com/orhun/git-cliff/commit/098c6ad3803d728f4cd25320cb557d2a0bb22bd1))\n- *(project)* Add release script - ([d76bb9b](https://github.com/orhun/git-cliff/commit/d76bb9b3e5ff41df96b27c4fb202a2dd2344d6b2))\n- *(release)* Indicate which versions are managed by the script - ([f481081](https://github.com/orhun/git-cliff/commit/f48108109e84ea6d869c75e98143be9b7ed5d069))\n- *(release)* Verify the created tag after creation - ([99f2f07](https://github.com/orhun/git-cliff/commit/99f2f0701cbf92c5b4ec235e307549af53336db7))\n- *(release)* Set the new version in release script - ([6619c38](https://github.com/orhun/git-cliff/commit/6619c385ed5220293b4a9af1c405a364f0085bc9))\n- *(release)* Include the commit id in the custom template - ([5677281](https://github.com/orhun/git-cliff/commit/5677281b2ca594789a32c53e7f304cae734c089f))\n- *(release)* Set a custom changelog for the tag message - ([c4df0fa](https://github.com/orhun/git-cliff/commit/c4df0fa892568f1491b62c47d5757fb70b7f4316))\n- *(release)* Add release title to the tag message - ([6099b2d](https://github.com/orhun/git-cliff/commit/6099b2d0c7c7d51a44a0e05a53908a9a370a7e83))\n- *(release)* Strip the markdown format from tag message - ([3cb6761](https://github.com/orhun/git-cliff/commit/3cb67618ef475bf0eb144c5b84cd68af0758f564))\n\n### ◀️ Revert\n\n- Chore(config): update template to include commit ids - ([f95fca9](https://github.com/orhun/git-cliff/commit/f95fca966bacb520e958fe783e239f98dfe026bc))\n\n\n\n" }, { "path": "CNAME", "content": "git-cliff.org" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to making participation in our project and\nour community a harassment-free experience for everyone, regardless of age, body\nsize, disability, ethnicity, sex characteristics, gender identity and expression,\nlevel of experience, education, socio-economic status, nationality, personal\nappearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or\n advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic\n address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned to this Code of Conduct, or to ban temporarily or\npermanently any contributor for other behaviors that they deem inappropriate,\nthreatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces\nwhen an individual is representing the project or its community. Examples of\nrepresenting a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event. Representation of a project may be\nfurther defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported by contacting the project team at git-cliff@protonmail.com. All\ncomplaints will be reviewed and investigated and will result in a response that\nis deemed necessary and appropriate to the circumstances. The project team is\nobligated to maintain confidentiality with regard to the reporter of an incident.\nFurther details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see\nhttps://www.contributor-covenant.org/faq" }, { "path": "CONTRIBUTING.md", "content": "# Contributing\n\nThank you for considering contributing to [git-cliff](https://github.com/orhun/git-cliff)!\n\nWhen contributing, please first discuss the change you wish to make via [issue](https://github.com/orhun/git-cliff/issues),\n[email](mailto:orhunparmaksiz@gmail.com), or any other method with the owners of this repository before making a change.\n\nNote that we have a [Code of Conduct](./CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.\n\n---\n\n## Required Tooling\n\n- Install the nightly toolchain (required for `rustfmt`):\n\n```sh\nrustup toolchain install nightly\n```\n\n- Optional: set up editor/IDE integration to use **nightly** `rustfmt` for this repository.\n\n---\n\n## Setup\n\n1. Fork this repository and create your branch from `main`.\n\n2. Clone your forked repository.\n\n```sh\ngit clone https://github.com/{username}/git-cliff && cd git-cliff\n# OR\ngit clone git@github.com:{username}/git-cliff && cd git-cliff\n```\n\n3. Fetch tags (required for tests):\n\n```sh\ngit fetch --tags https://github.com/orhun/git-cliff\n```\n\n4. Install [Rust](https://www.rust-lang.org/) `1.85.1` or later and build the project:\n\n```sh\ncargo build\n```\n\n> [!NOTE]\n>\n> - The project uses **stable** Rust for builds and tests.\n> - Formatting and linting are run with the **nightly toolchain** in CI due to the use of unstable `rustfmt` options.\n> Contributors are expected to run the same checks locally.\n\n---\n\n## Development Workflow\n\n1. Start committing your changes. Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification.\n\n2. Add your tests (if you haven't already) or update the existing tests according to the changes. And check if the tests are passed:\n\n```sh\ncargo test\n```\n\n3. If you changed snapshot tests (i.e. `expect_test`), update snapshots:\n\n```sh\nenv UPDATE_EXPECT=1 cargo test\n```\n\n4. Run CI checks locally - `clippy` (warnings are errors)\n\n\n```sh\ncargo clippy --tests --verbose -- -D warnings\n```\n\n5. Run CI checks locally - `clippy` (**optional**, but recommended for pedantic linting)\n\n```sh\ncargo clippy --all-targets --verbose -- -W clippy::pedantic\n```\n\n> [!NOTE]\n>\n> - You may allow specific pedantic lints **only with a clear justification**.\n> - Running `clippy` with pedantic lints is **optional**, but it can serve as a helpful guideline for new code and implementations, helping maintain consistency and catch potential issues early.\n\n6. Run formatting checks – `rustfmt`\n\n```sh\ncargo +nightly fmt --all -- --check --verbose\n```\n\nIf formatting fails, please run:\n\n```sh\ncargo +nightly fmt --all\n```\n\n---\n\n## Create a Pull Request\n\n1. Ensure that you updated the documentation and filled the [Pull Request template](./.github/PULL_REQUEST_TEMPLATE.md) according to the changes you made.\n\n2. Wait for approval from the project owner/maintainer. Discuss the possible changes and update your Pull Request if necessary.\n\n3. You may merge the Pull Request once you have the sign-off of the project owner/maintainer, or if you do not have permission to do that, you may request the project owner/maintainer to merge it in case they haven't done it after a while.\n\n# License\n\nBy contributing, you agree that your contributions will be licensed under [The MIT License](./LICENSE-MIT) or [Apache License 2.0](./LICENSE-APACHE).\n" }, { "path": "Cargo.toml", "content": "[workspace]\nresolver = \"2\"\nmembers = [\"git-cliff-core\", \"git-cliff\"]\n\n[workspace.dependencies]\nregex = \"1.11.1\"\nglob = \"0.3.2\"\nlog = \"0.4.21\"\nsecrecy = { version = \"0.8.0\", features = [\"serde\"] }\nlazy_static = \"1.5.0\"\ndirs = \"6.0.0\"\nurl = \"2.5.3\"\nreqwest = { version = \"0.12.28\", default-features = false, features = [\n \"blocking\",\n \"rustls-tls\",\n \"rustls-tls-native-roots\",\n \"json\",\n \"zstd\",\n] }\n\n[profile.dev]\nopt-level = 0\ndebug = true\npanic = \"abort\"\n\n[profile.test]\nopt-level = 0\ndebug = true\n\n[profile.release]\nopt-level = 3\ndebug = false\npanic = \"unwind\"\nlto = true\ncodegen-units = 1\nstrip = true\n\n[profile.bench]\nopt-level = 3\ndebug = true # used by the profiler\nstrip = false # keep symbols for the profiler\n\n[workspace.lints.clippy]\n# NOTE:\n# `clippy` is intentionally not configured at the workspace level.\n# CLI arguments take precedence over this configuration, which can\n# lead to confusing behavior.\n" }, { "path": "Dockerfile", "content": "# syntax=docker/dockerfile:1.4.3-labs\nFROM lukemathwalker/cargo-chef:0.1.77-rust-1.94.0-slim-bookworm@sha256:fc6754f2b0004a589fe817877a719e9252d4cdfa3aa8d03fd885e9b734b6fbf8 AS chef\nWORKDIR app\n\nFROM chef AS planner\nCOPY . .\nRUN cargo chef prepare --recipe-path recipe.json\n\nFROM chef AS builder\nCOPY --from=planner /app/recipe.json recipe.json\nENV CARGO_NET_GIT_FETCH_WITH_CLI=true\nRUN cargo chef cook --release --recipe-path recipe.json\nCOPY . .\nRUN cargo build --release --locked --no-default-features --features github --features gitlab --features bitbucket\nRUN rm -f target/release/deps/git_cliff*\n\nFROM debian:bookworm-slim@sha256:74d56e3931e0d5a1dd51f8c8a2466d21de84a271cd3b5a733b803aa91abf4421 as runner\n\n# Install ca-certificates (required for `--use-native-tls` argument)\nRUN apt-get update \\\n && apt-get install -y --no-install-recommends ca-certificates \\\n && rm -rf /var/lib/apt/lists/*\n\n# Everything inside this container will be explicitly mounted by the end user,\n# so we can sidestep some Git security restrictions. This app recommends\n# mounting data to /app, but this *can* be changed externally and *will* be\n# changed when run by GitHub Actions, so we need to cover our bases.\nRUN echo '[safe]\\n\\tdirectory = *' > /etc/gitconfig\n\nCOPY --from=builder /app/target/release/git-cliff /usr/local/bin\nWORKDIR app\n\n# Even if the repository is marked as safe, GitHub Actions and some other\n# environments insist on running the entrypoint as root inside the container\n# even when being run by a non privileged user on their own files. Here we\n# check the ownership of the workdir (which may or may not be /app) and change\n# our effective user/group ID to match.\nRUN cat <<'EOF' > /usr/local/bin/entrypoint.sh\n#!/bin/sh\nif [ \"$(id -u)\" -ne \"$(stat -c '%u' .)\" ]; then\n eids=\"$(stat -c '--euid %u --egid %g' .)\"\nfi\nexec ${eids:+setpriv --clear-groups $eids} git-cliff $@\nEOF\nENTRYPOINT [\"sh\", \"/usr/local/bin/entrypoint.sh\"]\n" }, { "path": "LICENSE-APACHE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\nTERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\nEND OF TERMS AND CONDITIONS\n" }, { "path": "LICENSE-MIT", "content": "The MIT License (MIT)\n\nCopyright (c) 2021-2025 Orhun Parmaksız\nCopyright (c) 2021-2025 git-cliff contributors\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "

\n \n \n
\n \n \n \n \n \n \n
\n \n \n \n \n \n \n \n \n
\n

\n\n

\n Documentation |\n Website\n

\n\n**git-cliff** can generate [changelog](https://en.wikipedia.org/wiki/Changelog) files from the [Git](https://git-scm.com/) history by utilizing [conventional commits](https://git-cliff.org/docs/configuration/git#conventional_commits) as well as regex-powered [custom parsers](https://git-cliff.org/docs/configuration/git#commit_parsers). The [changelog template](https://git-cliff.org/docs/category/templating) can be customized with a [configuration file](https://git-cliff.org/docs/configuration) to match the desired format.\n\n![animation](https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff-anim.gif)\n\n## Documentation\n\nLearn how to use **git-cliff** from the [official documentation](https://git-cliff.org/docs).\n\n- [Installation](https://git-cliff.org/docs/installation/)\n- [Usage](https://git-cliff.org/docs/usage/examples)\n- [Configuration](https://git-cliff.org/docs/configuration)\n- [Templating](https://git-cliff.org/docs/category/templating)\n\nYou can also check out the blog posts written by the community:\n\n- [An introduction to git-cliff for release management](https://substack.evancarroll.com/p/git-cliff-for-automated-release-management): Learn how to automate your software releases\n- [Git-cliff and monorepos](https://substack.evancarroll.com/p/git-cliff-and-monorepos): An introduction to the monorepo capabilities of git-cliff\n- [git-cliff: The Smart Way to Handle Changelogs](https://medium.com/@toniomasotti/git-cliff-96449950db48)\n\n## In The Media\n\n- [Turning Git commits into changelog with git-cliff](https://www.youtube.com/watch?v=RWh8qbiLRts) - RustLab 2023 (Talk)\n- [An Interview with Orhun of git-cliff](https://console.substack.com/p/console-141) - Console #141 (Newsletter)\n- [KaiCode Open Source Festival 2024](https://www.kaicode.org/2024.html) (Second place winner)\n\n## Editor Support\n\n- [git-cliff.el](https://github.com/liuyinz/git-cliff.el) - Generate, update and release changelog in Emacs\n\n## Similar/Related Projects\n\n- [git-journal](https://github.com/saschagrunert/git-journal) - The Git Commit Message and Changelog Generation Framework\n- [clog-cli](https://github.com/clog-tool/clog-cli) - Generate beautiful changelogs from your Git commit history\n- [relnotes](https://crates.io/crates/relnotes) - A tool to automatically generate release notes for your project.\n- [cocogitto](https://github.com/oknozor/cocogitto) - A set of CLI tools for the conventional commit and semver specifications.\n- [cliff-jumper](https://github.com/favware/cliff-jumper) - A NodeJS CLI tool that combines git-cliff and\n [conventional-recommended-bump](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump)\n to semantically bump a NodeJS package and generate a git-cliff powered changelog.\n- [release-plz](https://github.com/MarcoIeni/release-plz) - Release Rust packages from CI.\n- [git-changelog-command-line](https://github.com/tomasbjerre/git-changelog-command-line) - Generate changelog and determine next version with conventional commits.\n- [git-changelog](https://github.com/pawamoy/git-changelog): Automatic Changelog generator using Jinja2 templates.\n\n## Contributors\n\nThanks goes to these wonderful people ✨\n\n\n \n\n\nMade with [contrib.rocks](https://contrib.rocks).\n\n## Socials\n\n\n \n
\n\n \n\n \n\n \n\n \n\n## License\n\nLicensed under either of [Apache License Version 2.0](./LICENSE-APACHE) or [The MIT License](./LICENSE-MIT) at your option.\n\n## Copyright\n\nCopyright © 2021-2025, [git-cliff contributors](mailto:git-cliff@protonmail.com)\n" }, { "path": "RELEASE.md", "content": "# Creating a Release\n\n[GitHub](https://github.com/orhun/git-cliff/releases), [crates.io](https://crates.io/crates/git-cliff/) and [Docker Hub](https://hub.docker.com/r/orhunp/git-cliff) releases are automated via [GitHub actions](./.github/workflows/cd.yml) and triggered by pushing a tag.\n\n1. Run the [release script](./release.sh): `./release.sh v[X.Y.Z]`\n2. Push the changes: `git push`\n3. Check if [Continuous Integration](https://github.com/orhun/git-cliff/actions) workflow is completed successfully.\n4. Push the tags: `git push --tags`\n5. Wait for [Continuous Deployment](https://github.com/orhun/git-cliff/actions) workflow to finish.\n - Do not forget to set `vars.USE_TESTPYPI` variable to `false` before release.\n" }, { "path": "SECURITY.md", "content": "# Security\n\nIf you wish to report a security vulnerability privately, we appreciate your diligence. Please follow the guidelines below to submit your report.\n\n## Supported Versions\n\nThe following versions are supported with security updates:\n\n| Version | Supported |\n| ------- | ------------------ |\n| 2.x.x | :white_check_mark: |\n| 1.x.x | :white_check_mark: |\n| 1.0.x | :x: |\n| < 0.1.0 | :x: |\n\n## Reporting\n\nTo report a security vulnerability, please provide the following information:\n\n1. **PUBLIC**\n\n - Indicate whether this vulnerability has already been publicly discussed or disclosed.\n - If so, provide relevant links.\n\n2. **DESCRIPTION**\n - Provide a detailed description of the security vulnerability.\n - Include as much information as possible to help us understand and address the issue.\n\nSend this information, along with any additional relevant details, to .\n\n## Confidentiality\n\nWe kindly ask you to keep the report confidential until a public announcement is made.\n\n## Notes\n\n- Vulnerabilities will be handled on a best-effort basis.\n- You may request an advance copy of the patched release, but we cannot guarantee early access before the public release.\n- You will be notified via email simultaneously with the public announcement.\n- We will respond within a few weeks to confirm whether your report has been accepted or rejected.\n\nThank you for helping to improve the security of **git-cliff**! ⛰️\n" }, { "path": "cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[remote.github]\nowner = \"orhun\"\nrepo = \"git-cliff\"\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n[![animation](https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff-anim.gif)](https://git-cliff.org)\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{%- macro remote_url() -%}\n https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\n{%- endmacro -%}\n\n{% macro print_commit(commit) -%}\n - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\\\n {% if commit.breaking %}[**breaking**] {% endif %}\\\n {{ commit.message | upper_first }} - \\\n ([{{ commit.id | truncate(length=7, end=\"\") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\\\n{% endmacro -%}\n\n{% if version %}\\\n {% if previous.version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]\\\n ({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% else %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% endif %}\\\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | striptags | trim | upper_first }}\n {% for commit in commits\n | filter(attribute=\"scope\")\n | sort(attribute=\"scope\") %}\n {{ self::print_commit(commit=commit) }}\n {%- endfor %}\n {% for commit in commits %}\n {%- if not commit.scope -%}\n {{ self::print_commit(commit=commit) }}\n {% endif -%}\n {% endfor -%}\n{% endfor -%}\n{%- if github -%}\n{% if github.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n ## New Contributors ❤️\n{% endif %}\\\n{% for contributor in github.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \\\n {%- endif %}\n{%- endfor -%}\n{%- endif %}\n\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n# An array of regex based postprocessors to modify the changelog.\npostprocessors = [\n # Replace the placeholder `` with a URL.\n { pattern = '', replace = \"https://github.com/orhun/git-cliff\" }, # replace repository URL\n]\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = true\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Replace issue numbers with link templates to be updated in `changelog.postprocessors`.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"([#${2}](/issues/${2}))\" },\n # Check spelling of the commit message using https://github.com/crate-ci/typos.\n # If the spelling is incorrect, it will be fixed automatically.\n { pattern = '.*', replace_command = 'typos --write-changes -' },\n]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"⛰️ Features\" },\n { message = \"^fix\", group = \"🐛 Bug Fixes\" },\n { message = \"^doc\", group = \"📚 Documentation\" },\n { message = \"^perf\", group = \"⚡ Performance\" },\n { message = \"^refactor\\\\(clippy\\\\)\", skip = true },\n { message = \"^refactor\", group = \"🚜 Refactor\" },\n { message = \"^style\", group = \"🎨 Styling\" },\n { message = \"^test\", group = \"🧪 Testing\" },\n { message = \"^chore\\\\(release\\\\): prepare for\", skip = true },\n { message = \"^chore\\\\(deps.*\\\\)\", skip = true },\n { message = \"^chore\\\\(pr\\\\)\", skip = true },\n { message = \"^chore\\\\(pull\\\\)\", skip = true },\n { message = \"^chore\\\\(npm\\\\).*yarn\\\\.lock\", skip = true },\n { message = \"^chore|^ci\", group = \"⚙️ Miscellaneous Tasks\" },\n { body = \".*security\", group = \"🛡️ Security\" },\n { message = \"^revert\", group = \"◀️ Revert\" },\n]\n# Prevent commits that are breaking from being excluded by commit parsers.\nprotect_breaking_commits = false\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = false\n# Regex to select git tags that represent releases.\ntag_pattern = \"v[0-9].*\"\n# Regex to select git tags that do not represent proper releases.\n# Takes precedence over `tag_pattern`.\n# Changes belonging to these releases will be included in the next release.\nskip_tags = \"beta|alpha\"\n# Regex to exclude git tags after applying the tag_pattern.\nignore_tags = \"rc|v2.1.0|v2.1.1\"\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"newest\"\n" }, { "path": "codecov.yml", "content": "coverage:\n range: 50..75\n round: up\n precision: 2\n status:\n project:\n default:\n target: auto\n threshold: 5%\n branches:\n - main\n if_ci_failed: error\n patch: off\n" }, { "path": "config/cliff.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | striptags | trim | upper_first }}\n {% for commit in commits %}\n - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\\\n {% if commit.breaking %}[**breaking**] {% endif %}\\\n {{ commit.message | upper_first }}\\\n {% endfor %}\n{% endfor %}\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n# Render body even when there are no releases to process.\nrender_always = true\n# An array of regex based postprocessors to modify the changelog.\npostprocessors = [\n # Replace the placeholder with a URL.\n #{ pattern = '', replace = \"https://github.com/orhun/git-cliff\" },\n]\n# render body even when there are no releases to process\n# render_always = true\n# output file path\n# output = \"test.md\"\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = true\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# Require all commits to be conventional.\n# Takes precedence over filter_unconventional.\nrequire_conventional = false\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Replace issue numbers with link templates to be updated in `changelog.postprocessors`.\n #{ pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"([#${2}](/issues/${2}))\"},\n # Check spelling of the commit message using https://github.com/crate-ci/typos.\n # If the spelling is incorrect, it will be fixed automatically.\n #{ pattern = '.*', replace_command = 'typos --write-changes -' },\n]\n# Prevent commits that are breaking from being excluded by commit parsers.\nprotect_breaking_commits = false\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"🚀 Features\" },\n { message = \"^fix\", group = \"🐛 Bug Fixes\" },\n { message = \"^doc\", group = \"📚 Documentation\" },\n { message = \"^perf\", group = \"⚡ Performance\" },\n { message = \"^refactor\", group = \"🚜 Refactor\" },\n { message = \"^style\", group = \"🎨 Styling\" },\n { message = \"^test\", group = \"🧪 Testing\" },\n { message = \"^chore\\\\(release\\\\): prepare for\", skip = true },\n { message = \"^chore\\\\(deps.*\\\\)\", skip = true },\n { message = \"^chore\\\\(pr\\\\)\", skip = true },\n { message = \"^chore\\\\(pull\\\\)\", skip = true },\n { message = \"^chore|^ci\", group = \"⚙️ Miscellaneous Tasks\" },\n { body = \".*security\", group = \"🛡️ Security\" },\n { message = \"^revert\", group = \"◀️ Revert\" },\n { message = \".*\", group = \"💼 Other\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = false\n# Fail on a commit that is not matched by any commit parser.\nfail_on_unmatched_commit = false\n# An array of link parsers for extracting external references, and turning them into URLs, using regex.\nlink_parsers = []\n# Include only the tags that belong to the current branch.\nuse_branch_tags = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order commits topologically instead of chronologically.\ntopo_order_commits = true\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"oldest\"\n# Process submodules commits\nrecurse_submodules = false\n" }, { "path": "examples/azure-devops-keepachangelog.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# [remote.azure_devops]\n# owner = \"Owner/Project\"\n# repo = \"Repo\"\n# api_url = \"https://dev.azure.com\"\n# token = \"\"\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version -%}\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else -%}\n ## [Unreleased]\n{% endif -%}\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | split(pat=\"\\n\") | first | upper_first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif %}\\\n {% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n{% for release in releases -%}\n {% if release.version -%}\n {% if release.previous.version -%}\n [{{ release.version | trim_start_matches(pat=\"v\") }}]: \\\n https://dev.azure.com/{{ remote.azure_devops.owner }}\\\n /_git/{{ remote.azure_devops.repo }}/branchCompare?baseVersion=GT{{ release.previous.version }}&targetVersion=GT{{ release.version }}\n {% endif -%}\n {% else -%}\n [unreleased]: https://dev.azure.com/{{ remote.azure_devops.owner }}\\\n /_git/{{ remote.azure_devops.repo }}/branchCompare?baseVersion=GT{{ release.previous.version }}&targetVersion=GBmaster&_a=commits\n {% endif -%}\n{% endfor %}\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = true\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = false\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^[a|A]dd\", group = \"Added\" },\n { message = \"^[s|S]upport\", group = \"Added\" },\n { message = \"^[r|R]emove\", group = \"Removed\" },\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Prevent commits that are breaking from being excluded by commit parsers.\nfilter_commits = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"oldest\"\n" }, { "path": "examples/cocogitto.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n---\n{% if version %}\\\n {% if previous.version %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}]($REPO/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% else %}\\\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n {% endif %}\\\n{% else %}\\\n ## [unreleased]\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | striptags | trim | upper_first }}\n {% for commit in commits\n | filter(attribute=\"scope\")\n | sort(attribute=\"scope\") %}\n - **({{commit.scope}})**{% if commit.breaking %} [**breaking**]{% endif %} \\\n {{ commit.message }} - ([{{ commit.id | truncate(length=7, end=\"\") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }}\n {%- endfor -%}\n {% raw %}\\n{% endraw %}\\\n {%- for commit in commits %}\n {%- if commit.scope -%}\n {% else -%}\n - {% if commit.breaking %} [**breaking**]{% endif %}\\\n {{ commit.message }} - ([{{ commit.id | truncate(length=7, end=\"\") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }}\n {% endif -%}\n {% endfor -%}\n{% endfor %}\\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n# postprocessors\npostprocessors = [\n # Replace the placeholder `` with a URL.\n { pattern = '\\$REPO', replace = \"https://github.com/cocogitto/cocogitto\" }, # replace repository URL\n]\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = true\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Replace issue numbers with link templates to be updated in `changelog.postprocessors`.\n #{ pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"([#${2}](https://github.com/orhun/git-cliff/issues/${2}))\"},\n]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\" },\n { message = \"^fix\", group = \"Bug Fixes\" },\n { message = \"^doc\", group = \"Documentation\" },\n { message = \"^perf\", group = \"Performance\" },\n { message = \"^refactor\", group = \"Refactoring\" },\n { message = \"^style\", group = \"Style\" },\n { message = \"^revert\", group = \"Revert\" },\n { message = \"^test\", group = \"Tests\" },\n { message = \"^chore\\\\(version\\\\):\", skip = true },\n { message = \"^chore\", group = \"Miscellaneous Chores\" },\n { body = \".*security\", group = \"Security\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"oldest\"\n" }, { "path": "examples/detailed.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## {{ version | trim_start_matches(pat=\"v\") }} - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## Unreleased\n{% endif %}\\\n{% if previous %}\\\n {% if previous.commit_id and commit_id %}\n [{{ previous.commit_id | truncate(length=7, end=\"\") }}]({{ previous.commit_id }})...\\\n [{{ commit_id | truncate(length=7, end=\"\") }}]({{ commit_id }})\n {% endif %}\\\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | split(pat=\"\\n\") | first | upper_first | trim }} ([{{ commit.id | truncate(length=7, end=\"\") }}]({{ commit.id }}))\\\n {% if commit.footers %}\\\n {% for footer in commit.footers -%}\n , {{ footer.token }}{{ footer.separator }}{{ footer.value }}\\\n {% endfor %}\\\n {% endif %}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = true\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = false\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\" },\n { message = \"^fix\", group = \"Bug Fixes\" },\n { message = \"^doc\", group = \"Documentation\" },\n { message = \"^perf\", group = \"Performance\" },\n { message = \"^refactor\", group = \"Refactor\" },\n { message = \"^style\", group = \"Styling\" },\n { message = \"^test\", group = \"Testing\" },\n { message = \"^chore\\\\(deps.*\\\\)\", skip = true },\n { message = \"^chore\\\\(pr\\\\)\", skip = true },\n { message = \"^chore\\\\(pull\\\\)\", skip = true },\n { message = \"^chore\\\\(release\\\\): prepare for\", skip = true },\n { message = \"^chore|^ci\", group = \"Miscellaneous Tasks\" },\n { body = \".*security\", group = \"Security\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"oldest\"\n" }, { "path": "examples/github-keepachangelog.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{%- macro remote_url() -%}\n https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\n{%- endmacro -%}\n\n{% if version -%}\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else -%}\n ## [Unreleased]\n{% endif -%}\n\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {%- for commit in commits %}\n - {{ commit.message | split(pat=\"\\n\") | first | upper_first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in \\\n [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}) \\\n {%- endif -%}\n {% endfor %}\n{% endfor %}\n\n{%- if github.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n ### New Contributors\n{%- endif -%}\n\n{% for contributor in github.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \\\n {%- endif %}\n{%- endfor %}\\n\n\n{%- if github.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}{% raw %}\\n{% endraw -%}{% endif %}\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n{%- macro remote_url() -%}\n https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\n{%- endmacro -%}\n\n{% for release in releases -%}\n {% if release.version -%}\n {% if release.previous.version -%}\n [{{ release.version | trim_start_matches(pat=\"v\") }}]: \\\n {{ self::remote_url() }}/compare/{{ release.previous.version }}...{{ release.version }}\n {% endif -%}\n {% else -%}\n [unreleased]: {{ self::remote_url() }}/compare/{{ release.previous.version }}...HEAD\n {% endif -%}\n{% endfor %}\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = true\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [\n # Remove issue numbers.\n { pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" },\n]\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^[a|A]dd\", group = \"Added\" },\n { message = \"^[s|S]upport\", group = \"Added\" },\n { message = \"^[r|R]emove\", group = \"Removed\" },\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"newest\"\n" }, { "path": "examples/github.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n# [remote.github]\n# owner = \"orhun\"\n# repo = \"git-cliff\"\n# token = \"\"\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n## What's Changed\n\n{%- if version %} in {{ version | trim_start_matches(pat=\"v\") }}{%- endif -%}\n{% for commit in commits %}\n {% if commit.remote.pr_title -%}\n {%- set commit_message = commit.remote.pr_title -%}\n {%- else -%}\n {%- set commit_message = commit.message -%}\n {%- endif -%}\n * {{ commit_message | split(pat=\"\\n\") | first | trim }}\\\n {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}\n {% if commit.remote.pr_number %} in \\\n [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}) \\\n {%- endif %}\n{%- endfor -%}\n\n{%- if github -%}\n{% if github.contributors | filter(attribute=\"is_first_time\", value=true) | length != 0 %}\n {% raw %}\\n{% endraw -%}\n ### New Contributors\n{%- endif %}\\\n{% for contributor in github.contributors | filter(attribute=\"is_first_time\", value=true) %}\n * @{{ contributor.username }} made their first contribution\n {%- if contributor.pr_number %} in \\\n [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \\\n {%- endif %}\n{%- endfor -%}\n{%- endif -%}\n\n{% if version %}\n {% if previous.version %}\n **Full Changelog**: {{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }}\n {% endif %}\n{% else -%}\n {% raw %}\\n{% endraw %}\n{% endif %}\n\n{%- macro remote_url() -%}\n https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\n{%- endmacro -%}\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n\n\"\"\"\n# An array of regex based postprocessors to modify the changelog.\n# Replace the placeholder `` with a URL.\npostprocessors = []\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = false\n# An array of regex based parsers to modify commit messages prior to further processing.\ncommit_preprocessors = [{ pattern = '\\((\\w+\\s)?#([0-9]+)\\)', replace = \"\" }]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"newest\"\n" }, { "path": "examples/keepachangelog.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version -%}\n ## [{{ version | trim_start_matches(pat=\"v\") }}] - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else -%}\n ## [Unreleased]\n{% endif -%}\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | split(pat=\"\\n\") | first | upper_first | trim }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n{% for release in releases -%}\n {% if release.version -%}\n {% if release.previous.version -%}\n [{{ release.version | trim_start_matches(pat=\"v\") }}]: \\\n https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\\\n /compare/{{ release.previous.version }}..{{ release.version }}\n {% else -%}\n [{{ release.version | trim_start_matches(pat=\"v\") }}]: \\\n https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\\\n /tree/{{ release.version }}\n {% endif -%}\n {% else -%}\n [unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\\\n /compare/{{ release.previous.version }}..HEAD\n {% endif -%}\n{% endfor %}\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = true\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = false\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^[a|A]dd\", group = \"Added\" },\n { message = \"^[s|S]upport\", group = \"Added\" },\n { message = \"^[r|R]emove\", group = \"Removed\" },\n { message = \"^.*: add\", group = \"Added\" },\n { message = \"^.*: support\", group = \"Added\" },\n { message = \"^.*: remove\", group = \"Removed\" },\n { message = \"^.*: delete\", group = \"Removed\" },\n { message = \"^test\", group = \"Fixed\" },\n { message = \"^fix\", group = \"Fixed\" },\n { message = \"^.*: fix\", group = \"Fixed\" },\n { message = \"^.*\", group = \"Changed\" },\n]\n# Prevent commits that are breaking from being excluded by commit parsers.\nfilter_commits = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"oldest\"\n" }, { "path": "examples/minimal.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## {{ version | trim_start_matches(pat=\"v\") }} - {{ timestamp | date(format=\"%Y-%m-%d\") }}\\\n{% else %}\\\n ## Unreleased\\\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\\\n - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\n {% endfor %}\\\n{% endfor %}\\n\n\"\"\"\n" }, { "path": "examples/scoped.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## {{ version | trim_start_matches(pat=\"v\") }} - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## Unreleased\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for group, commits in commits | group_by(attribute=\"scope\") %}\n #### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | upper_first }}\\\n {% endfor %}\n {% endfor %}\\\n{% endfor %}\\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = true\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = false\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\" },\n { message = \"^fix\", group = \"Bug Fixes\" },\n { message = \"^doc\", group = \"Documentation\", default_scope = \"unscoped\" },\n { message = \"^perf\", group = \"Performance\" },\n { message = \"^refactor\", group = \"Refactor\" },\n { message = \"^style\", group = \"Styling\" },\n { message = \"^test\", group = \"Testing\" },\n { message = \"^chore\\\\(release\\\\): prepare for\", skip = true },\n { message = \"^chore\", group = \"Miscellaneous Tasks\" },\n { body = \".*security\", group = \"Security\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"oldest\"\n" }, { "path": "examples/scopesorted.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## {{ version | trim_start_matches(pat=\"v\") }} - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## Unreleased\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits\n | filter(attribute=\"scope\")\n | sort(attribute=\"scope\") %}\n - *({{commit.scope}})* {{ commit.message | upper_first }}\n {%- if commit.breaking %}\n {% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}\n {%- endif -%}\n {%- endfor -%}\n {% raw %}\\n{% endraw %}\\\n {%- for commit in commits %}\n {%- if commit.scope -%}\n {% else -%}\n - *(No Category)* {{ commit.message | upper_first }}\n {% if commit.breaking -%}\n {% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}\n {% endif -%}\n {% endif -%}\n {% endfor -%}\n {% raw %}\\n{% endraw %}\\\n{% endfor %}\\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = true\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = true\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\" },\n { message = \"^fix\", group = \"Bug Fixes\" },\n { message = \"^doc\", group = \"Documentation\" },\n { message = \"^perf\", group = \"Performance\" },\n { message = \"^refactor\", group = \"Refactor\" },\n { message = \"^style\", group = \"Styling\" },\n { message = \"^test\", group = \"Testing\" },\n { message = \"^chore\\\\(release\\\\): prepare for\", skip = true },\n { message = \"^chore\", group = \"Miscellaneous Tasks\" },\n { body = \".*security\", group = \"Security\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"oldest\"\n" }, { "path": "examples/statistics.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## {{ version | trim_start_matches(pat=\"v\") }} - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## Unreleased\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | split(pat=\"\\n\") | first | upper_first | trim_end }}\\\n {% endfor %}\n{% endfor %}\n### Commit Statistics\\n\n- {{ statistics.commit_count }} commit(s) contributed to the release.\n- {{ statistics.commits_timespan | default(value=0) }} day(s) passed between the first and last commit.\n- {{ statistics.conventional_commit_count }} commit(s) parsed as conventional.\n- {{ statistics.links | length }} linked issue(s) detected in commits.\n{%- if statistics.links | length > 0 %}\n\t{%- for link in statistics.links %}\n {{ \" \" }}- [{{ link.text }}]({{ link.href }}) (referenced {{ link.count }} time(s))\n\t{%- endfor %}\n{%- endif %}\n{%- if statistics.days_passed_since_last_release %}\n\t- {{ statistics.days_passed_since_last_release }} day(s) passed between releases.\n{%- endif %}\\n\\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = true\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = false\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\" },\n { message = \"^fix\", group = \"Bug Fixes\" },\n { message = \"^doc\", group = \"Documentation\" },\n { message = \"^perf\", group = \"Performance\" },\n { message = \"^refactor\", group = \"Refactor\" },\n { message = \"^style\", group = \"Styling\" },\n { message = \"^test\", group = \"Testing\" },\n { message = \"^chore\\\\(release\\\\): prepare for\", skip = true },\n { message = \"^chore\", group = \"Miscellaneous Tasks\" },\n { body = \".*security\", group = \"Security\" },\n { body = \".*\", group = \"Other (unconventional)\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"oldest\"\n" }, { "path": "examples/unconventional.toml", "content": "# git-cliff ~ configuration file\n# https://git-cliff.org/docs/configuration\n\n[changelog]\n# A Tera template to be rendered as the changelog's header.\n# See https://keats.github.io/tera/docs/#introduction\nheader = \"\"\"\n# Changelog\\n\nAll notable changes to this project will be documented in this file.\\n\n\"\"\"\n# A Tera template to be rendered for each release in the changelog.\n# See https://keats.github.io/tera/docs/#introduction\nbody = \"\"\"\n{% if version %}\\\n ## {{ version | trim_start_matches(pat=\"v\") }} - {{ timestamp | date(format=\"%Y-%m-%d\") }}\n{% else %}\\\n ## Unreleased\n{% endif %}\\\n{% for group, commits in commits | group_by(attribute=\"group\") %}\n ### {{ group | upper_first }}\n {% for commit in commits %}\n - {{ commit.message | split(pat=\"\\n\") | first | trim_end }}\\\n {% endfor %}\n{% endfor %}\\n\n\"\"\"\n# A Tera template to be rendered as the changelog's footer.\n# See https://keats.github.io/tera/docs/#introduction\nfooter = \"\"\"\n\n\"\"\"\n# Remove leading and trailing whitespaces from the changelog's body.\ntrim = true\n\n\n[git]\n# Parse commits according to the conventional commits specification.\n# See https://www.conventionalcommits.org\nconventional_commits = false\n# Exclude commits that do not match the conventional commits specification.\nfilter_unconventional = false\n# Split commits on newlines, treating each line as an individual commit.\nsplit_commits = false\n# An array of regex based parsers for extracting data from the commit message.\n# Assigns commits to groups.\n# Optionally sets the commit's scope and can decide to exclude commits from further processing.\ncommit_parsers = [\n { message = \"^feat\", group = \"Features\" },\n { message = \"^fix\", group = \"Bug Fixes\" },\n { message = \"^doc\", group = \"Documentation\" },\n { message = \"^perf\", group = \"Performance\" },\n { message = \"^refactor\", group = \"Refactor\" },\n { message = \"^style\", group = \"Styling\" },\n { message = \"^test\", group = \"Testing\" },\n { message = \"^chore\\\\(release\\\\): prepare for\", skip = true },\n { message = \"^chore\", group = \"Miscellaneous Tasks\" },\n { body = \".*security\", group = \"Security\" },\n { body = \".*\", group = \"Other (unconventional)\" },\n]\n# Exclude commits that are not matched by any commit parser.\nfilter_commits = false\n# Order releases topologically instead of chronologically.\ntopo_order = false\n# Order of commits in each group/release within the changelog.\n# Allowed values: newest, oldest\nsort_commits = \"oldest\"\n" }, { "path": "flake.nix", "content": "{\n description = \"git-cliff\";\n\n inputs = {\n nixpkgs.url =\n \"github:nixos/nixpkgs/nixos-unstable\"; # We want to use packages from the binary cache\n flake-utils.url = \"github:numtide/flake-utils\";\n rust-overlay.url = \"github:oxalica/rust-overlay\";\n };\n\n outputs = inputs@{ self, nixpkgs, flake-utils, ... }:\n flake-utils.lib.eachSystem [ \"x86_64-linux\" ] (system:\n let\n pkgs = import nixpkgs {\n inherit system;\n overlays = [ inputs.rust-overlay.overlays.rust-overlay ];\n };\n base-git-cliff = { buildType }: pkgs.rustPlatform.buildRustPackage {\n name = \"git-cliff\";\n src = ./.;\n cargoLock = {\n lockFile = ./Cargo.lock;\n };\n checkType = \"debug\";\n inherit buildType;\n checkFlags = [\n \"--skip=command\"\n \"--skip=repo\"\n ];\n meta = with pkgs.lib; {\n description = \"A highly customizable Changelog Generator that follows Conventional Commit specifications\";\n homepage = \"https://git-cliff.org/\";\n license = [ licenses.mit licenses.asl20 ];\n };\n };\n in rec {\n packages = rec {\n git-cliff = base-git-cliff { buildType = \"release\"; };\n git-cliff-debug = base-git-cliff { buildType = \"debug\"; };\n default = git-cliff;\n };\n\n devShell = pkgs.mkShell {\n CARGO_INSTALL_ROOT = \"${toString ./.}/.cargo\";\n\n buildInputs = with pkgs; [\n pkg-config\n openssl\n cargo-binutils\n cargo-watch\n lld\n (rust-bin.fromRustupToolchain {\n channel = \"stable\";\n components =\n [ \"rust-analyzer\" \"rust-src\" \"rustfmt\" \"rustc\" \"cargo\" \"clippy\" ];\n })\n ];\n };\n\n checks.check = packages.git-cliff-debug;\n });\n}\n" }, { "path": "git-cliff/Cargo.toml", "content": "[package]\nname = \"git-cliff\"\nversion = \"2.12.0\" # managed by release.sh\ndescription = \"A highly customizable changelog generator ⛰️\"\nauthors = [\"git-cliff contributors \"]\nlicense = \"MIT OR Apache-2.0\"\nreadme = \"../README.md\"\nhomepage = \"https://github.com/orhun/git-cliff\"\nrepository = \"https://github.com/orhun/git-cliff\"\nkeywords = [\"changelog\", \"generator\", \"conventional\", \"commit\"]\ncategories = [\"command-line-utilities\"]\ndefault-run = \"git-cliff\"\nedition = \"2024\"\nrust-version = \"1.85.1\"\n\n[[bin]]\nname = \"git-cliff-completions\"\npath = \"src/bin/completions.rs\"\n\n[[bin]]\nname = \"git-cliff-mangen\"\npath = \"src/bin/mangen.rs\"\n\n[features]\n# check for new versions\ndefault = [\"update-informer\", \"integrations\"]\n# enable all integrations\nintegrations = [\"github\", \"gitlab\", \"gitea\", \"bitbucket\", \"azure_devops\"]\n# inform about new releases\nupdate-informer = [\"dep:update-informer\"]\n# enable remote repository integration\nremote = [\"dep:indicatif\", \"dep:reqwest\"]\n# enable GitHub integration\ngithub = [\"remote\", \"git-cliff-core/github\"]\n# enable GitLab integration\ngitlab = [\"remote\", \"git-cliff-core/gitlab\"]\n# enable Gitea integration\ngitea = [\"remote\", \"git-cliff-core/gitea\"]\n# enable Bitbucket integration\nbitbucket = [\"remote\", \"git-cliff-core/bitbucket\"]\n# enable Azure DevOps integration\nazure_devops = [\"remote\", \"git-cliff-core/azure_devops\"]\n# performance profiler\nprofiler = [\"dep:pprof\", \"dep:rand\", \"profiler-flamegraph\"]\nprofiler-flamegraph = [\"pprof/flamegraph\"]\n\n[dependencies]\nglob.workspace = true\nregex.workspace = true\nlog.workspace = true\nsecrecy.workspace = true\nlazy_static.workspace = true\ndirs.workspace = true\nclap = { version = \"4.5.53\", features = [\"derive\", \"env\", \"wrap_help\", \"cargo\"] }\nclap_complete = \"4.5.61\"\nclap_mangen = \"0.2.31\"\nshellexpand = \"3.1.0\"\nupdate-informer = { version = \"1.3.0\", optional = true }\nindicatif = { version = \"0.18.3\", optional = true }\nenv_logger = \"=0.10.2\"\npprof = { version = \"0.15.0\", optional = true }\nrand = { version = \"0.9.2\", optional = true }\nreqwest = { workspace = true, optional = true }\nurl.workspace = true\npathdiff = \"0.2.3\"\n\n[dependencies.git-cliff-core]\nversion = \"2.12.0\" # managed by release.sh\npath = \"../git-cliff-core\"\n\n[dev-dependencies]\npretty_assertions = \"1.4.1\"\n\n[lints]\nworkspace = true\n\n# metadata for cargo-binstall to get the right artifacts\n[package.metadata.binstall]\npkg-url = \"{ repo }/releases/download/v{ version }/{ name }-{ version }-{ target }{ archive-suffix }\"\nbin-dir = \"{ name }-{ version }/{ bin }{ binary-ext }\"\npkg-fmt = \"tgz\"\n\n[package.metadata.generate-rpm]\nassets = [\n { source = \"target/release/git-cliff\", dest = \"/usr/bin/git-cliff\", mode = \"755\" },\n { source = \"LICENSE-MIT\", dest = \"/usr/share/doc/git-cliff/LICENSE-MIT\", mode = \"644\" },\n { source = \"README.md\", dest = \"/usr/share/doc/git-cliff/README.md\", mode = \"644\" },\n { source = \"man/git-cliff.1\", dest = \"/usr/share/man/man1/git-cliff.1\", mode = \"644\", doc = true },\n { source = \"completions/git-cliff.bash\", dest = \"/usr/share/bash-completion/completions/git-cliff\", mode = \"644\" },\n { source = \"completions/git-cliff.fish\", dest = \"/usr/share/fish/vendor_completions.d/git-cliff.fish\", mode = \"644\" },\n { source = \"completions/_git-cliff\", dest = \"/usr/share/zsh/vendor-completions/\", mode = \"644\" },\n]\n\n[package.metadata.deb]\nassets = [\n [\n \"target/release/git-cliff\",\n \"usr/bin/\",\n \"755\",\n ],\n [\n \"../LICENSE-MIT\",\n \"/usr/share/doc/git-cliff/LICENSE-MIT\",\n \"644\",\n ],\n [\n \"../README.md\",\n \"usr/share/doc/git-cliff/README\",\n \"644\",\n ],\n [\n \"../man/git-cliff.1\",\n \"/usr/share/man/man1/git-cliff.1\",\n \"644\",\n ],\n [\n \"../completions/git-cliff.bash\",\n \"/usr/share/bash-completion/completions/git-cliff\",\n \"644\",\n ],\n [\n \"../completions/git-cliff.fish\",\n \"/usr/share/fish/vendor_completions.d/git-cliff.fish\",\n \"644\",\n ],\n [\n \"../completions/_git-cliff\",\n \"/usr/share/zsh/vendor-completions/\",\n \"644\",\n ],\n]\n" }, { "path": "git-cliff/examples/basic.rs", "content": "use clap::Parser;\nuse git_cliff::args::Opt;\nuse git_cliff_core::error::Result;\n\nfn main() -> Result<()> {\n let args = Opt::parse();\n let changelog = git_cliff::run(args.clone())?;\n git_cliff::write_changelog(&args, changelog, std::io::stdout())?;\n Ok(())\n}\n" }, { "path": "git-cliff/src/args.rs", "content": "use std::path::PathBuf;\n\nuse clap::builder::styling::{Ansi256Color, AnsiColor};\nuse clap::builder::{Styles, TypedValueParser, ValueParserFactory};\nuse clap::error::{ContextKind, ContextValue, ErrorKind};\nuse clap::{ArgAction, Parser, ValueEnum};\nuse git_cliff_core::config::{BumpType, Remote};\nuse git_cliff_core::{DEFAULT_CONFIG, DEFAULT_OUTPUT};\nuse glob::Pattern;\nuse regex::Regex;\nuse secrecy::SecretString;\nuse url::Url;\n\n#[derive(Debug, Clone, Copy, ValueEnum)]\npub enum Strip {\n Header,\n Footer,\n All,\n}\n\n#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]\npub enum Sort {\n Oldest,\n Newest,\n}\n\nconst STYLES: Styles = Styles::styled()\n .header(Ansi256Color(208).on_default().bold())\n .usage(Ansi256Color(208).on_default().bold())\n .literal(AnsiColor::White.on_default())\n .placeholder(AnsiColor::Green.on_default());\n\n/// Command-line arguments to parse.\n#[derive(Debug, Parser, Clone)]\n#[command(\n version,\n author = clap::crate_authors!(\"\\n\"),\n about,\n rename_all_env = \"screaming-snake\",\n\thelp_template = \"\\\n{before-help}{name} {version}\n{author-with-newline}{about-with-newline}\n{usage-heading}\n {usage}\n\n{all-args}{after-help}\n\",\n override_usage = \"git-cliff [FLAGS] [OPTIONS] [--] [RANGE]\",\n next_help_heading = Some(\"OPTIONS\"),\n\tdisable_help_flag = true,\n\tdisable_version_flag = true,\n styles(STYLES),\n)]\npub struct Opt {\n #[arg(\n\t\tshort,\n\t\tlong,\n\t\taction = ArgAction::Help,\n\t\tglobal = true,\n\t\thelp = \"Prints help information\",\n\t\thelp_heading = \"FLAGS\"\n\t)]\n pub help: Option,\n #[arg(\n\t\tshort = 'V',\n\t\tlong,\n\t\taction = ArgAction::Version,\n\t\tglobal = true,\n\t\thelp = \"Prints version information\",\n\t\thelp_heading = \"FLAGS\"\n\t)]\n pub version: Option,\n /// Increases the logging verbosity.\n #[arg(short, long, action = ArgAction::Count, alias = \"debug\", help_heading = Some(\"FLAGS\"))]\n pub verbose: u8,\n /// Writes the default configuration file to cliff.toml\n #[arg(\n\t short,\n\t long,\n\t value_name = \"CONFIG\",\n\t num_args = 0..=1,\n\t required = false\n\t)]\n pub init: Option>,\n /// Sets the configuration file.\n #[arg(\n\t short,\n\t long,\n\t env = \"GIT_CLIFF_CONFIG\",\n\t value_name = \"PATH\",\n\t default_value = DEFAULT_CONFIG,\n\t value_parser = Opt::parse_dir\n\t)]\n pub config: PathBuf,\n /// Sets the URL for the configuration file.\n #[arg(long, env = \"GIT_CLIFF_CONFIG_URL\", value_name = \"URL\", hide = !cfg!(feature = \"remote\"))]\n pub config_url: Option,\n /// Sets the working directory.\n #[arg(\n\t short,\n\t long,\n\t env = \"GIT_CLIFF_WORKDIR\",\n\t value_name = \"PATH\",\n\t value_parser = Opt::parse_dir\n\t)]\n pub workdir: Option,\n /// Sets the git repository.\n #[arg(\n\t\tshort,\n\t\tlong,\n\t\tenv = \"GIT_CLIFF_REPOSITORY\",\n\t\tvalue_name = \"PATH\",\n\t\tnum_args(1..),\n\t\tvalue_parser = Opt::parse_dir\n\t)]\n pub repository: Option>,\n /// Sets the path to include related commits.\n #[arg(\n\t\tlong,\n\t\tenv = \"GIT_CLIFF_INCLUDE_PATH\",\n\t\tvalue_name = \"PATTERN\",\n\t\tnum_args(1..)\n\t)]\n pub include_path: Option>,\n /// Sets the path to exclude related commits.\n #[arg(\n\t\tlong,\n\t\tenv = \"GIT_CLIFF_EXCLUDE_PATH\",\n\t\tvalue_name = \"PATTERN\",\n\t\tnum_args(1..)\n\t)]\n pub exclude_path: Option>,\n /// Sets the regex for matching git tags.\n #[arg(long, env = \"GIT_CLIFF_TAG_PATTERN\", value_name = \"PATTERN\")]\n pub tag_pattern: Option,\n /// Sets custom commit messages to include in the changelog.\n #[arg(\n\t\tlong,\n\t\tenv = \"GIT_CLIFF_WITH_COMMIT\",\n\t\tvalue_name = \"MSG\",\n\t\tnum_args(1..)\n\t)]\n pub with_commit: Option>,\n /// Sets custom message for the latest release.\n #[arg(\n\t\tlong,\n\t\tenv = \"GIT_CLIFF_WITH_TAG_MESSAGE\",\n\t\tvalue_name = \"MSG\",\n\t\tnum_args = 0..=1,\n\t)]\n pub with_tag_message: Option,\n /// Sets the tags to skip in the changelog.\n #[arg(long, env = \"GIT_CLIFF_SKIP_TAGS\", value_name = \"PATTERN\")]\n pub skip_tags: Option,\n /// Sets the tags to ignore in the changelog.\n #[arg(long, env = \"GIT_CLIFF_IGNORE_TAGS\", value_name = \"PATTERN\")]\n pub ignore_tags: Option,\n /// Sets the tags to count in the changelog.\n #[arg(long, env = \"GIT_CLIFF_COUNT_TAGS\", value_name = \"PATTERN\")]\n pub count_tags: Option,\n /// Sets commits that will be skipped in the changelog.\n #[arg(\n\t\tlong,\n\t\tenv = \"GIT_CLIFF_SKIP_COMMIT\",\n\t\tvalue_name = \"SHA1\",\n\t\tnum_args(1..)\n\t)]\n pub skip_commit: Option>,\n /// Prepends entries to the given changelog file.\n #[arg(\n\t short,\n\t long,\n\t env = \"GIT_CLIFF_PREPEND\",\n\t value_name = \"PATH\",\n\t value_parser = Opt::parse_dir\n\t)]\n pub prepend: Option,\n /// Writes output to the given file.\n #[arg(\n\t short,\n\t long,\n\t env = \"GIT_CLIFF_OUTPUT\",\n\t value_name = \"PATH\",\n\t value_parser = Opt::parse_dir,\n\t num_args = 0..=1,\n\t default_missing_value = DEFAULT_OUTPUT\n\t)]\n pub output: Option,\n /// Sets the tag for the latest version.\n #[arg(\n short,\n long,\n env = \"GIT_CLIFF_TAG\",\n value_name = \"TAG\",\n allow_hyphen_values = true\n )]\n pub tag: Option,\n /// Bumps the version for unreleased changes. Optionally with specified\n /// version.\n #[arg(\n long,\n value_name = \"BUMP\",\n value_enum,\n num_args = 0..=1,\n default_missing_value = \"auto\",\n value_parser = clap::value_parser!(BumpOption))]\n pub bump: Option,\n /// Prints bumped version for unreleased changes.\n #[arg(long, help_heading = Some(\"FLAGS\"))]\n pub bumped_version: bool,\n /// Sets the template for the changelog body.\n #[arg(\n short,\n long,\n env = \"GIT_CLIFF_TEMPLATE\",\n value_name = \"TEMPLATE\",\n allow_hyphen_values = true\n )]\n pub body: Option,\n /// Processes the commits starting from the latest tag.\n #[arg(short, long, help_heading = Some(\"FLAGS\"))]\n pub latest: bool,\n /// Processes the commits that belong to the current tag.\n #[arg(long, help_heading = Some(\"FLAGS\"))]\n pub current: bool,\n /// Processes the commits that do not belong to a tag.\n #[arg(short, long, help_heading = Some(\"FLAGS\"))]\n pub unreleased: bool,\n /// Sorts the tags topologically.\n #[arg(long, help_heading = Some(\"FLAGS\"))]\n pub topo_order: bool,\n /// Include only the tags that belong to the current branch.\n #[arg(long, help_heading = Some(\"FLAGS\"))]\n pub use_branch_tags: bool,\n /// Disables the external command execution.\n #[arg(long, help_heading = Some(\"FLAGS\"))]\n pub no_exec: bool,\n /// Prints changelog context as JSON.\n #[arg(short = 'x', long, help_heading = Some(\"FLAGS\"))]\n pub context: bool,\n /// Generates changelog from a JSON context.\n #[arg(\n long,\n\t value_name = \"PATH\",\n\t value_parser = Opt::parse_dir,\n\t\tenv = \"GIT_CLIFF_CONTEXT\",\n )]\n pub from_context: Option,\n /// Strips the given parts from the changelog.\n #[arg(short, long, value_name = \"PART\", value_enum)]\n pub strip: Option,\n /// Sets sorting of the commits inside sections.\n #[arg(\n\t\tlong,\n\t\tvalue_enum,\n\t\tdefault_value_t = Sort::Oldest\n\t)]\n pub sort: Sort,\n /// Sets the GitHub API token.\n #[arg(\n\t\tlong,\n\t\thelp_heading = \"REMOTE OPTIONS\",\n\t\tenv = \"GITHUB_TOKEN\",\n\t\tvalue_name = \"TOKEN\",\n\t\thide_env_values = true,\n\t\thide = !cfg!(feature = \"github\"),\n\t)]\n pub github_token: Option,\n /// Sets the GitHub repository.\n #[arg(\n\t\tlong,\n\t\thelp_heading = \"REMOTE OPTIONS\",\n\t\tenv = \"GITHUB_REPO\",\n\t\tvalue_parser = clap::value_parser!(RemoteValue),\n\t\tvalue_name = \"OWNER/REPO\",\n\t\thide = !cfg!(feature = \"github\"),\n\t)]\n pub github_repo: Option,\n /// Sets the GitLab API token.\n #[arg(\n\t\tlong,\n\t\thelp_heading = \"REMOTE OPTIONS\",\n\t\tenv = \"GITLAB_TOKEN\",\n\t\tvalue_name = \"TOKEN\",\n\t\thide_env_values = true,\n\t\thide = !cfg!(feature = \"gitlab\"),\n\t)]\n pub gitlab_token: Option,\n /// Sets the GitLab repository.\n #[arg(\n\t\tlong,\n\t\thelp_heading = \"REMOTE OPTIONS\",\n\t\tenv = \"GITLAB_REPO\",\n\t\tvalue_parser = clap::value_parser!(RemoteValue),\n\t\tvalue_name = \"OWNER/REPO\",\n\t\thide = !cfg!(feature = \"gitlab\"),\n\t)]\n pub gitlab_repo: Option,\n /// Sets the Gitea API token.\n #[arg(\n\t\tlong,\n\t\thelp_heading = \"REMOTE OPTIONS\",\n\t\tenv = \"GITEA_TOKEN\",\n\t\tvalue_name = \"TOKEN\",\n\t\thide_env_values = true,\n\t\thide = !cfg!(feature = \"gitea\"),\n\t)]\n pub gitea_token: Option,\n /// Sets the Gitea repository.\n #[arg(\n\t\tlong,\n\t\thelp_heading = \"REMOTE OPTIONS\",\n\t\tenv = \"GITEA_REPO\",\n\t\tvalue_parser = clap::value_parser!(RemoteValue),\n\t\tvalue_name = \"OWNER/REPO\",\n\t\thide = !cfg!(feature = \"gitea\"),\n\t)]\n pub gitea_repo: Option,\n /// Sets the Bitbucket API token.\n #[arg(\n\t\tlong,\n\t\thelp_heading = \"REMOTE OPTIONS\",\n\t\tenv = \"BITBUCKET_TOKEN\",\n\t\tvalue_name = \"TOKEN\",\n\t\thide_env_values = true,\n\t\thide = !cfg!(feature = \"bitbucket\"),\n\t)]\n pub bitbucket_token: Option,\n /// Sets the Bitbucket repository.\n #[arg(\n\t\tlong,\n\t\thelp_heading = \"REMOTE OPTIONS\",\n\t\tenv = \"BITBUCKET_REPO\",\n\t\tvalue_parser = clap::value_parser!(RemoteValue),\n\t\tvalue_name = \"OWNER/REPO\",\n\t\thide = !cfg!(feature = \"bitbucket\"),\n\t)]\n pub bitbucket_repo: Option,\n /// Sets the Azure DevOps API token.\n #[arg(\n\t\tlong,\n\t\thelp_heading = \"REMOTE OPTIONS\",\n\t\tenv = \"AZURE_DEVOPS_TOKEN\",\n\t\tvalue_name = \"TOKEN\",\n\t\thide_env_values = true,\n\t\thide = !cfg!(feature = \"azure_devops\"),\n\t)]\n pub azure_devops_token: Option,\n /// Sets the Azure DevOps repository.\n #[arg(\n\t\tlong,\n\t\thelp_heading = \"REMOTE OPTIONS\",\n\t\tenv = \"AZURE_DEVOPS_REPO\",\n\t\tvalue_parser = clap::value_parser!(RemoteValue),\n\t\tvalue_name = \"OWNER/REPO\",\n\t\thide = !cfg!(feature = \"azure_devops\"),\n\t)]\n pub azure_devops_repo: Option,\n /// Sets the commit range to process.\n #[arg(value_name = \"RANGE\", help_heading = Some(\"ARGS\"))]\n pub range: Option,\n /// Load TLS certificates from the native certificate store.\n #[arg(long, help_heading = Some(\"FLAGS\"), hide = !cfg!(feature = \"remote\"))]\n pub use_native_tls: bool,\n /// Disable network access for remote repositories.\n #[arg(long, env = \"GIT_CLIFF_OFFLINE\", help_heading = Some(\"REMOTE OPTIONS\"), hide = !cfg!(feature = \"remote\"))]\n pub offline: bool,\n}\n\n/// Custom type for the remote value.\n#[derive(Clone, Debug, PartialEq)]\npub struct RemoteValue(pub Remote);\n\nimpl ValueParserFactory for RemoteValue {\n type Parser = RemoteValueParser;\n fn value_parser() -> Self::Parser {\n RemoteValueParser\n }\n}\n\n/// Parser for the remote value.\n#[derive(Clone, Debug)]\npub struct RemoteValueParser;\n\nimpl TypedValueParser for RemoteValueParser {\n type Value = RemoteValue;\n fn parse_ref(\n &self,\n cmd: &clap::Command,\n arg: Option<&clap::Arg>,\n value: &std::ffi::OsStr,\n ) -> Result {\n let inner = clap::builder::StringValueParser::new();\n let mut value = inner.parse_ref(cmd, arg, value)?;\n if let Ok(url) = Url::parse(&value) {\n value = url.path().trim_start_matches('/').to_string();\n }\n let parts = value.rsplit_once('/');\n if let Some((owner, repo)) = parts {\n Ok(RemoteValue(Remote::new(\n owner.to_string(),\n repo.to_string(),\n )))\n } else {\n let mut err = clap::Error::new(ErrorKind::ValueValidation).with_cmd(cmd);\n if let Some(arg) = arg {\n err.insert(\n ContextKind::InvalidArg,\n ContextValue::String(arg.to_string()),\n );\n }\n err.insert(ContextKind::InvalidValue, ContextValue::String(value));\n Err(err)\n }\n }\n}\n\n#[derive(Debug, Clone, Eq, PartialEq)]\npub enum BumpOption {\n Auto,\n Specific(BumpType),\n}\n\nimpl ValueParserFactory for BumpOption {\n type Parser = BumpOptionParser;\n fn value_parser() -> Self::Parser {\n BumpOptionParser\n }\n}\n\n/// Parser for bump type.\n#[derive(Clone, Debug)]\npub struct BumpOptionParser;\n\nimpl TypedValueParser for BumpOptionParser {\n type Value = BumpOption;\n fn parse_ref(\n &self,\n cmd: &clap::Command,\n arg: Option<&clap::Arg>,\n value: &std::ffi::OsStr,\n ) -> Result {\n let inner = clap::builder::StringValueParser::new();\n let value = inner.parse_ref(cmd, arg, value)?;\n match value.as_str() {\n \"auto\" => Ok(BumpOption::Auto),\n \"major\" => Ok(BumpOption::Specific(BumpType::Major)),\n \"minor\" => Ok(BumpOption::Specific(BumpType::Minor)),\n \"patch\" => Ok(BumpOption::Specific(BumpType::Patch)),\n _ => {\n let mut err = clap::Error::new(ErrorKind::ValueValidation).with_cmd(cmd);\n if let Some(arg) = arg {\n err.insert(\n ContextKind::InvalidArg,\n ContextValue::String(arg.to_string()),\n );\n }\n err.insert(ContextKind::InvalidValue, ContextValue::String(value));\n Err(err)\n }\n }\n }\n}\n\nimpl Opt {\n /// Custom string parser for directories.\n ///\n /// Expands the tilde (`~`) character in the beginning of the\n /// input string into contents of the path returned by [`home_dir`].\n ///\n /// [`home_dir`]: dirs::home_dir\n fn parse_dir(dir: &str) -> Result {\n Ok(PathBuf::from(shellexpand::tilde(dir).to_string()))\n }\n}\n\n#[cfg(test)]\nmod tests {\n use std::ffi::OsStr;\n\n use clap::CommandFactory;\n\n use super::*;\n\n #[test]\n fn verify_cli() {\n Opt::command().debug_assert();\n }\n\n #[test]\n fn path_tilde_expansion() {\n let home_dir = dirs::home_dir().expect(\"cannot retrieve home directory\");\n let dir = Opt::parse_dir(\"~/\").expect(\"cannot expand tilde\");\n assert_eq!(home_dir, dir);\n }\n\n #[test]\n fn remote_value_parser() -> Result<(), clap::Error> {\n let remote_value_parser = RemoteValueParser;\n assert_eq!(\n RemoteValue(Remote::new(\"test\", \"repo\")),\n remote_value_parser.parse_ref(&Opt::command(), None, OsStr::new(\"test/repo\"))?\n );\n assert_eq!(\n RemoteValue(Remote::new(\"gitlab/group/test\", \"repo\")),\n remote_value_parser.parse_ref(\n &Opt::command(),\n None,\n OsStr::new(\"gitlab/group/test/repo\")\n )?\n );\n assert_eq!(\n RemoteValue(Remote::new(\"test\", \"testrepo\")),\n remote_value_parser.parse_ref(\n &Opt::command(),\n None,\n OsStr::new(\"https://github.com/test/testrepo\")\n )?\n );\n assert_eq!(\n RemoteValue(Remote::new(\n \"archlinux/packaging/packages\",\n \"arch-repro-status\"\n )),\n remote_value_parser.parse_ref(\n &Opt::command(),\n None,\n OsStr::new(\n \"https://gitlab.archlinux.org/archlinux/packaging/packages/arch-repro-status\"\n )\n )?\n );\n assert!(\n remote_value_parser\n .parse_ref(&Opt::command(), None, OsStr::new(\"test\"))\n .is_err()\n );\n assert!(\n remote_value_parser\n .parse_ref(&Opt::command(), None, OsStr::new(\"\"))\n .is_err()\n );\n Ok(())\n }\n\n #[test]\n fn bump_option_parser() -> Result<(), clap::Error> {\n let bump_option_parser = BumpOptionParser;\n assert_eq!(\n BumpOption::Auto,\n bump_option_parser.parse_ref(&Opt::command(), None, OsStr::new(\"auto\"))?\n );\n assert!(\n bump_option_parser\n .parse_ref(&Opt::command(), None, OsStr::new(\"test\"))\n .is_err()\n );\n assert_eq!(\n BumpOption::Specific(BumpType::Major),\n bump_option_parser.parse_ref(&Opt::command(), None, OsStr::new(\"major\"))?\n );\n Ok(())\n }\n}\n" }, { "path": "git-cliff/src/bin/completions.rs", "content": "use std::env;\nuse std::io::Result;\n\nuse clap::{CommandFactory, ValueEnum};\nuse clap_complete::Shell;\nuse git_cliff::args::Opt;\n\n/// Shell completions can be created with:\n/// `cargo run --bin git-cliff-completions`\n/// in a directory specified by the environment variable `OUT_DIR`.\n/// See \nfn main() -> Result<()> {\n let out_dir = env::var(\"OUT_DIR\").expect(\"OUT_DIR is not set\");\n let mut app = Opt::command();\n for &shell in Shell::value_variants() {\n clap_complete::generate_to(shell, &mut app, env!(\"CARGO_PKG_NAME\"), &out_dir)?;\n }\n println!(\"Completion scripts are generated in {out_dir:?}\");\n Ok(())\n}\n" }, { "path": "git-cliff/src/bin/mangen.rs", "content": "use std::io::Result;\nuse std::path::PathBuf;\nuse std::{env, fs};\n\nuse clap::CommandFactory;\nuse clap_mangen::Man;\nuse git_cliff::args::Opt;\n\n/// Man page can be created with:\n/// `cargo run --bin git-cliff-mangen`\n/// in a directory specified by the environment variable `OUT_DIR`.\n/// See \nfn main() -> Result<()> {\n let out_dir = env::var(\"OUT_DIR\").expect(\"OUT_DIR is not set\");\n let out_path = PathBuf::from(out_dir).join(format!(\"{}.1\", env!(\"CARGO_PKG_NAME\")));\n let app = Opt::command();\n let man = Man::new(app);\n let mut buffer = Vec::::new();\n man.render(&mut buffer)?;\n fs::write(&out_path, buffer)?;\n #[allow(clippy::unnecessary_debug_formatting)]\n {\n println!(\"Man page is generated at {out_path:?}\");\n }\n Ok(())\n}\n" }, { "path": "git-cliff/src/lib.rs", "content": "//! A highly customizable changelog generator ⛰️\n#![doc(\n html_logo_url = \"https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff.png\",\n html_favicon_url = \"https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/favicon/favicon.ico\"\n)]\n\n/// Command-line argument parser.\npub mod args;\n\n/// Custom logger implementation.\npub mod logger;\n\nuse std::env;\nuse std::fs::{self, File};\nuse std::io::{self, Write};\nuse std::path::{Path, PathBuf};\nuse std::time::{SystemTime, UNIX_EPOCH};\n\nuse args::{BumpOption, Opt, Sort, Strip};\nuse clap::ValueEnum;\nuse git_cliff_core::changelog::Changelog;\nuse git_cliff_core::commit::{Commit, Range};\nuse git_cliff_core::config::{CommitParser, Config};\nuse git_cliff_core::embed::{BuiltinConfig, EmbeddedConfig};\nuse git_cliff_core::error::{Error, Result};\nuse git_cliff_core::release::Release;\nuse git_cliff_core::repo::{Repository, SubmoduleRange};\nuse git_cliff_core::{DEFAULT_CONFIG, IGNORE_FILE};\nuse glob::Pattern;\n\n/// Checks for a new version on crates.io\n#[cfg(feature = \"update-informer\")]\npub fn check_new_version() {\n use update_informer::Check;\n let pkg_name = env!(\"CARGO_PKG_NAME\");\n let pkg_version = env!(\"CARGO_PKG_VERSION\");\n let informer = update_informer::new(update_informer::registry::Crates, pkg_name, pkg_version);\n if let Some(new_version) = informer.check_version().ok().flatten() {\n if new_version.semver().pre.is_empty() {\n log::info!(\"A new version of {pkg_name} is available: v{pkg_version} -> {new_version}\",);\n }\n }\n}\n\n/// Produces a commit range on the format `BASE..HEAD`, derived from the\n/// command line arguments and repository tags.\n///\n/// If no commit range could be determined, `None` is returned.\nfn determine_commit_range(\n args: &Opt,\n config: &Config,\n repository: &Repository,\n) -> Result> {\n let tags = repository.tags(\n &config.git.tag_pattern,\n args.topo_order,\n args.use_branch_tags,\n )?;\n\n let mut commit_range = args.range.clone();\n if args.unreleased {\n if let Some(last_tag) = tags.last().map(|(k, _)| k) {\n commit_range = Some(format!(\"{last_tag}..HEAD\"));\n }\n } else if args.latest || args.current {\n if tags.len() < 2 {\n let commits = repository.commits(None, None, None, config.git.topo_order_commits)?;\n if let (Some(tag1), Some(tag2)) = (\n commits.last().map(|c| c.id().to_string()),\n tags.get_index(0).map(|(k, _)| k),\n ) {\n if tags.len() == 1 {\n commit_range = Some(tag2.to_owned());\n } else {\n commit_range = Some(format!(\"{tag1}..{tag2}\"));\n }\n }\n } else {\n let mut tag_index = tags.len() - 2;\n if args.current {\n if let Some(current_tag_index) = repository.current_tag().as_ref().and_then(|tag| {\n tags.iter()\n .enumerate()\n .find(|(_, (_, v))| v.name == tag.name)\n .map(|(i, _)| i)\n }) {\n match current_tag_index.checked_sub(1) {\n Some(i) => tag_index = i,\n None => {\n return Err(Error::ChangelogError(String::from(\n \"No suitable tags found. Maybe run with '--topo-order'?\",\n )));\n }\n }\n } else {\n return Err(Error::ChangelogError(String::from(\n \"No tag exists for the current commit\",\n )));\n }\n }\n if let (Some(tag1), Some(tag2)) = (\n tags.get_index(tag_index).map(|(k, _)| k),\n tags.get_index(tag_index + 1).map(|(k, _)| k),\n ) {\n commit_range = Some(format!(\"{tag1}..{tag2}\"));\n }\n }\n }\n\n Ok(commit_range)\n}\n\n/// Process submodules and add commits to release.\nfn process_submodules(\n repository: &'static Repository,\n release: &mut Release,\n topo_order_commits: bool,\n) -> Result<()> {\n // Retrieve first and last commit of a release to create a commit range.\n let first_commit = release\n .previous\n .as_ref()\n .and_then(|previous_release| previous_release.commit_id.clone())\n .and_then(|commit_id| repository.find_commit(&commit_id));\n let last_commit = release\n .commit_id\n .clone()\n .and_then(|commit_id| repository.find_commit(&commit_id));\n\n log::debug!(\"Processing submodule commits in {first_commit:?}..{last_commit:?}\");\n\n // Query repository for submodule changes. For each submodule a\n // SubmoduleRange is created, describing the range of commits in the context\n // of that submodule.\n if let Some(last_commit) = last_commit {\n let submodule_ranges = repository.submodules_range(first_commit, last_commit)?;\n let submodule_commits = submodule_ranges.iter().filter_map(|submodule_range| {\n // For each submodule, the commit range is exploded into a list of\n // commits.\n let SubmoduleRange {\n repository: sub_repo,\n range: range_str,\n } = submodule_range;\n let commits = sub_repo\n .commits(Some(range_str), None, None, topo_order_commits)\n .ok()\n .map(|commits| commits.iter().map(Commit::from).collect());\n\n let submodule_path = sub_repo.path().to_string_lossy().into_owned();\n Some(submodule_path).zip(commits)\n });\n // Insert submodule commits into map.\n for (submodule_path, commits) in submodule_commits {\n release.submodule_commits.insert(submodule_path, commits);\n }\n }\n Ok(())\n}\n\n/// Initializes the configuration file.\npub fn init_config(name: Option<&str>, config_path: &Path) -> Result<()> {\n let contents = match name {\n Some(name) => BuiltinConfig::get_config(name.to_string())?,\n None => EmbeddedConfig::get_config()?,\n };\n\n let config_path = if config_path == Path::new(DEFAULT_CONFIG) {\n PathBuf::from(DEFAULT_CONFIG)\n } else {\n config_path.to_path_buf()\n };\n\n log::info!(\n \"Saving the configuration file{} to {}\",\n name.map(|v| format!(\" ({v})\")).unwrap_or_default(),\n config_path.display(),\n );\n\n fs::write(config_path, contents)?;\n\n Ok(())\n}\n\n/// Processes the tags and commits for creating release entries for the\n/// changelog.\n///\n/// This function uses the configuration and arguments to process the given\n/// repository individually.\nfn process_repository<'a>(\n repository: &'static Repository,\n config: &mut Config,\n args: &Opt,\n) -> Result>> {\n let mut tags = repository.tags(\n &config.git.tag_pattern,\n args.topo_order,\n args.use_branch_tags,\n )?;\n let skip_regex = config.git.skip_tags.as_ref();\n let ignore_regex = config.git.ignore_tags.as_ref();\n let count_tags = config.git.count_tags.as_ref();\n let recurse_submodules = config.git.recurse_submodules.unwrap_or(false);\n tags.retain(|_, tag| {\n let name = &tag.name;\n\n // Keep skip tags to drop commits in the later stage.\n let skip = skip_regex.is_some_and(|r| r.is_match(name));\n if skip {\n return true;\n }\n\n let count = count_tags.is_none_or(|r| {\n let count_tag = r.is_match(name);\n if count_tag {\n log::debug!(\"Counting release: {name}\");\n }\n count_tag\n });\n\n let ignore = ignore_regex.is_some_and(|r| {\n if r.as_str().trim().is_empty() {\n return false;\n }\n\n let ignore_tag = r.is_match(name);\n if ignore_tag {\n log::debug!(\"Ignoring release: {name}\");\n }\n ignore_tag\n });\n\n count && !ignore\n });\n\n if !config.remote.is_any_set() {\n match repository.upstream_remote() {\n Ok(remote) => {\n if !config.remote.github.is_set() {\n log::debug!(\"No GitHub remote is set, using remote: {remote}\");\n config.remote.github.owner = remote.owner;\n config.remote.github.repo = remote.repo;\n config.remote.github.is_custom = remote.is_custom;\n } else if !config.remote.gitlab.is_set() {\n log::debug!(\"No GitLab remote is set, using remote: {remote}\");\n config.remote.gitlab.owner = remote.owner;\n config.remote.gitlab.repo = remote.repo;\n config.remote.gitlab.is_custom = remote.is_custom;\n } else if !config.remote.gitea.is_set() {\n log::debug!(\"No Gitea remote is set, using remote: {remote}\");\n config.remote.gitea.owner = remote.owner;\n config.remote.gitea.repo = remote.repo;\n config.remote.gitea.is_custom = remote.is_custom;\n } else if !config.remote.bitbucket.is_set() {\n log::debug!(\"No Bitbucket remote is set, using remote: {remote}\");\n config.remote.bitbucket.owner = remote.owner;\n config.remote.bitbucket.repo = remote.repo;\n config.remote.bitbucket.is_custom = remote.is_custom;\n }\n }\n Err(e) => {\n log::debug!(\"Failed to get remote from repository: {e:?}\");\n }\n }\n }\n if args.use_native_tls {\n config.remote.enable_native_tls();\n }\n\n // Print debug information about configuration and arguments.\n log::trace!(\"Arguments: {args:#?}\");\n log::trace!(\"Config: {config:#?}\");\n\n // Parse commits.\n let commit_range = determine_commit_range(args, config, repository)?;\n\n // Include only the current directory if not running from the root repository.\n //\n // NOTE:\n // The conditions for including the current directory when not running from the root repository\n // have grown quite complex. This may warrant additional documentation to explain the behavior.\n //\n // Current logic triggers when all of the following are true:\n // - `cwd` is a child of the repository root but not the root itself\n // - `args.repository` is either None or empty\n // - `args.workdir` is None\n // - `include_path` is currently empty\n //\n // Additionally, if `include_path` is already explicitly set, it might be preferable to append.\n let cwd = env::current_dir()?;\n let mut include_path = config.git.include_paths.clone();\n if let Ok(root) = repository.root_path() {\n if cwd.starts_with(&root) &&\n cwd != root &&\n args.repository.as_ref().is_none_or(Vec::is_empty) &&\n args.workdir.is_none() &&\n include_path.is_empty()\n {\n let path = cwd.join(\"**\").join(\"*\");\n if let Ok(stripped) = path.strip_prefix(root) {\n log::info!(\n \"Including changes from the current directory: {}\",\n cwd.display()\n );\n include_path = vec![Pattern::new(stripped.to_string_lossy().as_ref())?];\n }\n }\n }\n\n let include_path = (!include_path.is_empty()).then_some(include_path);\n let exclude_path =\n (!config.git.exclude_paths.is_empty()).then_some(config.git.exclude_paths.clone());\n let mut commits = repository.commits(\n commit_range.as_deref(),\n include_path,\n exclude_path,\n config.git.topo_order_commits,\n )?;\n if let Some(commit_limit_value) = config.git.limit_commits {\n commits.truncate(commit_limit_value);\n }\n\n // Update tags.\n let mut releases = vec![Release::default()];\n let mut tag_timestamp = None;\n if let Some(ref tag) = args.tag {\n if let Some(commit_id) = commits.first().map(|c| c.id().to_string()) {\n match tags.get(&commit_id) {\n Some(tag) => {\n log::warn!(\"There is already a tag ({}) for {}\", tag.name, commit_id);\n tag_timestamp = Some(commits[0].time().seconds());\n }\n None => {\n tags.insert(commit_id, repository.resolve_tag(tag));\n }\n }\n } else {\n releases[0].version = Some(tag.clone());\n releases[0].timestamp = Some(\n SystemTime::now()\n .duration_since(UNIX_EPOCH)?\n .as_secs()\n .try_into()?,\n );\n }\n }\n\n // Process releases.\n let mut previous_release = Release::default();\n let mut first_processed_tag = None;\n let repository_path = repository.root_path()?.to_string_lossy().into_owned();\n for git_commit in commits.iter().rev() {\n let release = releases.last_mut().unwrap();\n let commit = Commit::from(git_commit);\n let commit_id = commit.id.clone();\n release.commits.push(commit);\n release.repository = Some(repository_path.clone());\n release.commit_id = Some(commit_id);\n if let Some(tag) = tags.get(release.commit_id.as_ref().unwrap()) {\n release.version = Some(tag.name.clone());\n release.message.clone_from(&tag.message);\n release.timestamp = if args.tag.as_deref() == Some(tag.name.as_str()) {\n match tag_timestamp {\n Some(timestamp) => Some(timestamp),\n None => Some(\n SystemTime::now()\n .duration_since(UNIX_EPOCH)?\n .as_secs()\n .try_into()?,\n ),\n }\n } else {\n Some(git_commit.time().seconds())\n };\n if first_processed_tag.is_none() {\n first_processed_tag = Some(tag);\n }\n previous_release.previous = None;\n release.previous = Some(Box::new(previous_release));\n previous_release = release.clone();\n releases.push(Release::default());\n }\n }\n\n debug_assert!(!releases.is_empty());\n\n if releases.len() > 1 {\n previous_release.previous = None;\n releases.last_mut().unwrap().previous = Some(Box::new(previous_release));\n }\n\n if args.sort == Sort::Newest {\n for release in &mut releases {\n release.commits.reverse();\n }\n }\n\n // Add custom commit messages to the latest release.\n if let Some(custom_commits) = &args.with_commit {\n releases\n .last_mut()\n .unwrap()\n .commits\n .extend(custom_commits.iter().cloned().map(Commit::from));\n }\n\n // Set the previous release if the first release does not have one set.\n if releases[0]\n .previous\n .as_ref()\n .and_then(|p| p.version.as_ref())\n .is_none()\n {\n // Get the previous tag of the first processed tag in the release loop.\n let first_tag = first_processed_tag\n .map(|tag| {\n tags.iter()\n .enumerate()\n .find(|(_, (_, v))| v.name == tag.name)\n .and_then(|(i, _)| i.checked_sub(1))\n .and_then(|i| tags.get_index(i))\n })\n .or_else(|| Some(tags.last()))\n .flatten();\n\n // Set the previous release if the first tag is found.\n if let Some((commit_id, tag)) = first_tag {\n let previous_release = Release {\n commit_id: Some(commit_id.clone()),\n version: Some(tag.name.clone()),\n timestamp: Some(\n repository\n .find_commit(commit_id)\n .map(|v| v.time().seconds())\n .unwrap_or_default(),\n ),\n ..Default::default()\n };\n releases[0].previous = Some(Box::new(previous_release));\n }\n }\n\n for release in &mut releases {\n // Set the commit ranges for all releases\n if !release.commits.is_empty() {\n release.commit_range = Some(match args.sort {\n Sort::Oldest => Range::new(\n release.commits.first().unwrap(),\n release.commits.last().unwrap(),\n ),\n Sort::Newest => Range::new(\n release.commits.last().unwrap(),\n release.commits.first().unwrap(),\n ),\n });\n }\n if recurse_submodules {\n process_submodules(repository, release, config.git.topo_order_commits)?;\n }\n }\n\n // Set custom message for the latest release.\n if let Some(message) = &args.with_tag_message {\n if let Some(latest_release) = releases\n .iter_mut()\n .rfind(|release| !release.commits.is_empty())\n {\n latest_release.message = Some(message.to_owned());\n }\n }\n\n Ok(releases)\n}\n\n/// Runs `git-cliff`.\n///\n/// # Example\n///\n/// ```no_run\n/// use clap::Parser;\n/// use git_cliff::args::Opt;\n/// use git_cliff_core::error::Result;\n///\n/// fn main() -> Result<()> {\n/// let args = Opt::parse();\n/// git_cliff::run(args)?;\n/// Ok(())\n/// }\n/// ```\npub fn run<'a>(args: Opt) -> Result> {\n run_with_changelog_modifier(args, |_| Ok(()))\n}\n\n/// Runs `git-cliff` with a changelog modifier.\n///\n/// This is useful if you want to modify the [`Changelog`] before\n/// it's written or the context is printed (depending how git-cliff is started).\n///\n/// # Example\n///\n/// ```no_run\n/// use clap::Parser;\n/// use git_cliff::args::Opt;\n/// use git_cliff_core::error::Result;\n///\n/// fn main() -> Result<()> {\n/// let args = Opt::parse();\n///\n/// git_cliff::run_with_changelog_modifier(args, |changelog| {\n/// println!(\"Releases: {:?}\", changelog.releases);\n/// Ok(())\n/// })?;\n///\n/// Ok(())\n/// }\n/// ```\npub fn run_with_changelog_modifier<'a>(\n mut args: Opt,\n changelog_modifier: impl FnOnce(&mut Changelog) -> Result<()>,\n) -> Result> {\n // Retrieve the built-in configuration.\n let builtin_config = BuiltinConfig::parse(args.config.to_string_lossy().to_string());\n\n // Set the working directory.\n if let Some(ref workdir) = args.workdir {\n args.config = workdir.join(args.config);\n match args.repository.as_mut() {\n Some(repository) => {\n repository\n .iter_mut()\n .for_each(|r| *r = workdir.join(r.clone()));\n }\n None => args.repository = Some(vec![workdir.clone()]),\n }\n if let Some(changelog) = args.prepend {\n args.prepend = Some(workdir.join(changelog));\n }\n // pushing an empty component force-adds a trailing path separator\n // which is needed for correct glob expansion\n args.include_path = Some(vec![Pattern::new(\n workdir.join(\"\").to_string_lossy().as_ref(),\n )?]);\n }\n\n // Set path for the configuration file.\n let mut path = args.config.clone();\n if !path.exists() {\n if let Some(config_path) = Config::retrieve_config_path() {\n path = config_path;\n }\n }\n\n // Parse the configuration file.\n // Load the default configuration if necessary.\n let mut config = if let Some(url) = &args.config_url {\n log::debug!(\"Using configuration file from: {url}\");\n #[cfg(feature = \"remote\")]\n {\n reqwest::blocking::get(url.clone())?\n .error_for_status()?\n .text()?\n .parse()?\n }\n #[cfg(not(feature = \"remote\"))]\n unreachable!(\"This option is not available without the 'remote' build-time feature\");\n } else if let Ok((config, name)) = builtin_config {\n log::info!(\"Using built-in configuration file: {name}\");\n config\n } else if path.exists() {\n Config::load(&path)?\n } else if let Some(contents) = Config::read_from_manifest()? {\n contents.parse()?\n } else if let Some(discovered_path) = env::current_dir()?.ancestors().find_map(|dir| {\n let path = dir.join(DEFAULT_CONFIG);\n if path.is_file() { Some(path) } else { None }\n }) {\n log::info!(\n \"Using configuration from parent directory: {}\",\n discovered_path.display()\n );\n Config::load(&discovered_path)?\n } else {\n #[allow(clippy::unnecessary_debug_formatting)]\n if !args.context {\n log::warn!(\n \"{:?} is not found, using the default configuration\",\n args.config\n );\n }\n EmbeddedConfig::parse()?\n };\n\n // Update the configuration based on command line arguments and vice versa.\n let output = args.output.clone().or(config.changelog.output.clone());\n match args.strip {\n Some(Strip::Header) => {\n config.changelog.header = None;\n }\n Some(Strip::Footer) => {\n config.changelog.footer = None;\n }\n Some(Strip::All) => {\n config.changelog.header = None;\n config.changelog.footer = None;\n }\n None => {}\n }\n if args.prepend.is_some() {\n config.changelog.footer = None;\n if !(args.unreleased || args.latest || args.range.is_some()) {\n return Err(Error::ArgumentError(String::from(\n \"'-u' or '-l' is not specified\",\n )));\n }\n }\n if output.is_some() && args.prepend.is_some() && output.as_ref() == args.prepend.as_ref() {\n return Err(Error::ArgumentError(String::from(\n \"'-o' and '-p' can only be used together if they point to different files\",\n )));\n }\n if let Some(body) = args.body.clone() {\n config.changelog.body = body;\n }\n if args.sort == Sort::Oldest {\n args.sort = Sort::from_str(&config.git.sort_commits, true)\n .expect(\"Incorrect config value for 'sort_commits'\");\n }\n if !args.topo_order {\n args.topo_order = config.git.topo_order;\n }\n\n if !args.use_branch_tags {\n args.use_branch_tags = config.git.use_branch_tags;\n }\n\n if args.github_token.is_some() {\n config.remote.github.token.clone_from(&args.github_token);\n }\n if args.gitlab_token.is_some() {\n config.remote.gitlab.token.clone_from(&args.gitlab_token);\n }\n if args.gitea_token.is_some() {\n config.remote.gitea.token.clone_from(&args.gitea_token);\n }\n if args.bitbucket_token.is_some() {\n config\n .remote\n .bitbucket\n .token\n .clone_from(&args.bitbucket_token);\n }\n if args.azure_devops_token.is_some() {\n config\n .remote\n .azure_devops\n .token\n .clone_from(&args.azure_devops_token);\n }\n if args.offline {\n config.remote.offline = args.offline;\n }\n if let Some(ref remote) = args.github_repo {\n config.remote.github.owner.clone_from(&remote.0.owner);\n config.remote.github.repo.clone_from(&remote.0.repo);\n config.remote.github.is_custom = true;\n }\n if let Some(ref remote) = args.gitlab_repo {\n config.remote.gitlab.owner.clone_from(&remote.0.owner);\n config.remote.gitlab.repo.clone_from(&remote.0.repo);\n config.remote.gitlab.is_custom = true;\n }\n if let Some(ref remote) = args.bitbucket_repo {\n config.remote.bitbucket.owner.clone_from(&remote.0.owner);\n config.remote.bitbucket.repo.clone_from(&remote.0.repo);\n config.remote.bitbucket.is_custom = true;\n }\n if let Some(ref remote) = args.gitea_repo {\n config.remote.gitea.owner.clone_from(&remote.0.owner);\n config.remote.gitea.repo.clone_from(&remote.0.repo);\n config.remote.gitea.is_custom = true;\n }\n if let Some(ref remote) = args.azure_devops_repo {\n config.remote.azure_devops.owner.clone_from(&remote.0.owner);\n config.remote.azure_devops.repo.clone_from(&remote.0.repo);\n config.remote.azure_devops.is_custom = true;\n }\n if args.no_exec {\n config\n .git\n .commit_preprocessors\n .iter_mut()\n .for_each(|v| v.replace_command = None);\n config\n .changelog\n .postprocessors\n .iter_mut()\n .for_each(|v| v.replace_command = None);\n }\n if args.skip_tags.is_some() {\n config.git.skip_tags.clone_from(&args.skip_tags);\n }\n config.git.skip_tags = config.git.skip_tags.filter(|r| !r.as_str().is_empty());\n if args.tag_pattern.is_some() {\n config.git.tag_pattern.clone_from(&args.tag_pattern);\n }\n if args.tag.is_some() {\n config.bump.initial_tag.clone_from(&args.tag);\n }\n if args.ignore_tags.is_some() {\n config.git.ignore_tags.clone_from(&args.ignore_tags);\n }\n if args.count_tags.is_some() {\n config.git.count_tags.clone_from(&args.count_tags);\n }\n if let Some(include_path) = &args.include_path {\n config\n .git\n .include_paths\n .extend(include_path.iter().cloned());\n }\n if let Some(exclude_path) = &args.exclude_path {\n config\n .git\n .exclude_paths\n .extend(exclude_path.iter().cloned());\n }\n\n // Process commits and releases for the changelog.\n if let Some(BumpOption::Specific(bump_type)) = args.bump {\n config.bump.bump_type = Some(bump_type);\n }\n\n // Generate changelog from context.\n let mut changelog: Changelog = if let Some(context_path) = args.from_context {\n let mut input: Box = if context_path == Path::new(\"-\") {\n Box::new(io::stdin())\n } else {\n Box::new(File::open(context_path)?)\n };\n let mut changelog = Changelog::from_context(&mut input, config)?;\n changelog.add_remote_context()?;\n changelog\n } else {\n // Process the repositories.\n let repositories: Vec = if let Some(paths) = &args.repository {\n paths\n .iter()\n .map(|p| {\n let abs_path = fs::canonicalize(p)?;\n Repository::discover(abs_path)\n })\n .collect::>>()?\n } else {\n let cwd = env::current_dir()?;\n vec![Repository::discover(cwd)?]\n };\n let mut releases = Vec::::new();\n let mut commit_range = None;\n for repository in repositories {\n // Skip commits\n let mut skip_list = Vec::new();\n let ignore_file = repository.root_path()?.join(IGNORE_FILE);\n if ignore_file.exists() {\n let contents = fs::read_to_string(ignore_file)?;\n let commits = contents\n .lines()\n .filter(|v| !(v.starts_with('#') || v.trim().is_empty()))\n .map(|v| String::from(v.trim()))\n .collect::>();\n skip_list.extend(commits);\n }\n if let Some(ref skip_commit) = args.skip_commit {\n skip_list.extend(skip_commit.clone());\n }\n for sha1 in skip_list {\n config.git.commit_parsers.insert(0, CommitParser {\n sha: Some(sha1.clone()),\n skip: Some(true),\n ..Default::default()\n });\n }\n\n // The commit range, used for determining the remote commits to include\n // in the changelog, doesn't make sense if multiple repositories are\n // specified. As such, pick the commit range from the last given\n // repository.\n commit_range = determine_commit_range(&args, &config, &repository)?;\n\n releases.extend(process_repository(\n Box::leak(Box::new(repository)),\n &mut config,\n &args,\n )?);\n }\n Changelog::new(releases, config, commit_range.as_deref())?\n };\n changelog_modifier(&mut changelog)?;\n\n Ok(changelog)\n}\n\n/// Writes the changelog to a file.\npub fn write_changelog(\n args: &Opt,\n mut changelog: Changelog<'_>,\n mut out: W,\n) -> Result<()> {\n let output = args\n .output\n .clone()\n .or(changelog.config.changelog.output.clone());\n if args.bump.is_some() || args.bumped_version {\n let next_version = if let Some(next_version) = changelog.bump_version()? {\n next_version\n } else if let Some(last_version) =\n changelog.releases.first().cloned().and_then(|v| v.version)\n {\n log::warn!(\"There is nothing to bump\");\n last_version\n } else if changelog.releases.is_empty() {\n changelog.config.bump.get_initial_tag()\n } else {\n return Ok(());\n };\n if let Some(tag_pattern) = &changelog.config.git.tag_pattern {\n if !tag_pattern.is_match(&next_version) {\n return Err(Error::ChangelogError(format!(\n \"Next version ({next_version}) does not match the tag pattern: {tag_pattern}\",\n )));\n }\n }\n if args.bumped_version {\n if changelog.config.changelog.output.is_none() {\n writeln!(out, \"{next_version}\")?;\n } else {\n writeln!(io::stdout(), \"{next_version}\")?;\n }\n return Ok(());\n }\n }\n if args.context {\n changelog.write_context(&mut out)?;\n return Ok(());\n }\n if let Some(path) = &args.prepend {\n let changelog_before = fs::read_to_string(path)?;\n let mut out = io::BufWriter::new(File::create(path)?);\n changelog.prepend(changelog_before, &mut out)?;\n }\n if output.is_some() || args.prepend.is_none() {\n changelog.generate(&mut out)?;\n }\n\n Ok(())\n}\n" }, { "path": "git-cliff/src/logger.rs", "content": "use std::io::Write;\nuse std::sync::atomic::{AtomicUsize, Ordering};\nuse std::{env, fmt};\n\nuse env_logger::Builder;\nuse env_logger::fmt::{Color, Style, StyledValue};\nuse git_cliff_core::error::{Error, Result};\n#[cfg(feature = \"remote\")]\nuse indicatif::{ProgressBar, ProgressStyle};\nuse log::Level;\n\n/// Environment variable to use for the logger.\nconst LOGGER_ENV: &str = \"RUST_LOG\";\n\n/// Global variable for storing the maximum width of the modules.\nstatic MAX_MODULE_WIDTH: AtomicUsize = AtomicUsize::new(0);\n\n/// Wrapper for the padded values.\nstruct Padded {\n value: T,\n width: usize,\n}\n\nimpl fmt::Display for Padded {\n fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {\n write!(f, \"{: usize {\n let max_width = MAX_MODULE_WIDTH.load(Ordering::Relaxed);\n if max_width < target.len() {\n MAX_MODULE_WIDTH.store(target.len(), Ordering::Relaxed);\n target.len()\n } else {\n max_width\n }\n}\n\n/// Adds colors to the given level and returns it.\nfn colored_level(style: &mut Style, level: Level) -> StyledValue<'_, &'static str> {\n match level {\n Level::Trace => style.set_color(Color::Magenta).value(\"TRACE\"),\n Level::Debug => style.set_color(Color::Blue).value(\"DEBUG\"),\n Level::Info => style.set_color(Color::Green).value(\"INFO \"),\n Level::Warn => style.set_color(Color::Yellow).value(\"WARN \"),\n Level::Error => style.set_color(Color::Red).value(\"ERROR\"),\n }\n}\n\n#[cfg(feature = \"remote\")]\nlazy_static::lazy_static! {\n /// Lazily initialized progress bar.\n pub static ref PROGRESS_BAR: ProgressBar = {\n let progress_bar = ProgressBar::new_spinner();\n progress_bar.set_style(\n ProgressStyle::with_template(\"{spinner:.green} {msg}\")\n .unwrap()\n .tick_strings(&[\n \"▹▹▹▹▹\",\n \"▸▹▹▹▹\",\n \"▹▸▹▹▹\",\n \"▹▹▸▹▹\",\n \"▹▹▹▸▹\",\n \"▹▹▹▹▸\",\n \"▪▪▪▪▪\",\n ]),\n );\n progress_bar\n };\n}\n\n/// Initializes the global logger.\n///\n/// This method also creates a progress bar which is triggered\n/// by the network operations that are related to GitHub.\n#[allow(unreachable_code, clippy::needless_return)]\npub fn init() -> Result<()> {\n let mut builder = Builder::new();\n builder.format(move |f, record| {\n let target = record.target();\n let max_width = max_target_width(target);\n\n let mut style = f.style();\n let level = colored_level(&mut style, record.level());\n\n let mut style = f.style();\n let target = style.set_bold(true).value(Padded {\n value: target,\n width: max_width,\n });\n\n #[cfg(feature = \"github\")]\n {\n let message = record.args().to_string();\n if message.starts_with(git_cliff_core::remote::github::START_FETCHING_MSG) {\n PROGRESS_BAR.enable_steady_tick(std::time::Duration::from_millis(80));\n PROGRESS_BAR.set_message(message);\n return Ok(());\n } else if message.starts_with(git_cliff_core::remote::github::FINISHED_FETCHING_MSG) {\n PROGRESS_BAR.finish_and_clear();\n return Ok(());\n }\n }\n\n #[cfg(feature = \"gitlab\")]\n {\n let message = record.args().to_string();\n if message.starts_with(git_cliff_core::remote::gitlab::START_FETCHING_MSG) {\n PROGRESS_BAR.enable_steady_tick(std::time::Duration::from_millis(80));\n PROGRESS_BAR.set_message(message);\n return Ok(());\n } else if message.starts_with(git_cliff_core::remote::gitlab::FINISHED_FETCHING_MSG) {\n PROGRESS_BAR.finish_and_clear();\n return Ok(());\n }\n }\n\n #[cfg(feature = \"gitea\")]\n {\n let message = record.args().to_string();\n if message.starts_with(git_cliff_core::remote::gitea::START_FETCHING_MSG) {\n PROGRESS_BAR.enable_steady_tick(std::time::Duration::from_millis(80));\n PROGRESS_BAR.set_message(message);\n return Ok(());\n } else if message.starts_with(git_cliff_core::remote::gitea::FINISHED_FETCHING_MSG) {\n PROGRESS_BAR.finish_and_clear();\n return Ok(());\n }\n }\n\n #[cfg(feature = \"bitbucket\")]\n {\n let message = record.args().to_string();\n if message.starts_with(git_cliff_core::remote::bitbucket::START_FETCHING_MSG) {\n PROGRESS_BAR.enable_steady_tick(std::time::Duration::from_millis(80));\n PROGRESS_BAR.set_message(message);\n return Ok(());\n } else if message.starts_with(git_cliff_core::remote::bitbucket::FINISHED_FETCHING_MSG)\n {\n PROGRESS_BAR.finish_and_clear();\n return Ok(());\n }\n }\n\n writeln!(f, \" {} {} > {}\", level, target, record.args())\n });\n\n if let Ok(var) = env::var(LOGGER_ENV) {\n builder.parse_filters(&var);\n }\n\n builder\n .try_init()\n .map_err(|e| Error::LoggerError(e.to_string()))\n}\n" }, { "path": "git-cliff/src/main.rs", "content": "use std::fs::File;\nuse std::path::Path;\nuse std::{env, io, process};\n\nuse clap::Parser;\nuse git_cliff::args::Opt;\nuse git_cliff::{init_config, logger};\nuse git_cliff_core::error::Result;\n\n/// Profiler.\n#[cfg(feature = \"profiler\")]\nmod profiler;\n\nfn main() -> Result<()> {\n // Parse the command line arguments\n let args = Opt::parse();\n if args.verbose == 1 {\n unsafe { env::set_var(\"RUST_LOG\", \"debug\") };\n } else if args.verbose > 1 {\n unsafe { env::set_var(\"RUST_LOG\", \"trace\") };\n } else if env::var_os(\"RUST_LOG\").is_none() {\n unsafe { env::set_var(\"RUST_LOG\", \"info\") };\n }\n logger::init()?;\n\n // Initialize the profiler guard if the feature is enabled\n let mut _profiler_guard = None;\n #[cfg(feature = \"profiler\")]\n {\n _profiler_guard = profiler::start_profiling();\n }\n #[cfg(not(feature = \"profiler\"))]\n {\n _profiler_guard = Some(());\n }\n\n // Check if there is a new version available.\n #[cfg(feature = \"update-informer\")]\n if !args.offline {\n git_cliff::check_new_version();\n }\n\n // Create the configuration file if init flag is given.\n if let Some(path) = &args.init {\n init_config(path.as_deref(), &args.config)?;\n return Ok(());\n }\n\n // Generate a changelog.\n let changelog = git_cliff::run(args.clone())?;\n\n // Get output destination.\n let output = args\n .output\n .clone()\n .or(changelog.config.changelog.output.clone());\n let out: Box = if let Some(path) = &output {\n if path == Path::new(\"-\") {\n Box::new(io::stdout())\n } else {\n Box::new(io::BufWriter::new(File::create(path)?))\n }\n } else {\n Box::new(io::stdout())\n };\n\n // Write the changelog.\n let exit_code = match git_cliff::write_changelog(&args, changelog, out) {\n Ok(_) => 0,\n Err(e) => {\n log::error!(\"{e}\");\n 1\n }\n };\n\n // Report the profiler if the feature is enabled\n #[cfg(feature = \"profiler\")]\n {\n profiler::finish_profiling(_profiler_guard)?;\n }\n\n process::exit(exit_code);\n}\n" }, { "path": "git-cliff/src/profiler.rs", "content": "use git_cliff_core::error::Result;\n\n/// Creates a profiler guard and returns it.\npub(crate) fn start_profiling() -> Option> {\n match pprof::ProfilerGuardBuilder::default()\n .frequency(1000)\n .blocklist(&[\"libc\", \"libgcc\", \"pthread\", \"vdso\"])\n .build()\n {\n Ok(guard) => Some(guard),\n Err(e) => {\n log::error!(\"Failed to build profiler guard: {e}\");\n None\n }\n }\n}\n\n/// Reports the profiling results.\npub(crate) fn finish_profiling(profiler_guard: Option) -> Result<()> {\n match profiler_guard\n .expect(\"failed to retrieve profiler guard\")\n .report()\n .build()\n {\n Ok(report) => {\n #[cfg(feature = \"profiler-flamegraph\")]\n {\n use std::fs::File;\n let random = rand::random::();\n let file = File::create(format!(\n \"{}.{random}.flamegraph.svg\",\n env!(\"CARGO_PKG_NAME\"),\n ))?;\n if let Err(e) = report.flamegraph(file) {\n log::error!(\"Failed to create flamegraph file: {e}\");\n }\n }\n\n #[cfg(not(feature = \"profiler-flamegraph\"))]\n {\n log::info!(\"Report profiling: {:?}\", &report);\n }\n }\n Err(e) => {\n log::error!(\"Failed to build profiler report: {e}\");\n }\n }\n\n Ok(())\n}\n" }, { "path": "git-cliff-core/Cargo.toml", "content": "[package]\nname = \"git-cliff-core\"\nversion = \"2.12.0\" # managed by release.sh\ndescription = \"Core library of git-cliff\"\nauthors = [\"git-cliff contributors \"]\nlicense = \"MIT OR Apache-2.0\"\nreadme = \"../README.md\"\nhomepage = \"https://github.com/orhun/git-cliff\"\nrepository = \"https://github.com/orhun/git-cliff\"\nkeywords = [\"changelog\", \"generator\", \"conventional\", \"commit\"]\nedition = \"2024\"\nrust-version = \"1.85.1\"\n\n[features]\ndefault = [\"repo\"]\n## Enable parsing commits from a git repository.\n## You can turn this off if you already have the commits to put in the\n## changelog and you don't need `git-cliff` to parse them.\nrepo = [\"dep:git2\"]\n# Enable integration with remote repositories.\nremote = [\n \"dep:reqwest\",\n \"dep:http-cache-reqwest\",\n \"dep:reqwest-middleware\",\n \"dep:tokio\",\n \"dep:futures\",\n \"dep:async-stream\",\n]\n## Enable integration with GitHub.\n## You can turn this off if you don't use GitHub and don't want\n## to make network requests to the GitHub API.\ngithub = [\"remote\"]\n## Enable integration with GitLab.\n## You can turn this off if you don't use GitLab and don't want\n## to make network requests to the GitLab API.\ngitlab = [\"remote\"]\n## Enable integration with Bitbucket.\n## You can turn this off if you don't use Bitbucket and don't want\n## to make network requests to the Bitbucket API.\nbitbucket = [\"remote\"]\n## Enable integration with Gitea.\n## You can turn this off if you don't use Gitea and don't want\n## to make network requests to the Gitea API.\ngitea = [\"remote\"]\n## Enable integration with Azure DevOps.\n## You can turn this off if you don't use Azure DevOps and don't want\n## to make network requests to the Azure DevOps API.\nazure_devops = [\"remote\"]\n\n[dependencies]\nglob.workspace = true\nregex.workspace = true\nlog.workspace = true\nsecrecy.workspace = true\ndirs.workspace = true\nlazy_static.workspace = true\nthiserror = \"2.0.17\"\nserde = { version = \"1.0.228\", features = [\"derive\"] }\nserde_json = \"1.0.145\"\nbincode = \"2.0.1\"\nserde_regex = \"1.1.0\"\ntera = \"1.20.1\"\nindexmap = { version = \"2.13.0\", features = [\"serde\"] }\ntoml = \"0.9.8\"\nlazy-regex = \"3.6.0\"\nnext_version = \"0.2.26\"\nsemver = \"1.0.27\"\ndocument-features = { version = \"0.2.12\", optional = true }\nreqwest = { workspace = true, optional = true }\nhttp-cache-reqwest = { version = \"0.15.0\", optional = true }\nreqwest-middleware = { version = \"0.4.0\", optional = true }\ntokio = { version = \"1.49.0\", features = [\n \"rt-multi-thread\",\n \"macros\",\n], optional = true }\nfutures = { version = \"0.3.31\", optional = true }\nasync-stream = { version = \"0.3.6\", optional = true }\nurl.workspace = true\ndyn-clone = \"1.0.17\"\nurlencoding = \"2.1.3\"\n# `tokio-runtime` is already enabled transitively by the CLI. This just avoids runtime-less build failures.\n# See: https://github.com/zkat/cacache-rs/issues/92\ncacache = { version = \"13.1.0\", features = [\"mmap\", \"tokio-runtime\"], default-features = false }\ntime = \"0.3.44\"\nchrono = { version = \"0.4.41\", features = [\"serde\"] }\n\n[dependencies.git2]\nversion = \"0.20.3\"\ndefault-features = false\noptional = true\n\n[dependencies.config]\nversion = \"0.15.19\"\ndefault-features = false\nfeatures = [\"toml\", \"yaml\"]\n\n[dependencies.git-conventional]\nversion = \"0.12.7\"\nfeatures = [\"serde\"]\n\n[dependencies.rust-embed]\nversion = \"8.11.0\"\nfeatures = [\"debug-embed\", \"compression\"]\n\n[dev-dependencies]\npretty_assertions = \"1.4.1\"\nexpect-test = \"1.5.1\"\ntemp-dir = \"0.1.16\"\n\n[package.metadata.docs.rs]\nall-features = true\nrustdoc-args = [\"--cfg\", \"docsrs\"]\n\n[lints]\nworkspace = true\n" }, { "path": "git-cliff-core/src/changelog.rs", "content": "use std::collections::HashMap;\nuse std::io::{Read, Write};\nuse std::time::{SystemTime, UNIX_EPOCH};\n\nuse crate::commit::Commit;\nuse crate::config::{Config, GitConfig};\nuse crate::error::{Error, Result};\nuse crate::release::{Release, Releases};\n#[cfg(feature = \"azure_devops\")]\nuse crate::remote::azure_devops::AzureDevOpsClient;\n#[cfg(feature = \"bitbucket\")]\nuse crate::remote::bitbucket::BitbucketClient;\n#[cfg(feature = \"gitea\")]\nuse crate::remote::gitea::GiteaClient;\n#[cfg(feature = \"github\")]\nuse crate::remote::github::GitHubClient;\n#[cfg(feature = \"gitlab\")]\nuse crate::remote::gitlab::GitLabClient;\nuse crate::summary::Summary;\nuse crate::template::Template;\n\n/// Changelog generator.\n#[derive(Debug)]\npub struct Changelog<'a> {\n /// Releases that the changelog will contain.\n pub releases: Vec>,\n /// Configuration used for generating the changelog.\n pub config: Config,\n header_template: Option