1
1
# semantic-release-jira-notes
2
2
3
+ [ ![ npm latest version] ( https://img.shields.io/npm/v/semantic-release-jira-notes/latest.svg )] ( https://www.npmjs.com/package/semantic-release-jira-notes )
4
+
3
5
[ ** semantic-release** ] ( https://github.com/semantic-release/semantic-release ) plugin to add links to
4
6
JIRA issues in the release notes.
5
7
6
- [ ![ npm latest version ] ( https://img.shields.io/npm/v/semantic- release-jira- notes/latest.svg )] ( https://www.npmjs.com/package/semantic-release-jira-notes )
8
+ For each JIRA issue detected in the release notes, it will add a link that brings directly to this issue on JIRA.
7
9
8
10
9
11
| Step | Description |
@@ -14,22 +16,27 @@ JIRA issues in the release notes.
14
16
15
17
## Usage
16
18
17
- First, install the plugin.
19
+ ### Installation
18
20
19
21
``` bash
20
22
$ npm install --save-dev semantic-release-jira-notes
21
23
$ yarn add --dev semantic-release-jira-notes
22
24
```
23
25
26
+ ### Inputs
24
27
25
- ## Configuration
28
+ | Name | Required | Description |
29
+ | -------------- | :------: | ---------------------------------------------------------------------- |
30
+ | jiraHost | ✅ | Your JIRA host domain name |
31
+ | ticketPrefixes | ❌ | Ticket prefixes to match. If not provided, match all tickets prefixes. |
26
32
27
- The plugin should then be added to your config file.
33
+ ### Configuration
28
34
29
35
``` json
30
36
{
31
37
"plugins" : [
32
38
" @semantic-release/commit-analyzer" ,
39
+ " @semantic-release/release-notes-generator" ,
33
40
[" semantic-release-jira-notes" , {
34
41
"jiraHost" : " iamludal.atlassian.net" ,
35
42
"ticketPrefixes" : [" ATP" , " OMS" ]
@@ -40,13 +47,6 @@ The plugin should then be added to your config file.
40
47
}
41
48
```
42
49
43
- ** Note:** you don't need to use ` @semantic-release/release-notes-generator ` as it already uses
44
- it under the hood .
50
+ > ** Note:** don't forget to use ` @semantic-release/release-notes-generator ` before, as it will generate
51
+ the release notes needed for ` semantic-release-jira-notes ` .
45
52
46
-
47
- ### Inputs
48
-
49
- | Name | Required | Description |
50
- | -------------- | :------: | ---------------------------------------------------------------------- |
51
- | jiraHost | ✅ | Your JIRA host domain name |
52
- | ticketPrefixes | ❌ | Ticket prefixes to match. If not provided, match all tickets prefixes. |
0 commit comments