Package Exports
- semantic-release-jira-notes
- semantic-release-jira-notes/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (semantic-release-jira-notes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
semantic-release-jira-notes
semantic-release plugin to add links to JIRA issues in the release notes.
Step | Description |
---|---|
verifyConditions |
Validate the config options |
generateNotes |
Generate the release notes with links to JIRA issues |
Usage
First, install the plugin.
$ npm install --save-dev semantic-release-jira-notes
$ yarn add --dev semantic-release-jira-notes
Configuration
The plugin should then be added to your config file.
{
"plugins": [
"@semantic-release/commit-analyzer",
["semantic-release-jira-notes", {
"jiraHost": "iamludal.atlassian.net",
"ticketPrefixes": ["ATP", "OMS"]
}]
"@semantic-release/git",
"@semantic-release/github"
]
}
Note: you don't need to use @semantic-release/release-notes-generator
as it already uses
it under the hood.
Inputs
Name | Required | Description |
---|---|---|
jiraHost | ✅ | Your JIRA host domain name |
ticketPrefixes | ❌ | Ticket prefixes to match. If not provided, match all tickets prefixes. |