forked from atlassian/gajira-find-issue-key
-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathaction.yml
166 lines (156 loc) · 5.81 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
name: Jira Find issue key [2022]
description: Find an issue inside event
branding:
icon: 'book-open'
color: 'blue'
inputs:
string:
description: Provide a string to extract issue key from
required: false
from:
description: >
Find from predefined place.
Can be 'branch', 'pull_request', 'string', or 'commits', default is 'commits'
required: false
default: commits
returns:
default: first
description: >
Options can be: 'first', or 'all'
This variable controls both how many results are returned,
and how many results are processed.
If the 'from' variable is 'pull_request', and this 'returns' variable is 'all',
then base-ref defaults to the pull_request.base.ref,
and the head-ref defaults to pull_request.head.ref from the github event.
NOTE: This action originally returned only the first Jira Ticket ID found.
For backwards compatibility the default is set to 'first'.
required: false
head-ref:
description: >
The Git Head Ref to which commit messages will be collected up to.
If the base-ref is included, and the github event is a pull_request or push,
The head-ref from the event will be used.
required: false
base-ref:
description: >
The Git Base Ref to which commit messages will be collected up from.
If the base-ref is not included,
required: false
standardize-pr-title:
description: >
Collects the Jira issue numbers from the Pull Request, and puts them at the start of the PR title.
Trims to 70 characters, i.e:
MYISSUE-123, MYISSUE-124: Resolve callback error, and fix typo
default: true
required: false
type: boolean
include-merge-messages:
description: >
When parsing commit messages, include merge and pull messages.
This is disabled by default, to exclude tickets that may be included
or fixed in other branches or pull requests.
required: false
default: false
type: boolean
generate-github-milestones:
description: >
Create GitHub Milestones from the Jira Issue' sprints
default: false
required: false
type: boolean
generate-github-issues:
description: >
When a Jira Issue is found, the existing list of GitHub issues is iterated through,
and if a GitHub issue starts with the Jira Issue Key, then the Github Issue is
updated with details from the Jira issue.
If the Github issue doesn't exist, the GitHub issue is created.
If 'generate-github-milestones' is 'true', then the GitHub issue is linked to the milestone.
If this action is triggered through a pull_request event, then when the pull_request
is closed, and merged, the GitHub issues are also closed, by adding 'Resolves #<IssueNumber>'
syntax on the pull_request body
default: 'false'
required: false
jira-transition-chain:
description: >
A comma separated list of all allowed Jira Transitions in order
required: false
jira-transition-on-new-branch:
description: >
The name of the transition to apply when a new branch is created
required: false
jira-transition-on-pr-open:
description: >
The name of the transition to apply when a Pull Request is opened
required: false
jira-transition-on-pr-approval:
description: >
The name of the transition to apply when a Pull Request is approved
required: false
jira-transition-on-pr-merge:
description: >
The name of the transition to apply when a Pull Request is closed and merged
required: false
fix-version:
description: >
The Jira Fix Versions that the Jira Issues found will be assigned.
required: false
deprecationMessage: >
This input has been deprecated. Please use the `fix-versions`` input instead.
fix-versions:
description: >
The Jira Fix Versions that the Jira Issues found will be assigned, as a comma separated list.
Use `NONE` to remove the Fix Version from the Jira Issue.
required: false
replace-fix-versions:
description: >
If 'true', then the Jira Fix Versions will be replaced with the 'fix-versions' input.
Otherwise it will combine the existing Fix Versions with the 'fix-versions' input.
required: false
default: 'true'
github-token:
description: GitHub Token used for authentication
required: false
gist-private:
description: >
If 'true', then the Gist will be private.
Otherwise it will be public.
required: false
default: 'false'
create-gist-output-named:
description: >
Options can be: 'first', or 'all'
This variable controls both how many results are returned,
and how many results are processed.
If the 'from' variable is 'pull_request', and this 'returns' variable is 'all',
then base-ref defaults to the pull_request.base.ref,
and the head-ref defaults to pull_request.head.ref from the github event.
NOTE: This action originally returned only the first Jira Ticket ID found.
For backwards compatibility the default is set to 'first'.
required: false
jira_base_url:
description: >
The Jira cloud base url including protocol i.e. 'https://company.atlassian.net'
or use environment variable JIRA_BASE_URL
required: false
jira_user_email:
description: >
The Jira cloud user email address
or use environment variable JIRA_USER_EMAIL
required: false
jira_api_token:
description: >
The Jira cloud user api token
or use environment variable JIRA_API_TOKEN
required: false
outputs:
issue:
description: Key of the found issue
issues:
description: Keys of the found issues as comma separated list
gist-url:
description: The url to the generated Gist
gist-name:
description: The name of the Gist created
runs:
using: 'node16'
main: 'lib/index.mjs'