cz-bitbucket-jira-plugin

An Commitizen plugin that links your Bitbucket commits with your Jira issues.

Installation

pip install cz-bitbucket-jira-plugin

Configuration

Theres 2 possible configuration files: pyproject.toml and cz.toml. Up to you.

Tip

If you already has an pyproject.toml in your project, use him. If not, create an cz.toml.

The only required configuration is:

[tool.commitizen]
name = "cz-bitbucket-jira-plugin"

This tell to commitizen which plugin you want to use.

But...

To avoid the need to type your Jira project key for every commit, you can set this up in your chosen configuration file:

[tool.commitizen]
name = "cz-bitbucket-jira-plugin"
jira_project_key = "DEV"

Now every time you execute cz commit, commitizen will use the cz-bitbucket-jira-plugin and use "DEV" as your default Jira project key.

Minimum length for commit messages

You can set an minimum length for commit messages to prevent things like "fix", "wip", "test", "aaa", and so on...

To do this, set this up in your chosen configuration file:

[tool.commitizen]
name = "cz-bitbucket-jira-plugin"
commit_message_minimum_length = 32

The default value for this config is 32.

Usage

As long it's an Commitizen plugin, you can:

cz

Customization

You can change some defaults of the plugin:

Prompt style

To change the default prompt style that are:

prompt_style = [
    { identifier = "qmark", style = "fg:#FF5555" },
    { identifier = "question", style = "fg:#BD93F9" },
    { identifier = "answer", style = "fg:#F8F8F2 nobold" },
    { identifier = "pointer", style = "fg:#50FA7B nobold" },
    { identifier = "highlighted", style = "fg:#50FA7B" },
    { identifier = "selected", style = "fg:#50FA7B" },
    { identifier = "separator", style = "fg:#858585" },
    { identifier = "instruction", style = "fg:#858585 nobold" },
    { identifier = "text", style = "fg:#F8F8F2" },
    { identifier = "disabled", style = "fg:#858585 italic" },
]

You can create the prompt_style key on your config file. This key must be an array of inline tables. Each inline table must have two pair of key/value.

Example:

[tool.commitizen]
name = "cz-bitbucket-jira-plugin"
jira_project_key = "DEV"
prompt_style = [
    { identifier = "question", style = "fg:#50FA7B bold" },
    { identifier = "answer", style = "fg:#F8F8F2 nobold" }
]

The available identifiers are:

• qmark
• question
• answer
• pointer
• highlighted
• selected
• separador
• instruction
• text
• disabled

You can check this also on https://questionary.readthedocs.io/en/stable/pages/advanced.html#themes-styling

For the complete styling documentation check https://python-prompt-toolkit.readthedocs.io/en/stable/pages/advanced_topics/styling.html

Commit types

To change the default commit types that are:

commit_types = [
    { value = "init", name = "init: initial commit to set up your repository" },
    { value = "feat", name = "feat: introduce a new feature" },
    { value = "fix", name = "fix: fix a bug" },
    { value = "docs", name = "docs: add or update documentation" },
    { value = "typo", name = "typo: fix typos" },
    { value = "refactor", name = "refactor: code refactoring" },
    { value = "perf", name = "perf: code refactoring that improves performance" },
    { value = "delete", name = "delete: code or file deletion" },
    { value = "test", name = "test: add or update tests" },
    { value = "misc", name = "misc: changes that do not affect the code itself (e.g.: add .gitignore)" },
    { value = "style", name = "style: changes on code styling (e.g.: formatting, white-spaces)" }
]

You can create the commit_types key on your config file.This key must be an array of inline tables. Each inline table must have two pair of key/value, and the key names must be: value and name. Must be these names (at least for now).

Example:

[tool.commitizen]
name = "cz-bitbucket-jira-plugin"
jira_project_key = "DEV"
commit_types = [
    { value = "feat", name = "feat: introduce a new feature" },
    { value = "fix", name = "fix: fix a bug" },
    { value = "refactor", name = "refactor: code refactoring" }
]