| Name | cz-changeup JSON |
| Version |
1.1.2
JSON |
| download |
| home_page | None |
| Summary | Commitizen plugin for better changelog generation |
| upload_time | 2024-12-18 01:55:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
changelog
commitizen
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# cz-changeup
[](https://pypi.org/project/cz-changeup)
[](https://pypi.org/project/cz-changeup)
[](https://anaconda.org/conda-forge/cz-changeup)
[](https://github.com/astral-sh/ruff)
This plugin is a version of
[Commitizen](https://commitizen-tools.github.io/commitizen/)'s default conventional
style that provides more flexibility in the changelog format.
## Installation
With pip:
```bash
pip install cz-changeup
```
With conda:
```bash
conda install -c conda-forge cz-changeup
```
## Configuration
Add to your `pyproject.toml`:
```toml
[tool.commitizen]
name = "cz_changeup"
```
The behavior of the plugin can be customized by providing the following options under `tool.commitizen`:
| Option | Description | Default |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| `changeup_repo_base_url` | The base URL for the repository, for instance `"https://github.com/my/repo"`. | `""` |
| `changeup_show_hash` | Whether to add a link to the commit for each entry in the changelog. If `changeup_repo_base_url` is provided, the hash are linked to the commit. | `true` |
| `changeup_show_hash_breaking` | Whether to add a link to the commit also for descriptions in the breaking changes section. | `true` |
| `changeup_show_body` | Whether to include the commit body in the changelog. | `true` |
| `changeup_hide_breaking` | Whether to include the breaking changes section also in the the commit body if `changeup_show_body` is true. This prevents duplicate entries. | `true` |
| `changeup_body_indent` | The number of spaces to indent the commit body if `changeup_show_body` is set to `true`. | `2` |
| `changeup_link_issues` | If `true`, tries to convert issue numbers in phrases like `closes #21` to links. Only works if `changeup_repo_base_url` is provided. | `true` |
| `changeup_link_external_issues` | If `true`, tries to convert external issue numbers like `user/repo/#123` to links. Currently only supports github links. | `true` |
| `changeup_scope_prefix` | Prefix for the scope of the change. | `"**"` |
| `changeup_scope_suffix` | Suffix for the scope of the change. | `"**"` |
| `changeup_scope_separator` | Separator between the scope and the message. | `": "` |
Raw data
{
"_id": null,
"home_page": null,
"name": "cz-changeup",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "changelog, commitizen",
"author": null,
"author_email": "Kimoon Han <khan@kaist.ac.kr>",
"download_url": "https://files.pythonhosted.org/packages/19/54/e98511cf11c4a12268a13f28714227b510d1f166e44f5cd2fd234e9297ab/cz_changeup-1.1.2.tar.gz",
"platform": null,
"description": "# cz-changeup\n\n[](https://pypi.org/project/cz-changeup)\n[](https://pypi.org/project/cz-changeup)\n[](https://anaconda.org/conda-forge/cz-changeup)\n[](https://github.com/astral-sh/ruff)\n\nThis plugin is a version of\n[Commitizen](https://commitizen-tools.github.io/commitizen/)'s default conventional\nstyle that provides more flexibility in the changelog format.\n\n## Installation\n\nWith pip:\n\n```bash\npip install cz-changeup\n```\n\nWith conda:\n\n```bash\nconda install -c conda-forge cz-changeup\n```\n\n## Configuration\n\nAdd to your `pyproject.toml`:\n\n```toml\n[tool.commitizen]\nname = \"cz_changeup\"\n```\n\nThe behavior of the plugin can be customized by providing the following options under `tool.commitizen`:\n\n| Option | Description | Default |\n| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |\n| `changeup_repo_base_url` | The base URL for the repository, for instance `\"https://github.com/my/repo\"`. | `\"\"` |\n| `changeup_show_hash` | Whether to add a link to the commit for each entry in the changelog. If `changeup_repo_base_url` is provided, the hash are linked to the commit. | `true` |\n| `changeup_show_hash_breaking` | Whether to add a link to the commit also for descriptions in the breaking changes section. | `true` |\n| `changeup_show_body` | Whether to include the commit body in the changelog. | `true` |\n| `changeup_hide_breaking` | Whether to include the breaking changes section also in the the commit body if `changeup_show_body` is true. This prevents duplicate entries. | `true` |\n| `changeup_body_indent` | The number of spaces to indent the commit body if `changeup_show_body` is set to `true`. | `2` |\n| `changeup_link_issues` | If `true`, tries to convert issue numbers in phrases like `closes #21` to links. Only works if `changeup_repo_base_url` is provided. | `true` |\n| `changeup_link_external_issues` | If `true`, tries to convert external issue numbers like `user/repo/#123` to links. Currently only supports github links. | `true` |\n| `changeup_scope_prefix` | Prefix for the scope of the change. | `\"**\"` |\n| `changeup_scope_suffix` | Suffix for the scope of the change. | `\"**\"` |\n| `changeup_scope_separator` | Separator between the scope and the message. | `\": \"` |\n",
"bugtrack_url": null,
"license": null,
"summary": "Commitizen plugin for better changelog generation",
"version": "1.1.2",
"project_urls": {
"Changelog": "https://github.com/kmnhan/cz-changeup/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/kmnhan/cz-changeup#readme",
"Issues": "https://github.com/kmnhan/cz-changeup/issues",
"Source": "https://github.com/kmnhan/cz-changeup"
},
"split_keywords": [
"changelog",
" commitizen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f38170eab7c366e42df418486172d136b209b5208f5c04d2008d1be9b27d261",
"md5": "c0b245117a02e37d520565203cd88062",
"sha256": "938a3715cfc248e824b2ac5985b94a0cd1c505d201d8d67289fd1005e8465ec3"
},
"downloads": -1,
"filename": "cz_changeup-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0b245117a02e37d520565203cd88062",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5551,
"upload_time": "2024-12-18T01:54:59",
"upload_time_iso_8601": "2024-12-18T01:54:59.064739Z",
"url": "https://files.pythonhosted.org/packages/9f/38/170eab7c366e42df418486172d136b209b5208f5c04d2008d1be9b27d261/cz_changeup-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1954e98511cf11c4a12268a13f28714227b510d1f166e44f5cd2fd234e9297ab",
"md5": "020dc0663ea1d7be28cdaffcf50e7ffc",
"sha256": "f3876c32b558cb6e15a9bf8b69b7de840e90a79c0f4765439f4a9f13d4e004f2"
},
"downloads": -1,
"filename": "cz_changeup-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "020dc0663ea1d7be28cdaffcf50e7ffc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8513,
"upload_time": "2024-12-18T01:55:00",
"upload_time_iso_8601": "2024-12-18T01:55:00.462052Z",
"url": "https://files.pythonhosted.org/packages/19/54/e98511cf11c4a12268a13f28714227b510d1f166e44f5cd2fd234e9297ab/cz_changeup-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 01:55:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kmnhan",
"github_project": "cz-changeup",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cz-changeup"
}
