The changelog command would:
- accept
project_name required argument
- would validate via JIRA REST API that such project really exists
- get all resolved/closed issues for a project with
Fixed resolution
- group them by "fixVersion" version
- sort groups (1 group = 1 release) by their release date in descending order (latest released on top)
- within each group (version) group issues by
Change Log Group custom field value
- use value of
Change Log Message custom field of each issue to generate a CHANGELOG.md file according to http://keepachangelog.com/ format
Arguments:
version - allows to specify version or version range (e.g. 5.2.1 or 5.2.x)
Options:
--dump - will create CHANGELOG.md file (when version is specified) or CHANGELOG_X_Y.md (when version range is specified); when not specified output will happen to screen
--include-component - would list component of each task in changelog
The
changelogcommand would:project_namerequired argumentFixedresolutionChange Log Groupcustom field valueChange Log Messagecustom field of each issue to generate aCHANGELOG.mdfile according to http://keepachangelog.com/ formatArguments:
version- allows to specify version or version range (e.g.5.2.1or5.2.x)Options:
--dump- will create CHANGELOG.md file (when version is specified) or CHANGELOG_X_Y.md (when version range is specified); when not specified output will happen to screen--include-component- would list component of each task in changelog