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

Merge pull request #13 from bouteillerAlan/feat-doc_special_case

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

20
README.md
View File

@ -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:
@ -96,6 +109,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.