generate-changelog
generates changelog with jira-tickets from git and sets version in jira tickets
Goals
Many developers working with Jira all workday. This tools creates a changelog for a release listing all Jira tickets since last release (in this case the last tag) and sets the fix version in Jira so one can see later in which release it was included. This way everyone gets the best of two worlds - having a changelog and see version info on Jira tickets.
Alternatives
If you just look for a changelog generator for github, jump to this. There is also a js based changelog generator. None of them is dealing with jira.
ToDos
- get auth for jira, see https://jira.readthedocs.io/en/latest/examples.html#authentication
- query type and summary for the collected jira issues
- insert changeset to changelog file
- set release / fix version in jira
- support unicode in jira titles
- if list is empty show alternative output with version info
- detect shallow clone and error
- optional: transition issues
- optional: insert build types (e.g. beta or production)
- migrate to python3
Requirements
- python 3.x
pipfor installing jira module- jira-python
- install via
pip install jira
- install via
- jira admin rights - to create fix versions
Usage
basic configuration
- setup jira url
- define jira projects in which fix version should be created
- configure possible issue type for your project
getting version info
currently the script parses a gradle property file, tweak the script to your needs: e.g. pass info via argument, PR welcome
git history
Default: using git log to find all changes since last tag (use on master only, only uses commit messages)
git_cmd = 'git log $(git describe --abbrev=0 --tag)...HEAD --format="%s"'
or if you want to scan branch infos too use instead:
git_cmd = 'git log $(git describe --abbrev=0 --tag)...HEAD --oneline --decorate'
Quick Usage
execute ./generate-changelog.py in the repository folder