From b17545c65d8b8510db037fefbe5058d2b7f4762d Mon Sep 17 00:00:00 2001 From: alstr Date: Fri, 17 Apr 2020 17:09:51 +0100 Subject: [PATCH] Update README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7927b04..4574b2e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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 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. +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.yml` 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 with the ref of the commit that it was closed by. @@ -96,6 +96,6 @@ Thanks to Jacob Tomlinson for his handy overview of GitHub Actions: 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: +Thanks to GitHub's [linguist repo](https://github.com/github/linguist/) for the handy `languages.yml` 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 \ No newline at end of file