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

Update README.md

Browse Source
This commit is contained in:
Alastair Mooney
2021-07-20 15:27:06 +01:00
committed by GitHub
parent f7ad1e131d
commit 70d10efd53
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -1,10 +1,10 @@
# TODO to Issue Action # TODO to Issue Action
This action will convert newly committed TODO comments to GitHub issues on push. It will also optionally close the issues if the TODOs are removed in a future commit. This action will convert newly committed TODO comments to GitHub issues on push. It will also optionally close the issues if the TODOs are removed in a future commit. Works with almost any programming language.
## Usage ## Usage
Simply add a comment starting with TODO, followed by a colon and/or space: Simply add a comment starting with TODO, followed by a colon and/or space. Here's an example for Python:
def hello_world(): def hello_world():
# TODO Come up with a more imaginative greeting # TODO Come up with a more imaginative greeting
@@ -32,7 +32,7 @@ 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.6" uses: "alstr/todo-to-issue-action@v4.0.7"
id: "todo" id: "todo"
with: with:
TOKEN: ${{ secrets.GITHUB_TOKEN }} TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -82,8 +82,9 @@ There are additional inputs if you want to be able to assign issues to projects.
* Scala * Scala
* Shell * Shell
* Swift * Swift
* TypeScript * TeX
* TSX * TSX
* TypeScript
* YAML * YAML
New languages can easily be added to the `syntax.json` file used by the action to identify TODO comments. When adding languages, follow the structure of existing entries, and use the language name defined by GitHub in [ `languages.yml` ]( New languages can easily be added to the `syntax.json` file used by the action to identify TODO comments. When adding languages, follow the structure of existing entries, and use the language name defined by GitHub in [ `languages.yml` ](