Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://commitizen-tools.github.io/commitizen/config/ below:

Configuration - Commitizen

• Type: str
• Default: "cz_conventional_commits"

Name of the committing rules to use.

• Type: str
• Default: None

Current version. Example: "0.1.2". Required if you use version_provider = "commitizen".

• Type: list
• Default: []

Files (or glob patterns) where the version will be updated. A pattern to match a line, can also be specified, separated by : Read more

• Type: str
• Default: commitizen

Version provider used to read and write version. Read more

• Type: str
• Default: pep440

Select a version scheme from the following options:

• pep440
• semver
• semver2

Useful for non-python projects. Read more

• Type: str
• Default: $version

Format for the git tag, useful for old projects, that use a convention like "v1.2.1". Read more

• Type: list
• Default: []

Legacy git tag formats, useful for old projects that changed tag format. Tags matching those formats will be recognized as version tags and be included in the changelog. Each entry uses the syntax as tag_format. Read more

• Type: list
• Default: []

Tags matching those formats will be totally ignored and won't raise a warning. Each entry uses the syntax as tag_format with the addition of * that will match everything (non-greedy). Read more

• Type: bool
• Default: False

Create changelog when running cz bump.

• Type: bool
• Default: False

Use gpg signed tags instead of lightweight tags.

• Type: bool
• Default: False

Use annotated tags instead of lightweight tags. See difference

• Type: str
• Default: None

Create custom commit message. Useful to skip CI. Read more

• Type: bool
• Default: False

Automatically retry failed commit when running cz commit. Read more

• Type: bool
• Default: False

Disallow empty commit messages. Useful in CI. Read more

• Type: list
• Default: ["Merge", "Revert", "Pull request", "fixup!", "squash!"]

List of prefixes that commitizen ignores when verifying messages. Read more

• Type: str
• Default: CHANGELOG.md

Filename of exported changelog

• Type: str
• Default: None

Format used to parse and generate the changelog. If not specified, guessed from changelog_file.

• Type: bool
• Default: False

Update changelog with the missing versions. This is good if you don't want to replace previous versions in the file.

Note

When doing cz bump --changelog this is automatically set to True

• Type: str
• Default: None

Start from a given git rev to generate the changelog

• Type: bool
• Default: False

Collect all changes of prerelease versions into the next non-prerelease version when creating the changelog.

• Type: list
• Default: []

Style for the prompts (It will merge this value with default style.) See More (Styling your prompts with your favorite colors)

• Type: dict
• Default: None

This is only supported when config through toml. Custom rules for committing and bumping. Read more

• Type: bool
• Default: False

If enabled, Commitizen will show keyboard shortcuts when selecting from a list. Define a key for each of your choices to set the key. Read more

• Type: bool
• Default: False

If enabled, breaking changes on a 0.x will remain as a 0.x version. Otherwise, a breaking change will bump a 0.x version to 1.0. Read more

• Type: int
• Default: 0

In some circumstances, a prerelease cannot start with 0-for example, in embedded projects where individual characters are encoded as bytes. You can specify an offset from which to start counting. Read more

• Type: list[str]
• Default: []

Calls the hook scripts before bumping version. Read more

• Type: list[str]
• Default: []

Calls the hook scripts after bumping the version. Read more

• Type: str
• Default: "utf-8"

Sets the character encoding to be used when parsing commit messages. Read more

• Type: str
• Default: None (provided by plugin)

Provide custom changelog jinja template path relative to the current working directory. Read more

• Type: dict[str, Any]
• Default: {}

Provide extra variables to the changelog template. Read more

Default and recommended configuration format for a project. For a python project, we recommend adding an entry to your pyproject.toml. You can also create a .cz.toml or cz.toml file at the root of your project folder.

Example configuration:

[tool.commitizen]
name = "cz_conventional_commits"
version = "0.1.0"
version_files = [
    "src/__version__.py",
    "pyproject.toml:version"
]
update_changelog_on_bump = true
style = [
    ["qmark", "fg:#ff9d00 bold"],
    ["question", "bold"],
    ["answer", "fg:#ff9d00 bold"],
    ["pointer", "fg:#ff9d00 bold"],
    ["highlighted", "fg:#ff9d00 bold"],
    ["selected", "fg:#cc5454"],
    ["separator", "fg:#cc5454"],
    ["instruction", ""],
    ["text", ""],
    ["disabled", "fg:#858585 italic"]
]

Commitizen has support for JSON configuration. Recommended for NodeJS projects.

{
  "commitizen": {
    "name": "cz_conventional_commits",
    "version": "0.1.0",
    "version_files": ["src/__version__.py", "pyproject.toml:version"],
    "style": [
      ["qmark", "fg:#ff9d00 bold"],
      ["question", "bold"],
      ["answer", "fg:#ff9d00 bold"],
      ["pointer", "fg:#ff9d00 bold"],
      ["highlighted", "fg:#ff9d00 bold"],
      ["selected", "fg:#cc5454"],
      ["separator", "fg:#cc5454"],
      ["instruction", ""],
      ["text", ""],
      ["disabled", "fg:#858585 italic"]
    ]
  }
}

YAML configuration is supported by Commitizen. Recommended for Go, ansible, or even helm charts projects.

commitizen:
  name: cz_conventional_commits
  version: 0.1.0
  version_files:
    - src/__version__.py
    - pyproject.toml:version
  style:
    - - qmark
      - fg:#ff9d00 bold
    - - question
      - bold
    - - answer
      - fg:#ff9d00 bold
    - - pointer
      - fg:#ff9d00 bold
    - - highlighted
      - fg:#ff9d00 bold
    - - selected
      - fg:#cc5454
    - - separator
      - fg:#cc5454
    - - instruction
      - ""
    - - text
      - ""
    - - disabled
      - fg:#858585 italic

Commitizen can read and write version from different sources. By default, it uses the commitizen one which is using the version field from the Commitizen settings. But you can use any commitizen.provider entrypoint as value for version_provider.

Commitizen provides some version providers for some well known formats:

Note

The scm provider is meant to be used with setuptools-scm or any packager *-scm plugin.

An example in your .cz.toml or cz.toml would look like this:

[tool.commitizen]
version_provider = "pep621"

You can add your own version provider by extending VersionProvider and exposing it on the commitizen.provider entrypoint.

Here is a quick example of a provider my_provider.py, reading and writing version in a VERSION file.

from pathlib import Path
from commitizen.providers import VersionProvider


class MyProvider(VersionProvider):
    file = Path() / "VERSION"

    def get_version(self) -> str:
        return self.file.read_text()

    def set_version(self, version: str):
        self.file.write_text(version)

from setuptools import setup

setup(
    name="my-commitizen-provider",
    version="0.1.0",
    py_modules=["my_provider"],
    install_requires=["commitizen"],
    entry_points={
        "commitizen.provider": [
            "my-provider = my_provider:MyProvider",
        ]
    },
)

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4