From 63126d70260dc962111eb9b2293b0606971b0ed5 Mon Sep 17 00:00:00 2001 From: alstr Date: Wed, 28 Jul 2021 19:30:51 +0100 Subject: [PATCH] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a66b73b..d8c0de8 100644 --- a/README.md +++ b/README.md @@ -37,22 +37,22 @@ Create a `workflow.yml` file in your `.github/workflows` directory like: steps: - uses: "actions/checkout@master" - name: "TODO to Issue" - uses: "alstr/todo-to-issue-action@v4.0.7" + uses: "alstr/todo-to-issue-action@v4.0.8" id: "todo" - with: - 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. -The workflow file takes the following inputs: +The workflow file takes the following optional inputs: | Input | Required | Description | |----------|----------|-------------| -| `TOKEN` | No | The GitHub access token to allow us to retrieve, create and update issues for your repo. Default: `${{ 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`. | | `AUTO_P` | No | Optional boolean input that specifies whether to format each line in multiline TODOs as a new paragraph. Default: `true`. | +These can be specified in `with` in the workflow file. + There are additional inputs if you want to be able to assign issues to projects. Consult the relevant section below for more details. ### Considerations