You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-3Lines changed: 14 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -137,7 +137,7 @@ Just provide an evironment to send a deployment event instead of a build event.
137
137
with:
138
138
state: ${{ job.status }}
139
139
environment: staging
140
-
issue: JCI-3, JCI-6 # Comma separated list of issues being deployed/released. You are expected to generate this yourself in a previous step
140
+
issue: JCI-3, JCI-6 # Comma separated list of issues being deployed/released. You are expected to generate this yourself in a previous step for releases
141
141
jira_instance: companyname # Subdomain for Jira Cloud
142
142
client_id: ${{ secrets.JIRA_CLIENT_ID }}
143
143
client_secret: ${{ secrets.JIRA_CLIENT_SECRET }}
@@ -167,14 +167,18 @@ Client Secret of OAuth Creds
167
167
168
168
#### state: BUILD_STATE (optional)
169
169
170
-
"successful"/"success", "failed", or "canceled" (default is "successful")
170
+
"successful"/"success", "failed", or "canceled" (default is "successful").
171
+
172
+
We try to detect this via [env-ci](https://github.com/semantic-release/env-ci) for most CI/CD providers, but you can manually override it if you wish to do so.
171
173
172
174
#### issue: JIRA_ISSUES (optional)
173
175
174
-
Will be parsed from branch name automatically if absent. Or you can provide it according to your own logic. Can be multiple issues.
176
+
Will be parsed from branch name automatically if available. Or you can provide it according to your own logic. Can be multiple comma separated issues.
175
177
176
178
### Pipeline Info
177
179
180
+
We try to detect this via [env-ci](https://github.com/semantic-release/env-ci) for most CI/CD providers, but you can manually override it if you wish to do so.
181
+
178
182
#### Commit Message: COMMIT_MESSAGE
179
183
180
184
If the tool can't detect your commit message you may provide a value directly. If you have the jira id in the commit message, it will be parsed.
@@ -195,3 +199,10 @@ A name for your environment. The tool tries to automatically infer this from you
195
199
196
200
The tool tries to automatically parse this from environment but if you want to override then provide one of (`unmapped`, `development`, `testing`, `staging`, `production`)
197
201
202
+
## Contributing
203
+
204
+
Feel free to open issues/Pull Requests to add support for some CI provider that doesn't have support yet.
0 commit comments