Configuration
Configuration
members
The members of the project.
Default value: {}
Type: dict
Example usage:
| TOML | |
|---|---|
1 2 3 | |
changelog
changelog-heading
Template for the changelog heading. Must contain {version} placeholder.
Default value: "{version}"
Type: string
Example usage:
| TOML | |
|---|---|
1 2 | |
changelog-path
Path to the changelog file. Defaults to CHANGELOG.md.
Default value: CHANGELOG.md
Type: string
Example usage:
| TOML | |
|---|---|
1 2 | |
ignore-contributors
Contributors to ignore when generating changelog.
Default value: []
Type: list
Example usage:
| TOML | |
|---|---|
1 2 | |
ignore-labels
Labels to ignore when generating changelog.
Default value: []
Type: list
Example usage:
| TOML | |
|---|---|
1 2 | |
include-contributors
Whether to include contributors in the changelog. Defaults to true.
Default value: true
Type: boolean
Example usage:
| TOML | |
|---|---|
1 2 | |
section-labels
Mapping of section names to labels.
Default value: {}
Type: dict
Example usage:
| TOML | |
|---|---|
1 2 3 | |
release
branch-name
The branch name to use when creating a new release branch.
Default value: null
Type: string
Example usage:
| TOML | |
|---|---|
1 2 | |
commit-message
The commit message to use when committing the release changes.
Default value: null
Type: string
Example usage:
| TOML | |
|---|---|
1 2 | |
confirm
Whether to confirm the release changes with the user before proceeding.
Default value: true
Type: boolean
Example usage:
| TOML | |
|---|---|
1 2 | |
current-version
The current version of the project.
Required
Type: string
Example usage:
| TOML | |
|---|---|
1 2 | |
push
Whether to push the release changes to the remote repository.
Default value: false
Type: boolean
Example usage:
| TOML | |
|---|---|
1 2 | |
version-files
The version files that need to be updated.
Default value: []
Type: list
Example usage:
| TOML | |
|---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |