Update README.md

This commit is contained in:
Nuh Koca 2021-07-25 23:41:31 +02:00 committed by alstr
parent 60d710dcab
commit 8e4e5f9395

View File

@ -40,7 +40,7 @@ Create a `workflow.yml` file in your `.github/workflows` directory like:
uses: "alstr/todo-to-issue-action@v4.0.7" uses: "alstr/todo-to-issue-action@v4.0.7"
id: "todo" id: "todo"
with: with:
TOKEN: ${{ secrets.GITHUB_TOKEN }} TOKEN: ${{ secrets.GITHUB_TOKEN }} // defaults to ${{ github.token }}
``` ```
See [Github's workflow syntax](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions) for further details on this file. See [Github's workflow syntax](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions) for further details on this file.
@ -49,7 +49,7 @@ The workflow file takes the following inputs:
| Input | Required | Description | | Input | Required | Description |
|----------|----------|-------------| |----------|----------|-------------|
| `TOKEN` | Yes | The GitHub access token to allow us to retrieve, create and update issues for your repo. This should be set to `${{ secrets.GITHUB_TOKEN }}`. | | `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`. | | `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`. | | `AUTO_P` | No | Optional boolean input that specifies whether to format each line in multiline TODOs as a new paragraph. Default: `true`. |