ditkrg/todo-to-issue-action
4
0
Fork 0
mirror of https://github.com/ditkrg/todo-to-issue-action.git synced 2026-01-22 22:06:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
alstr 2021-07-28 19:30:51 +01:00
parent 459402f530
commit 63126d7026
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -37,22 +37,22 @@ Create a `workflow.yml` file in your `.github/workflows` directory like:
steps: steps:
- uses: "actions/checkout@master" - uses: "actions/checkout@master"
- name: "TODO to Issue" - name: "TODO to Issue"
uses: "alstr/todo-to-issue-action@v4.0.7" uses: "alstr/todo-to-issue-action@v4.0.8"
id: "todo" 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. 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 | | 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`. | | `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`. |
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. There are additional inputs if you want to be able to assign issues to projects. Consult the relevant section below for more details.
### Considerations ### Considerations