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

Update README

Browse Source
This commit is contained in:
alstr 2020-04-17 16:55:40 +01:00
parent 84d22beb97
commit 6a4701820e
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -2,7 +2,7 @@
This action will convert your `# TODO` comments to GitHub issues when a new commit is pushed. This action will convert your `# TODO` comments to GitHub issues when a new commit is pushed.
The new issue will contain a link to the line in the file code containing the TODO, together with a code snippet. The new issue will contain a link to the line in the file containing the TODO, together with a code snippet. The action performs a `GET` request to retrieve GitHub's [`languages.yaml` file](https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml) file to apply highlighting to the snippet.
It will also close an issue when a `# TODO` is removed in a pushed commit. A comment will be posted It will also close an issue when a `# TODO` is removed in a pushed commit. A comment will be posted
with the ref of the commit that it was closed by. with the ref of the commit that it was closed by.
@ -95,3 +95,7 @@ This may be updated in future.
Thanks to Jacob Tomlinson for his handy overview of GitHub Actions: Thanks to Jacob Tomlinson for his handy overview of GitHub Actions:
https://www.jacobtomlinson.co.uk/posts/2019/creating-github-actions-in-python/ https://www.jacobtomlinson.co.uk/posts/2019/creating-github-actions-in-python/
Thanks to GitHub's [linguist repo](https://github.com/github/linguist/) for the handy `languages.yaml` file used by the app to determine the correct highlighting to apply to code snippets:
https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml