Configuration

Configuration

members

The members of the project.

Default value: {}

Type: dict

Example usage:

1
2
3

[members]
pkg1 = "packages/pkg1"
pkg2 = "packages/pkg2"

changelog

changelog-heading

Template for the changelog heading. Must contain {version} placeholder.

Default value: "{version}"

Type: string

Example usage:

1
2

[changelog]
changelog-heading = "{version}"

changelog-path

Path to the changelog file. Defaults to CHANGELOG.md.

Default value: CHANGELOG.md

Type: string

Example usage:

1
2

[changelog]
changelog-path = "CHANGELOG.md"

ignore-contributors

Contributors to ignore when generating changelog.

Default value: []

Type: list

Example usage:

1
2

[changelog]
ignore-contributors = ["dependabot[bot]"]

ignore-labels

Labels to ignore when generating changelog.

Default value: []

Type: list

Example usage:

1
2

[changelog]
ignore-labels = ["internal", "ci", "testing"]

include-contributors

Whether to include contributors in the changelog. Defaults to true.

Default value: true

Type: boolean

Example usage:

1
2

[changelog]
include-contributors = true

section-labels

Mapping of section names to labels. Use __unknown__ to include unlabeled pull requests.

Default value: {}

Type: dict

Example usage:

1
2
3

[changelog.section-labels]
"Breaking changes" = ["breaking"]
"Enhancements" = ["enhancement", "compatibility"]

release

branch-name

The branch name to use when creating a new release branch.

Default value: null

Type: string

Example usage:

1
2

[release]
branch-name = "release-{version}"

commit-message

The commit message to use when committing the release changes.

Default value: null

Type: string

Example usage:

1
2

[release]
commit-message = "Release {version}"

confirm

Whether to confirm the release changes with the user before proceeding.

Default value: true

Type: boolean

Example usage:

1
2

[release]
confirm = true

current-version

The current version of the project.

Required

Type: string

Example usage:

1
2

[release]
current-version = "0.1.0"

on-pre-commit-failure

Behavior when a pre-commit command fails.

Default value: abort

Type: string

Example usage:

1
2

[release]
on-pre-commit-failure = "abort"  # or "continue"

pre-commit-commands

Commands to run before committing. These run after git add -A and before git commit. A second git add -A is run after these commands to stage any changes they make.

Default value: []

Type: list

Example usage:

1
2

[release]
pre-commit-commands = ["cargo fmt", "npm run lint:fix"]

push

Whether to push the release changes to the remote repository.

Default value: false

Type: boolean

Example usage:

1
2

[release]
push = false

version-files

The version files that need to be updated.

Default value: []

Type: list

Example usage:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

[[release.version-files]]
path = "**/Cargo.toml"
format = "toml"
field = "package.version"

[[release.version-files]]
path = "version.sh"
format = "text"

[[release.version-files]]
path = "version.sh"
search = "export FULL_VERSION = '{version}'"

[[release.version-files]]
path = "README.md"

[release]
version-files = [
    "docs/version.txt"
]

release.pull-request

Pull request configuration for release bumps.

base

Base branch for the pull request.

Default value: branch from which the release branch was created

Type: string

Example usage:

1
2

[release.pull-request]
base = "main"

body

Pull request body template. Supports the {version} placeholder.

Default value: generated changelog section or empty

Type: string

Example usage:

1
2

[release.pull-request]
body = "Prepare release v{version}."

draft

Whether the pull request should be a draft.

Default value: false

Type: boolean

Example usage:

1
2

[release.pull-request]
draft = true

title

Pull request title template. Supports the {version} placeholder.

Default value: resolved commit message

Type: string

Example usage:

1
2

[release.pull-request]
title = "Release v{version}"