Skip to content

config.md

Latest commit

 

History

History
142 lines (130 loc) · 5.09 KB

config.md

File metadata and controls

142 lines (130 loc) · 5.09 KB

Configuration

pyproject.toml or .cz.toml

Add an entry to pyproject.toml or .cz.toml. Recommended for python projects.

[tool.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"]
]

.cz.toml is recommended for other languages projects (js, go, etc).

.cz.json or cz.json

JSON might be a more common configuration format for non-python projects, so Commitizen supports JSON config files, now.

{
    "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"
            ]
        ]
    }
}

.cz.yaml or cz.yaml

YAML is another format for non-python proyects as well, supported by Commitizen:

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

Settings

Variable Type Default Description
name str "cz_conventional_commits" Name of the committing rules to use
version str None Current version. Example: "0.1.2"
version_files list [ ] Files were the version will be updated. A pattern to match a line, can also be specified, separated by : See more
tag_format str None Format for the git tag, useful for old projects, that use a convention like "v1.2.1". See more
bump_message str None Create custom commit message, useful to skip ci. See more
changelog_file str CHANGELOG.md filename of exported changelog
style list see above Style for the prompts (It will merge this value with default style.) See More (Styling your prompts with your favorite colors)
customize dict None This is only supported when config through toml. Custom rules for committing and bumping. See more
use_shortcuts bool 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. See more