Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
Clarified README.
  • Loading branch information
potiuk committed Oct 7, 2020
1 parent 0ba85ca commit ca4b70a6910d33990e16d95e0c116914cdc0dfd0
Showing 2 changed files with 4 additions and 3 deletions.
@@ -111,7 +111,7 @@ and `schedule` events are no longer needed.
| `cancelMode` | no | `duplicates` | The mode to run cancel on. The available options are `duplicates`, `self`, `failedJobs`, `namedJobs` |
| `sourceRunId` | no | | Useful only in `workflow_run` triggered events. It should be set to the id of the workflow triggering the run `${{ github.event.workflow_run.id }}` in case cancel operation should cancel the source workflow. |
| `notifyPRCancel` | no | | Boolean. If set to true, it notifies the cancelled PRs with a comment containing reason why they are being cancelled. |
| `notifyPRCancelMessage` | no | | Optional cancel message to use instead of the default one when notifyPRCancel is true. |
| `notifyPRCancelMessage` | no | | Optional cancel message to use instead of the default one when notifyPRCancel is true. It is only used in 'self' cancelling mode. |
| `notifyPRMessageStart` | no | | Only for workflow_run events triggered by the PRs. If not empty, it notifies those PRs with the message specified at the start of the workflow - adding the link to the triggered workflow_run. |
| `jobNameRegexps` | no | | An array of job name regexps. Only runs containing any job name matching any of of the regexp in this array are considered for cancelling in `failedJobs` and `namedJobs` cancel modes. |

@@ -381,7 +381,6 @@ jobs:
cancelMode: duplicates
token: ${{ secrets.GITHUB_TOKEN }}
notifyPRCancel: true
notifyPRCancelMessage: Cancelled because image building failed.
notifyPRMessageStart: |
Note! The Docker Images for the build are prepared in a separate workflow,
that you will not see in the list of checks.
@@ -441,6 +440,7 @@ on:
with:
cancelMode: self
notifyPRCancel: true
notifyPRCancelMessage: Cancelled because image building failed.
token: ${{ secrets.GITHUB_TOKEN }}
sourceRunId: ${{ github.event.workflow_run.id }}
```
@@ -18,7 +18,8 @@ inputs:
required: false
notifyPRCancelMessage:
description: |
Optional cancel message to use instead of the default one when notifyPRCancel is true.
Optional cancel message to use instead of the default one when notifyPRCancel is true. Only
used in 'self' cancel mode.
required: false
notifyPRMessageStart:
description: |

0 comments on commit ca4b70a

Please sign in to comment.