From f81b5f4d206933e87a425b29178c3ed859999b44 Mon Sep 17 00:00:00 2001 From: Cees-Jan Kiewiet Date: Fri, 6 May 2022 18:34:43 +0200 Subject: [PATCH] Clarify ignoreActions naming --- README.md | 6 +++--- action.yml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6f3790a..3b4d265 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ List of actions to ignore the status from, mainly to exclude the action this act * *Required*: `Yes` * *Type*: `CSV` -* *Example*: `automerge,otheraction` but a single action is also perfectly valid `automerge` +* *Example*: `Automerge PRs,Other Action` but a single action is also perfectly valid `Automerge PRs` *Note that these names are the human readable names use as status on commits, and show up as status checks on PRs.* ### checkInterval @@ -85,7 +85,7 @@ jobs: id: waitforstatuschecks uses: "WyriHaximus/github-action-wait-for-status@v2" with: - ignoreActions: Automerge PRs + ignoreActions: "Automerge PRs" ## Note that these names are the human readable names use as status on commits, and show up as status checks on PRs. checkInterval: 13 env: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" @@ -99,7 +99,7 @@ jobs: ## License ## -Copyright 2020 [Cees-Jan Kiewiet](http://wyrihaximus.net/) +Copyright 2022 [Cees-Jan Kiewiet](http://wyrihaximus.net/) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation diff --git a/action.yml b/action.yml index a36ad46..e5d5681 100644 --- a/action.yml +++ b/action.yml @@ -5,7 +5,7 @@ branding: color: 'orange' inputs: ignoreActions: - description: 'CSV of action names to ignore' + description: 'CSV of action names to ignore. Note that these names are the human readable names use as status on commits, and show up as status checks on PRs.' required: true checkInterval: description: 'Time between checks (in seconds)'