| Name | cz-bitbucket-jira-plugin JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Commitizen plugin that links your Bitbucket commits with your Jira issues |
| upload_time | 2024-06-01 20:32:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Marcos Martins Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
bitbucket
commitizen
commitizen-plugin
conventional-commits
jira
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# cz-bitbucket-jira-plugin
> A [Commitizen](https://github.com/commitizen-tools/commitizen) plugin that links your Bitbucket commits with your Jira issues.
## Installation
```shell
pip install cz-bitbucket-jira-plugin
```
## Configuration
Theres 2 possible configuration files: `pyproject.toml` and `cz.toml`. It's up to you.
> [!TIP]
> If you already have a `pyproject.toml` in your project, use it. If not, create a `cz.toml`.
The only **required** configurations are:
```toml
[tool.commitizen]
name = "cz-bitbucket-jira-plugin"
jira_url = "https://<project name>.atlassian.net"
```
This tells Commitizen which plugin you want to use and what is your Jira url, to properly link issues on commit messages and Changelog.
### Jira project key (_optional_)
To avoid the need to type your **Jira project key** for every commit, you can set this up in your chosen configuration file:
```toml
[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 (_optional_)
You can set a 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:
```toml
[tool.commitizen]
name = "cz-bitbucket-jira-plugin"
commit_message_minimum_length = 32
```
The default value for this config is `32`.
## Usage
As it is a [Commitizen](https://github.com/commitizen-tools/commitizen) plugin, you can:
```shell
cz
```
## Customization
You can change some defaults of the plugin:
### Prompt style
To change the default **prompt style** which is:
```toml
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 in your config file. This key must be an [*array of inline tables*](https://toml.io/en/v1.0.0#inline-table). Each inline table must have two pair of key/value.
Example:
```toml
[tool.commitizen]
name = "cz-bitbucket-jira-plugin"
prompt_style = [
{ identifier = "question", style = "fg:#50FA7B bold" },
{ identifier = "answer", style = "fg:#F8F8F2 nobold" }
]
```
The available identifiers are:
- qmark
- question
- answer
- pointer
- highlighted
- selected
- separator
- 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** which is:
```toml
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 in your config file. This key must be an [*array of inline tables*](https://toml.io/en/v1.0.0#inline-table). 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:
```toml
[tool.commitizen]
name = "cz-bitbucket-jira-plugin"
commit_types = [
{ value = "feat", name = "feat: introduce a new feature" },
{ value = "fix", name = "fix: fix a bug" },
{ value = "refactor", name = "refactor: code refactoring" }
]
```
> [!IMPORTANT]
> If you change the default commit types you will also need to declare two other keys: `change_type_map` and `change_type_order`.
#### Change type map
[*Array of inline tables*](https://toml.io/en/v1.0.0#inline-table) that have an key map for each commit type. Using the commit types on the example above:
```toml
[tool.commitizen]
name = "cz-bitbucket-jira-plugin"
change_type_map = [
{ value = "feat", name = "New features" },
{ value = "fix", name = "Bug fixes" },
{ value = "refactor", name = "Code refactoring" }
]
```
The `value` are the commit type and `name` are the long name that will appear in the Changelog.
#### Change type order
[*Array*](https://toml.io/en/v1.0.0#array) containing the order you want to show in the Changelog.
If you think that bug fixes are more important than new features you can show them first on Changelog:
```toml
[tool.commitizen]
name = "cz-bitbucket-jira-plugin"
change_type_order = [
"Bug fixes",
"New features",
"Code refactoring"
]
```
Raw data
{
"_id": null,
"home_page": null,
"name": "cz-bitbucket-jira-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "bitbucket, commitizen, commitizen-plugin, conventional-commits, jira",
"author": null,
"author_email": "Marcos Martins <contato@marcosmartins.me>",
"download_url": "https://files.pythonhosted.org/packages/d8/2e/6176443354229d5c0d874c8e073d1e1b3a5fe6dd9dad58b618d04bbfd9c0/cz_bitbucket_jira_plugin-1.0.0.tar.gz",
"platform": null,
"description": "# cz-bitbucket-jira-plugin\n\n> A [Commitizen](https://github.com/commitizen-tools/commitizen) plugin that links your Bitbucket commits with your Jira issues.\n\n\n\n## Installation\n```shell\npip install cz-bitbucket-jira-plugin\n```\n\n## Configuration\n\nTheres 2 possible configuration files: `pyproject.toml` and `cz.toml`. It's up to you.\n\n> [!TIP]\n> If you already have a `pyproject.toml` in your project, use it. If not, create a `cz.toml`.\n\nThe only **required** configurations are:\n\n```toml\n[tool.commitizen]\nname = \"cz-bitbucket-jira-plugin\"\njira_url = \"https://<project name>.atlassian.net\"\n```\n\nThis tells Commitizen which plugin you want to use and what is your Jira url, to properly link issues on commit messages and Changelog.\n\n### Jira project key (_optional_)\n\nTo avoid the need to type your **Jira project key** for every commit, you can set this up in your chosen configuration file:\n\n```toml\n[tool.commitizen]\nname = \"cz-bitbucket-jira-plugin\"\njira_project_key = \"DEV\"\n```\n\nNow every time you execute `cz commit`, Commitizen will use the **cz-bitbucket-jira-plugin** and use \"DEV\" as your default **Jira project key**.\n\n### Minimum length for commit messages (_optional_)\n\nYou can set a minimum length for commit messages to prevent things like `\"fix\"`, `\"wip\"`, `\"test\"`, `\"aaa\"`, and so on...\n\nTo do this, set this up in your chosen configuration file:\n\n```toml\n[tool.commitizen]\nname = \"cz-bitbucket-jira-plugin\"\ncommit_message_minimum_length = 32\n```\n\nThe default value for this config is `32`.\n\n## Usage\nAs it is a [Commitizen](https://github.com/commitizen-tools/commitizen) plugin, you can:\n\n```shell\ncz\n```\n\n## Customization\nYou can change some defaults of the plugin:\n\n### Prompt style\nTo change the default **prompt style** which is:\n\n```toml\nprompt_style = [\n { identifier = \"qmark\", style = \"fg:#FF5555\" },\n { identifier = \"question\", style = \"fg:#BD93F9\" },\n { identifier = \"answer\", style = \"fg:#F8F8F2 nobold\" },\n { identifier = \"pointer\", style = \"fg:#50FA7B nobold\" },\n { identifier = \"highlighted\", style = \"fg:#50FA7B\" },\n { identifier = \"selected\", style = \"fg:#50FA7B\" },\n { identifier = \"separator\", style = \"fg:#858585\" },\n { identifier = \"instruction\", style = \"fg:#858585 nobold\" },\n { identifier = \"text\", style = \"fg:#F8F8F2\" },\n { identifier = \"disabled\", style = \"fg:#858585 italic\" },\n]\n```\n\nYou can create the `prompt_style` key in your config file. This key must be an [*array of inline tables*](https://toml.io/en/v1.0.0#inline-table). Each inline table must have two pair of key/value.\n\nExample:\n\n```toml\n[tool.commitizen]\nname = \"cz-bitbucket-jira-plugin\"\nprompt_style = [\n { identifier = \"question\", style = \"fg:#50FA7B bold\" },\n { identifier = \"answer\", style = \"fg:#F8F8F2 nobold\" }\n]\n```\n\nThe available identifiers are:\n\n- qmark\n- question\n- answer\n- pointer\n- highlighted\n- selected\n- separator\n- instruction\n- text\n- disabled\n\n> You can check this also on https://questionary.readthedocs.io/en/stable/pages/advanced.html#themes-styling\n\nFor the complete styling documentation check https://python-prompt-toolkit.readthedocs.io/en/stable/pages/advanced_topics/styling.html\n\n### Commit types\nTo change the default **commit types** which is:\n\n```toml\ncommit_types = [\n { value = \"init\", name = \"init: initial commit to set up your repository\" },\n { value = \"feat\", name = \"feat: introduce a new feature\" },\n { value = \"fix\", name = \"fix: fix a bug\" },\n { value = \"docs\", name = \"docs: add or update documentation\" },\n { value = \"typo\", name = \"typo: fix typos\" },\n { value = \"refactor\", name = \"refactor: code refactoring\" },\n { value = \"perf\", name = \"perf: code refactoring that improves performance\" },\n { value = \"delete\", name = \"delete: code or file deletion\" },\n { value = \"test\", name = \"test: add or update tests\" },\n { value = \"misc\", name = \"misc: changes that do not affect the code itself (e.g.: add .gitignore)\" },\n { value = \"style\", name = \"style: changes on code styling (e.g.: formatting, white-spaces)\" }\n]\n```\n\nYou can create the `commit_types` key in your config file. This key must be an [*array of inline tables*](https://toml.io/en/v1.0.0#inline-table). 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).\n\nExample:\n\n```toml\n[tool.commitizen]\nname = \"cz-bitbucket-jira-plugin\"\ncommit_types = [\n { value = \"feat\", name = \"feat: introduce a new feature\" },\n { value = \"fix\", name = \"fix: fix a bug\" },\n { value = \"refactor\", name = \"refactor: code refactoring\" }\n]\n```\n\n> [!IMPORTANT]\n> If you change the default commit types you will also need to declare two other keys: `change_type_map` and `change_type_order`.\n\n#### Change type map\n\n[*Array of inline tables*](https://toml.io/en/v1.0.0#inline-table) that have an key map for each commit type. Using the commit types on the example above:\n\n```toml\n[tool.commitizen]\nname = \"cz-bitbucket-jira-plugin\"\nchange_type_map = [\n { value = \"feat\", name = \"New features\" },\n { value = \"fix\", name = \"Bug fixes\" },\n { value = \"refactor\", name = \"Code refactoring\" }\n]\n```\n\nThe `value` are the commit type and `name` are the long name that will appear in the Changelog.\n\n\n#### Change type order\n\n[*Array*](https://toml.io/en/v1.0.0#array) containing the order you want to show in the Changelog.\n\nIf you think that bug fixes are more important than new features you can show them first on Changelog:\n\n```toml\n[tool.commitizen]\nname = \"cz-bitbucket-jira-plugin\"\nchange_type_order = [\n \"Bug fixes\",\n \"New features\",\n \"Code refactoring\"\n]\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Marcos Martins Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Commitizen plugin that links your Bitbucket commits with your Jira issues",
"version": "1.0.0",
"project_urls": {
"Source": "https://github.com/marcosdotme/cz-bitbucket-jira-plugin",
"Tracker": "https://github.com/marcosdotme/cz-bitbucket-jira-plugin/issues"
},
"split_keywords": [
"bitbucket",
" commitizen",
" commitizen-plugin",
" conventional-commits",
" jira"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4231ef7bc6d1040cf4779a48472206c5d51649ff6cdd93df13a5d0a53efc6649",
"md5": "6e3bdfb874715fda0fee73aa1c88bbc8",
"sha256": "f131f6b5798460360826f1d14c0929868b00799c561da6858efad9414016dcd4"
},
"downloads": -1,
"filename": "cz_bitbucket_jira_plugin-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e3bdfb874715fda0fee73aa1c88bbc8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11253,
"upload_time": "2024-06-01T20:32:47",
"upload_time_iso_8601": "2024-06-01T20:32:47.589961Z",
"url": "https://files.pythonhosted.org/packages/42/31/ef7bc6d1040cf4779a48472206c5d51649ff6cdd93df13a5d0a53efc6649/cz_bitbucket_jira_plugin-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d82e6176443354229d5c0d874c8e073d1e1b3a5fe6dd9dad58b618d04bbfd9c0",
"md5": "75e1fa7bd6b1eb5af35da7df4d73cc9b",
"sha256": "ba5bbe843c0f8d9f499f91f7fb8a3927872573e1486c737c812245b571df546f"
},
"downloads": -1,
"filename": "cz_bitbucket_jira_plugin-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "75e1fa7bd6b1eb5af35da7df4d73cc9b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 124424,
"upload_time": "2024-06-01T20:32:50",
"upload_time_iso_8601": "2024-06-01T20:32:50.142965Z",
"url": "https://files.pythonhosted.org/packages/d8/2e/6176443354229d5c0d874c8e073d1e1b3a5fe6dd9dad58b618d04bbfd9c0/cz_bitbucket_jira_plugin-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-01 20:32:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "marcosdotme",
"github_project": "cz-bitbucket-jira-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cz-bitbucket-jira-plugin"
}
