From 2c0f8c58b2d678302464160d29c96a2c6aee2302 Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Mon, 27 May 2024 19:34:51 +0200 Subject: [PATCH] Update ReadMe. --- README.md | 11 ++++++----- action.yml | 1 + 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 887acf7cf..a9562843b 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,13 @@ This action allows re-running a workflow when labels are added to (or removed fr | Name | Required | Description | |------|-----------|-------------| | `token` | yes | A GitHub Token other than the default `GITHUB_TOKEN` needs to be specified in order to be able to re-run workflows. | -| `once-label` | no\* | When this label is added to a pull request, re-run the `workflow` once and remove the label again. | -| `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. | -| `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. | -| `failed-jobs-only`| no | Specify whether only failed jobs should be re-run | +| `once-label` | no1 | When this label is added to a pull request, re-run the `workflow` once and remove the label again. | +| `continuous-label` | no1 | 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. | +| `trigger-labels` | no1 | When any of the labels in this comma-separated list is added to or removed from a pull request, re-run the `workflow` once. | +| `failed-jobs-only`| no | Specify whether only failed jobs should be re-run. | | `workflow` | yes | File name or ID of the workflow which should be re-run. | -\* At least one of `once-label`, `continuous-label` or `trigger-labels` is required. +1 At least one of `once-label`, `continuous-label` or `trigger-labels` is required. ## Example Workflow @@ -68,5 +68,6 @@ jobs: once-label: ci-requeue continuous-label: ci-retry trigger-labels: ci-trigger-1,ci-trigger-2 + failed-jobs-only: false workflow: ci.yml ``` diff --git a/action.yml b/action.yml index 35d1aef20..dcd2a2bc5 100644 --- a/action.yml +++ b/action.yml @@ -33,6 +33,7 @@ inputs: description: > When re-running the workflow, only re-run jobs which have failed. required: false + default: false workflow: description: File name or ID of the workflow which should be re-run. required: true