Skip to content

Commit

Permalink
feat: add custom title to status message & output with status message
Browse files Browse the repository at this point in the history
  • Loading branch information
jamacku committed Jan 9, 2024
1 parent 9c66af7 commit 1a4406e
Show file tree
Hide file tree
Showing 41 changed files with 228 additions and 820 deletions.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,8 @@ Action currently accepts the following options:
bugzilla-api-token: <Bugzilla API token>
jira-instance: <Jira instance URL>
jiira-api-token: <Jira API token>
set-status: <true or false>
status-title: <status title>
token: <GitHub token or PAT>

# ...
Expand Down Expand Up @@ -233,13 +235,27 @@ The URL of the Jira instance on which will be performed API requests and validat
* default value: `undefined`
* requirements: `required`

### jiira-api-token
### jira-api-token

The Jira API token is used for performing API requests. The token should be stored as GitHub secret. Never paste the token directly into the workflow file.

* default value: `undefined`
* requirements: `optional`

### set-status

Set status on Pull Request. If enabled, Action will create check-run status with validation results.

* default value: `false`
* requirements: `optional`

### status-title

Optional H3 title of status message.

* default value: `Tracker validation`
* requirements: `optional`

### token

GitHub token or PAT is used for creating comments on Pull Request and setting checks.
Expand Down Expand Up @@ -301,6 +317,12 @@ Product name is used for validation if provided tracker is targeting the expecte
* default value: `undefined`
* requirements: `optional`

## Outputs

### `status`

Message with status of Tracker validation.

## Limitations

* Status checks from Pull Request Validator are randomly assigned to check suites, GitHub API for check suites doesn't provide a way to assign a check to a specific suite.
13 changes: 13 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,23 @@ inputs:
jira-api-token:
description: Jira API TOKEN

set-status:
required: true
default: 'false'
description: Set check-run status on Pull Request
status-title:
required: false
default: Tracker validation
description: H3 title of status message

token:
required: true
description: GitHub TOKEN or PAT

outputs:
status:
description: Status message of the validation

runs:
using: node20
main: dist/index.js
111 changes: 0 additions & 111 deletions dist/action.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/action.js.map

This file was deleted.

122 changes: 0 additions & 122 deletions dist/bugzilla.js

This file was deleted.

Loading

0 comments on commit 1a4406e

Please sign in to comment.