add readme note

This commit is contained in:
Timothy Morey 2021-10-06 10:49:38 -04:00
parent bec4b579f8
commit 2b8bdd309d
No known key found for this signature in database
GPG Key ID: CE9E7542A10E42DE

View File

@ -50,6 +50,7 @@ The workflow file takes the following optional inputs:
| `TOKEN` | No | The GitHub access token to allow us to retrieve, create and update issues for your repo. Default: `${{ github.token }}`. |
| `CLOSE_ISSUES` | No | Optional boolean input that specifies whether to attempt to close an issue when a TODO is removed. Default: `true`. |
| `AUTO_P` | No | Optional boolean input that specifies whether to format each line in multiline TODOs as a new paragraph. Default: `true`. |
| `IGNORE` | No | Optional string input that provides comma-delimited regular expressions that match files in the repo that we should not scan for TODOs. By default, we will scan all files. |
These can be specified in `with` in the workflow file.