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

Update README.md

Browse Source
This commit is contained in:
Alastair Mooney 2020-07-09 13:09:24 +01:00 committed by GitHub
parent 78fdc7dc37
commit bccbf9206f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -12,13 +12,13 @@ The `# TODO` comment is commonly used in Python, but this can be customised to w
## Summary ## Summary
- [Usage](#usage) - [Usage](#usage)
- [workflow.yaml](#workflowyaml) - [workflow.yaml](#workflowyaml)
- [inputs](#inputs) - [Inputs](#inputs)
- [Examples](#examples) - [Examples](#examples)
- [Adding TODOs](#adding-todos) - [Adding TODOs](#adding-todos)
- [Multiline TODOs](#multiline-todos) - [Multiline TODOs](#multiline-todos)
- [Removing TODOs](#removing-todos) - [Removing TODOs](#removing-todos)
- [Updating TODOs](#updating-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) - [Contributing & Issues](#contributing--issues)
- [Thanks](#thanks) - [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. 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. > 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. 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.
They will have to be deleted, commit, put back and commit for it to be taken.
## Contributing & Issues ## Contributing & Issues