Skip to content

Commit dd0f8c9

Browse files
CasperWAMattiSG
andauthored
Update default for acceptable_conclusions (#250)
Update default for `acceptable_conclusions` Updated to mirror standard GitHub behaviur, where `skipped` is considered an acceptable conclusion to a workflow or job step. Remove previously added examples as they are redundant. Co-authored-by: Matti Schneider <gh@mattischneider.fr>
1 parent 4b4daac commit dd0f8c9

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ All input names in **bold** are _required_.
157157
| `debug` | Set `set -x` in `entrypoint.sh` when running the action. This is for debugging the action. | `False` |
158158
| `path` | A path to the working directory of the action. This should be relative to the `$GITHUB_WORKSPACE`. | `.` |
159159
| `gh_rest_api_base_url` | The base URL for the GitHub REST API. This is useful for GitHub Enterprise users.</br>Note, `/api/v3` will be appended to this value if it does not already exist. See the note [here](https://docs.github.com/en/enterprise-server@3.10/rest/quickstart?apiVersion=2022-11-28&tool=curl#using-curl-commands-in-github-actions). | `https://api.github.com` |
160-
| `acceptable_conclusions` | A string listing acceptable statuses, as comma-separated entries with no spaces (for example: `'success,skipped'`). If any of these statuses are present, the action will not fail.</br></br>See the [GitHub REST API documentation](https://docs.github.com/en/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run), specifically, the Response schema's "conclusion" property's `enum` values, for a complete list of supported values (excluding `null`). | `success` |
160+
| `acceptable_conclusions` | A string listing acceptable statuses as comma-separated entries with no spaces. If any of these statuses are present, the action will not fail.</br></br>See the [GitHub REST API documentation](https://docs.github.com/en/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run), specifically, the Response schema's "conclusion" property's `enum` values, for a complete list of supported values (excluding `null`). | `success,skipped` |
161161
| `fail_fast` | If set to true, the action will fail as soon as a check fails. If set to false (default), the action will wait for all checks to complete before failing. | `False` |
162162

163163
### Deprecated inputs

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ inputs:
5757
required: false
5858
default: 'https://api.github.com'
5959
acceptable_conclusions:
60-
description: 'A comma-separated list of acceptable conclusions. If any of these conclusions are present, the action will not fail.'
60+
description: 'A string listing acceptable statuses as comma-separated entries with no spaces. If any of these conclusions are present, the action will not fail.'
6161
required: false
62-
default: 'success'
62+
default: 'success,skipped'
6363
fail_fast:
6464
description: 'If set to true, the action will fail as soon as a check fails. If set to false (default), the action will wait for all checks to complete before failing.'
6565
required: false

0 commit comments

Comments
 (0)