From d88364e87397f0cf2ec9cc3cd4c0cbc6cbc0b1ab Mon Sep 17 00:00:00 2001 From: Bouteiller Alan Date: Thu, 9 Jul 2020 10:28:32 +0200 Subject: [PATCH 1/3] :pencil: feat(doc): add special case --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 3e96141..ac95119 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,13 @@ Should you change the `# TODO` text, this will currently create a new issue, so This may be updated in future. +### In an existing repo with existing todo + +> This action will convert your `# TODO` comments to GitHub issues when a new commit is pushed. + +Knowing that the todo are found thanks to the difference between the new commit and the previous commit this means that if this action is implemented during development the existing todo will not be taken. +They will have to be deleted, commit, put back and commit for it to be taken. + ## Contributing & Issues The action was developed for the GitHub Hackathon and is still in an early stage. Whilst every effort is made to ensure it works, it comes with no guarantee. From 0d99f2921965d76e749d6322f1b7de7c9aa8e03b Mon Sep 17 00:00:00 2001 From: Bouteiller Alan Date: Thu, 9 Jul 2020 10:28:48 +0200 Subject: [PATCH 2/3] :pencil: feat(doc): add summary --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index ac95119..cc17699 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,19 @@ with the ref of the commit that it was closed by. The `# TODO` comment is commonly used in Python, but this can be customised to whatever you want. +## Summary +- [Usage](#usage) + - [workflow.yaml](#workflowyaml) + - [inputs](#inputs) +- [Examples](#examples) + - [Adding TODOs](#adding-todos) + - [Multiline TODOs](#multiline-todos) + - [Removing TODOs](#removing-todos) + - [Updating TODOs](#updating-todos) + - [In an existing repo with existing todo](#in-an-existing-repo-with-existing-todo) +- [Contributing & Issues](#contributing--issues) +- [Thanks](#thanks) + ## Usage Create a workflow file in your .github/workflows directory as follows: From bccbf9206f76d4fc5c67ee678c7400b293ef679d Mon Sep 17 00:00:00 2001 From: Alastair Mooney Date: Thu, 9 Jul 2020 13:09:24 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cc17699..5f0727e 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,13 @@ The `# TODO` comment is commonly used in Python, but this can be customised to w ## Summary - [Usage](#usage) - [workflow.yaml](#workflowyaml) - - [inputs](#inputs) + - [Inputs](#inputs) - [Examples](#examples) - [Adding TODOs](#adding-todos) - [Multiline TODOs](#multiline-todos) - [Removing TODOs](#removing-todos) - [Updating TODOs](#updating-todos) - - [In an existing repo with existing todo](#in-an-existing-repo-with-existing-todo) + - [Existing TODOs](#existing-todos) - [Contributing & Issues](#contributing--issues) - [Thanks](#thanks) @@ -109,12 +109,11 @@ Should you change the `# TODO` text, this will currently create a new issue, so This may be updated in future. -### In an existing repo with existing todo +### Existing TODOs > This action will convert your `# TODO` comments to GitHub issues when a new commit is pushed. -Knowing that the todo are found thanks to the difference between the new commit and the previous commit this means that if this action is implemented during development the existing todo will not be taken. -They will have to be deleted, commit, put back and commit for it to be taken. +As the TODOs are found by analysing the difference between the new commit and the previous one, this means that if this action is implemented during development any existing TODOs will not be detected. For them to be detected, you would have to remove them, commit, put them back and commit again. ## Contributing & Issues