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.
For each JIRA issue detected in the release notes, it will add a link that brings directly to this issue on JIRA.
Step | Description |
---|---|
verifyConditions |
Validate the config options |
generateNotes |
Generate the release notes with links to JIRA issues |
Usage
Installation
$ npm install --save-dev semantic-release-jira-notes
$ yarn add --dev semantic-release-jira-notes
Inputs
Name | Required | Description |
---|---|---|
jiraHost | ✅ | Your JIRA host domain name |
ticketPrefixes | ❌ | Ticket prefixes to match. If not provided, match all tickets prefixes. |
Configuration
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
["semantic-release-jira-notes", {
"jiraHost": "iamludal.atlassian.net",
"ticketPrefixes": ["ATP", "OMS"]
}]
"@semantic-release/git",
"@semantic-release/github"
]
}
Note: don't forget to use
@semantic-release/release-notes-generator
before, as it will generate the release notes needed forsemantic-release-jira-notes
.