Package: cz-git-universal-jira-conventional
cz-git-universal-jira-conventionalcz-git-universal-jira-conventionalis a plugin for thecommitizen tools, a toolset that helps you to createconventional commit messages. Since the structure of conventional commits messages is standardized they are machine readable and allow commitizen to automaticially calculate and tagsemantic version numbersas well as createCHANGELOG.mdfiles for your releases.This plugin extends the commitizen tools by:adding a Jira issue idin the commit message (can be optional, see config below)create links to Git-Repositorycommits in the CHANGELOG.mdcreate links to Jiraissues in the CHANGELOG.mdThis plugin is a fork of the originalcz-github-jira-conventional plugin.
Without it, this plugin would not be possible. It extends it by adding generic git commit path support for different git platforms and the option for leaving the jira issue id empty.When you call commitizencommityou will be prompted to enter the scope of your commit as a Jira issue id (or multiple issue ids, prefixed or without prefix, see config below).> cz commit
? Select the type of change you are committing fix: A bug fix. Correlates with PATCH in SemVer
? JIRA issue number (multiple "42, 123"). XX-
...The changelog created by cz (cz bump --changelog)will contain links to the commits in Github and the Jira issues.## v1.0.0 (2021-08-06)### Features-**[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)-**[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)InstallationInstall with pippython -m pip install cz-git-universal-jira-conventionalYou need to use a cz config file that has therequiredadditional valuesjira_base_urlandgit_commit_base_urland may contain theoptionalvaluejira_prefix.Example.cz.yamlconfig for this repositorycommitizen:name:cz_git_universal_jira_conventionaltag_format:v$versionversion:1.0.0jira_prefix:XX-jira_base_url:https://myproject.atlassian.netgit_commit_base_url:https://github.com/ngoldack/cz-git-universal-jira-conventional/commit/Thejira_prefixcan be eitherempty (the user must write the prefix for each issue)a string (the prefix will be added automatically)a list (for multiple projects, the user will be asked to choose a prefix)jira_prefix:-XX--XY--YY-Thejira_allow_emptycan be eitherfalse(default, a jira issue id is mandatory)true(jira issue id is optional and can be omitted)Thegit_commit_base_urldepends on your git platform vendor.
You want to add an url which can be appended with to commit-sha for reference. Examples:Github:https://github.com/ngoldack/cz-git-universal-jira-conventional/commit/Bitbucket (Self-Hosted):https://bitbucket.example.com/projects/PROJECT-NAME/repos/REPO-NAME/commits/pre-commitAdd this plugin to the dependencies of your commit message linting withpre-commit.Example.pre-commit-config.yamlfile.repos:-repo:https://github.com/commitizen-tools/commitizenrev:v2.17.13hooks:-id:commitizenstages:[commit-msg]additional_dependencies:[cz-git-universal-jira-conventional]Install the hook withpre-commitinstall--hook-typecommit-msgLicenseDistributed under the MIT License. SeeLICENSEfor more information.AcknowledgementsThis plugin is a fork of the originalcz-github-jira-conventional plugin.
Without it, this plugin would not be possible.This plugin would not have been possible without the fantastic work from:commitizen toolsconventional_JIRAcz-github-jira-conventional plugin