cz-conventional-changelog-jira-first

This is a typeScript implementation of a commitizen adapter for conventional changelogs, with the jira id as first item in the header.

Usage no npm install needed!

<script type="module">
  import czConventionalChangelogJiraFirst from 'https://cdn.skypack.dev/cz-conventional-changelog-jira-first';
</script>

README

Welcome to cz-conventional-changelog-jira-first 👋

Version Maintenance License: MIT

This is a typeScript implementation of a commitizen adapter for conventional changelogs, with the jira id as first item in the commit message head. This Project is in an early state but will be improved soon. Any Contribution is appreciated.

Prerequisites

  • npm >=5.8.0
  • node >=10.15.2

Install

First install the package via npm:

npm i --save-dev cz-conventional-changelog-jira-first

As every commitizen adapter you need to add a refenrece to this adapter in your commitizen config in your package.json

"commitizen": {
  "path": "./node_modules/cz-conventional-changelog-jira-first"
}

or your commitizen config file .czrz

{
  "path": "./node_modules/cz-conventional-changelog-jira-first"
}

Usage

Just use your configured default commitizen command:

git cz

or

npm run commit

or if you added prepare commit message hooks via husky

git commit

Debugging

For easier debugging there is a helper Script, that runs the adapter without commiting. It just prints the generated commitmessage to the console. This script is not part of the npm package. Its only used for development. I added VScode launchsettings for easy to go debugging and launching the helper. If you are not using VSCode, you can start the script with first calling the typescript transpiler and run the script afterwards with nodejs.

tsc
node dist/debugHelper.js

Author

👤 Michael Kopf

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 Michael Kopf.
This project is MIT licensed.