{"id":14155404,"url":"https://github.com/apheris/cz-github-jira-conventional","last_synced_at":"2025-08-06T01:31:21.112Z","repository":{"id":37640084,"uuid":"395260073","full_name":"apheris/cz-github-jira-conventional","owner":"apheris","description":"Extend the commitizen tools to create conventional commits and CHANGELOG that link to Jira and GitHub.","archived":false,"fork":false,"pushed_at":"2024-09-19T08:45:24.000Z","size":12,"stargazers_count":24,"open_issues_count":0,"forks_count":14,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-04T04:15:46.673Z","etag":null,"topics":["commitizen","conventional-commits","git"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apheris.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-12T09:09:58.000Z","updated_at":"2024-10-30T07:07:17.000Z","dependencies_parsed_at":"2024-04-16T23:13:24.566Z","dependency_job_id":"a66cdc2c-aa16-4445-a2c3-feb84c0511f3","html_url":"https://github.com/apheris/cz-github-jira-conventional","commit_stats":{"total_commits":8,"total_committers":2,"mean_commits":4.0,"dds":0.375,"last_synced_commit":"cc1bcebd5714ad62240ecb227a03888481a5f159"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apheris%2Fcz-github-jira-conventional","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apheris%2Fcz-github-jira-conventional/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apheris%2Fcz-github-jira-conventional/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apheris%2Fcz-github-jira-conventional/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apheris","download_url":"https://codeload.github.com/apheris/cz-github-jira-conventional/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228821405,"owners_count":17977166,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commitizen","conventional-commits","git"],"created_at":"2024-08-17T08:03:02.544Z","updated_at":"2024-12-09T02:31:21.260Z","avatar_url":"https://github.com/apheris.png","language":"Python","funding_links":[],"categories":["git"],"sub_categories":[],"readme":"# cz-github-jira-conventional\n\n**cz-github-jira-conventional** is a plugin for the [**commitizen tools**](https://github.com/commitizen-tools/commitizen), a toolset that helps you to create [**conventional commit messages**](https://www.conventionalcommits.org/en/v1.0.0/). Since the structure of conventional commits messages is standardized they are machine readable and allow commitizen to automaticially calculate and tag [**semantic version numbers**](https://semver.org/) as well as create **CHANGELOG.md** files for your releases.\n\nThis plugin extends the commitizen tools by:\n- **require a Jira issue id** in the commit message\n- **create links to GitHub** commits in the CHANGELOG.md\n- **create links to Jira** issues in the CHANGELOG.md\n\nWhen you call commitizen `commit` you will be required you to enter the scope of your commit as a Jira issue id (or multiple issue ids, prefixed or without prefix, see config below).\n```\n\u003e cz commit\n? Select the type of change you are committing fix: A bug fix. Correlates with PATCH in SemVer\n? JIRA issue number (multiple \"42, 123\"). XX-\n...\n```\n\nThe changelog created by cz (`cz bump --changelog`)will contain links to the commits in Github and the Jira issues.\n```markdown\n## v1.0.0 (2021-08-06)\n\n### Features\n\n- **[XX-123](https://myproject.atlassian.net/browse/XX-123)**: create changelogs with links to issues and commits [a374b](https://github.com/apheris/cz-github-jira-conventional/commit/a374b93f39327964f5ab5290252b795647906008)\n- **[XX-42](https://myproject.atlassian.net/browse/XX-42),[XX-13](https://myproject.atlassian.net/browse/XX-13)**: allow multiple issue to be referenced in the commit [07ab0](https://github.com/apheris/cz-github-jira-conventional/commit/07ab0e09de36712ab1db93fff0c821ecd80b5849)\n``` \n\n\n## Installation\n\nInstall with pip\n`python -m pip install cz-github-jira-conventional` \n\nYou need to use a cz config file that has the **required** additional values `jira_base_url` and `github_repo` and may contain the **optional** value `jira_prefix`.\n\nExample `.cz.yaml` config for this repository\n```yaml\ncommitizen:\n  name: cz_github_jira_conventional\n  tag_format: v$version\n  version: 1.0.0\n  jira_prefix: XX-\n  jira_base_url: https://myproject.atlassian.net\n  github_repo: apheris/cz-github-jira-conventional\n```\n\nThe `jira_prefix` can be either \n- empty (the user must write the prefix for each issue)\n- a string (the prefix will be added automatically)\n- a list (for multiple projects, the user will be asked to choose a prefix)\n\n```yaml\n  jira_prefix: \n    - XX-\n    - XY-\n    - YY-\n```\n\n### pre-commit\nAdd this plugin to the dependencies of your commit message linting with `pre-commit`. \n\nExample `.pre-commit-config.yaml` file.\n```yaml\nrepos:\n  - repo: https://github.com/commitizen-tools/commitizen\n    rev: v2.17.13\n    hooks:\n      - id: commitizen\n        stages: [commit-msg]\n        additional_dependencies: [cz-github-jira-conventional]\n```\nInstall the hook with \n```bash\npre-commit install --hook-type commit-msg\n```\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\u003c!-- ACKNOWLEDGEMENTS --\u003e\n## Acknowledgements\nThis plugin would not have been possible without the fantastic work from:\n* [commitizen tools](https://github.com/commitizen-tools/commitizen)\n* [conventional_JIRA](https://github.com/Crystalix007/conventional_jira)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapheris%2Fcz-github-jira-conventional","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapheris%2Fcz-github-jira-conventional","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapheris%2Fcz-github-jira-conventional/lists"}