Create Jira Release Notes

Create-Jira-Release-Notes is a Javascript library for creating jira release notes and outputing them into a specific file.

Installation

Use the package manager npm to install create-jira-release-notes.

npm install create-jira-release-notes

Usage

.env - file

update the parameters to fit your specifc project

[email protected]:123hjk343ljk
PAGE_URL=https://companyX.atlassian.net/rest/api/2/search

command - package.json

update the parameters to fit your usage

//mandatory parameters:
projectName=yourProjectNameInJira
fixVersion=yourProjectVersion 
filepath=relativePathFromYourProjectRoot\output.md

//optional parameters:
includeSubtask=true/false   //default: false
outputFormat=markdown/html //default: markdown

//final example command:
  "scripts": {
    "createReleaseNotes": "createJiraReleaseNotes --projectName=WCT --fixVersion=2.4.0 --filepath=../yourProject/output.md --outputFormat=markdown --includeSubtask=true"
  }

==>

npx createReleaseNotes

Attention:

The version will be reformated from

2.4.0

to

v2.4.0

If you don't need that go to:
./node_modules/create-jira-release-notes/jira-create-release-notes.js
and change:

6    const refactoredFixVersion = "v" + fixVersion;

to

6    const refactoredFixVersion = fixVersion;

Updates

as of version 1.3.1 you are not restricted to fixVersions with only one patch-version

--fixVersion=2.4.0

but can ask for all patch versions at once with:

--fixVersion=2.4

the versions will be structured below each other in your output-file.

License

MIT