From 498329529bd9cdaae5eefb0a48c2e35298183a87 Mon Sep 17 00:00:00 2001 From: Warren Seymour Date: Wed, 6 Oct 2021 16:58:29 +0100 Subject: [PATCH] Add note on `checkName` to README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index db0da9d..847bce4 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,8 @@ This Action accepts the following configuration parameters via `with:` The name of the GitHub check to wait for. For example, `build` or `deploy`. + **IMPORTANT**: If the check you're referencing is provided by another GitHub Actions workflow, make sure that you reference the name of a _Job_ within that workflow, and _not_ the name the _Workflow_ itself. + - `ref` **Default: `github.sha`**