Merge pull request #114 from WyriHaximus/clarify-ignoreActions-naming

Clarify ignoreActions naming
WyriHaximus · May 7, 2022 · 992eb56 · 992eb56
2 parents 26035d5 + f81b5f4
commit 992eb56
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git 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
@@ -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)'