Package: cz-github-jira-conventional-footer
cz-github-jira-conventional-footercz-github-jira-conventional-footeris 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 Jira issue identifiersin a customisable footer of the commit messagecreating links to GitHubcommits in the CHANGELOG.mdcreating links to Jiraissues in the CHANGELOG.mdInstallationInstall with pippython -m pip install cz-github-jira-conventional-footerConfigurationThe behavior of the plugin can be modified by adding the following values to your .yaml/.toml/.json config file.
Note thatgithub_repoandjira_base_urlarerequiredwhile the others areoptional.ParameterTypeRequiredDefaultDescriptiongithub_repostrYESName of the repository on GitHub in format "{username}/{repo name}"jira_base_urlstrYESBase URL of the Jira application that tracks issues for this repositoryjira_prefixstrNONoneKey for the Jira project that tracks issues for this repository. If issues for this repository are tracked on multiple Jira projects, this config value should be left blank which will prompt commitizen for full issue identifiersjira_tokenstrNOJiraToken to use for the footer containing Jira issues. Cannot contain spaces or the phrase "Breaking Change". Can optionally specify the separator as either:<space>[^yaml-note] or<space>#by including it in the value. If the separator is not specified, a:<space>separator will automatically be addedbump_patternstrNOcommitizen.defaults.bump_patternRegex to extract information from commit (subject and body)bump_mapdictNOcommitizen.defaults.bump_mapDictionary mapping the extracted information to a SemVer increment type (MAJOR, MINOR, PATCH)changelog_patternstrNObump_patternRegex to validate the commits, this is useful to skip commits that don't meet your ruling standards like a Merge. Usually the same as bump_patternchange_type_mapdictNO{"feat":"Features", "fix":"Bug Fixes", "refactor":"Refactor", "perf":"Performance Improvements"}Convert the title of the change type that will appear in the changelog, if a value is not found, the original will be used[^yaml-note]: The colon (:) character has a special meaning in YAML syntax and must be escaped by enclosing the entire value in single quotes (ex:jira_token: 'resolves-issue: ')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:commitizenadditional_dependencies:[cz-github-jira-conventional-footer]Install the hook withpre-commitinstall--hook-typecommit-msgExample UsageConfigurationExample.cz.yamlfile:commitizen:name:cz_github_jira_conventional_footertag_format:v$versionversion:0.3.1github_repo:brianburwell11/cz-github-jira-conventional-footerjira_base_url:https://myproject.atlassian.netjira_prefix:XX-Making a CommitWhen 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, seeconfigabove).$czcommit? Select the type of change you are committing feat: A new feature. Correlates with MINOR in SemVer? What is the scope of this change? (class or file name): (press [enter] to skip)changelog? Write a short and imperative summary of the code changes: (lower case and no period)add GitHub and Jira badges to CHANGELOG? Provide additional contextual information about the code changes: (press [enter] to skip)Modify `changelog_message_builder_hook()` to show the commit hash and Jira issues as badges in each entry of the changelog. This is enabled by named groups in the `commit_parser` regex pattern.? Is this a BREAKING CHANGE? Correlates with MAJOR in SemVer No? JIRA issue number (multiple "42, 123"). XX- 03, 04? Add any additional footers. (press [enter] to skip)added-by: Brian Burwell <brianburwell11@gmail.com>Creates the following commit message:feat(changelog): add GitHub and Jira badges to CHANGELOG

Modify `changelog_message_builder_hook()` to show the commit hash and Jira issues as badges in each entry of the changelog. This is enabled by named groups in the `commit_parser` regex pattern.

Jira: XX-03,XX-04
added-by: Brian Burwell <brianburwell11@gmail.com>Reading the ChangelogThe changelog created by commitizen (cz changelogorcz bump --changelog) contains links to the commits in Github and the Jira issues.### Features-[![b56ea](https://img.shields.io/badge/-b56ea-%23121011.svg?style=flat-square&logo=github&logoColor=white)](https://github.com/brianburwell11/cz-github-jira-conventional-footer/commit/b56ea677af8a969614b159316d9d28a3267f7169)[![XX-03](https://img.shields.io/badge/-XX--03-dfe1e5.svg?style=flat-square&logo=jira&logoColor=0052cc)](https://myproject.atlassian.net/browse/XX-03)[![XX-04](https://img.shields.io/badge/-XX--04-dfe1e5.svg?style=flat-square&logo=jira&logoColor=0052cc)](https://myproject.atlassian.net/browse/XX-04)_(changelog)_add GitHub and Jira badges to CHANGELOGwhich renders asFeatures(changelog)add GitHub and Jira badges to CHANGELOGLicenseDistributed under the MIT License. SeeLICENSEfor more information.AcknowledgementsThis plugin would not have been possible without the fantastic work from:commitizen toolsconventional_JIRAcz_github_jira_conventional