Skip to content

Commit 2c0f8c5

Browse files
committed
Update ReadMe.
1 parent f552f37 commit 2c0f8c5

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ This action allows re-running a workflow when labels are added to (or removed fr
1313
| Name | Required | Description |
1414
|------|-----------|-------------|
1515
| `token` | yes | A GitHub Token other than the default `GITHUB_TOKEN` needs to be specified in order to be able to re-run workflows. |
16-
| `once-label` | no\* | When this label is added to a pull request, re-run the `workflow` once and remove the label again. |
17-
| `continuous-label` | no\* | When this label is added to a pull request, continuously re-run the `workflow` until it succeeds or is cancelled. The action needs to be run on `workflow_run`, `push` or `schedule` events for this to work. |
18-
| `trigger-labels` | no\* | When any of the labels in this comma-separated list is added to or removed from a pull request, re-run the `workflow` once. |
19-
| `failed-jobs-only`| no | Specify whether only failed jobs should be re-run |
16+
| `once-label` | no<sup>1</sup> | When this label is added to a pull request, re-run the `workflow` once and remove the label again. |
17+
| `continuous-label` | no<sup>1</sup> | When this label is added to a pull request, continuously re-run the `workflow` until it succeeds or is cancelled. The action needs to be run on `workflow_run`, `push` or `schedule` events for this to work. |
18+
| `trigger-labels` | no<sup>1</sup> | When any of the labels in this comma-separated list is added to or removed from a pull request, re-run the `workflow` once. |
19+
| `failed-jobs-only`| no | Specify whether only failed jobs should be re-run. |
2020
| `workflow` | yes | File name or ID of the workflow which should be re-run. |
2121

22-
\* At least one of `once-label`, `continuous-label` or `trigger-labels` is required.
22+
<sup>1</sup> At least one of `once-label`, `continuous-label` or `trigger-labels` is required.
2323

2424

2525
## Example Workflow
@@ -68,5 +68,6 @@ jobs:
6868
once-label: ci-requeue
6969
continuous-label: ci-retry
7070
trigger-labels: ci-trigger-1,ci-trigger-2
71+
failed-jobs-only: false
7172
workflow: ci.yml
7273
```

action.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ inputs:
3333
description: >
3434
When re-running the workflow, only re-run jobs which have failed.
3535
required: false
36+
default: false
3637
workflow:
3738
description: File name or ID of the workflow which should be re-run.
3839
required: true

0 commit comments

Comments
 (0)