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

Remove outdated sections from README.md regarding action behavior on first and subsequent runs, streamlining documentation for clarity and relevance.

Browse Source 
Signed-off-by: Shakar Bakr <5h4k4r.b4kr@gmail.com>
This commit is contained in:
Shakar Bakr 2025-06-15 13:59:49 +03:00
parent 61dcc147f4
commit 084ec4c2ce
No known key found for this signature in database
GPG Key ID: DA55A26823AE3C28
1 changed files with 0 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -134,19 +134,6 @@ Install the GitHub App on both:
- The source repository (where your code/TODOs are)
- The target repository (where issues will be created)
## How It Works
### First Run
When you first add this action to a repository with existing TODOs:
- With `fetch-depth: 0`, the action has access to full git history
- It compares against an empty tree to treat all files as "new"
- **All existing TODOs** in your codebase will be converted to issues
### Subsequent Runs
- Only processes TODOs that were added, modified, or removed in the current push
- Updates existing issues when TODOs are modified
- Closes issues when TODOs are removed (if `CLOSE_ISSUES` is enabled)
## Examples
### Same Repository (Simple)
@ -162,8 +149,6 @@ When you first add this action to a repository with existing TODOs:
APP_ID: ${{ secrets.TODO_APP_ID }}
PRIVATE_KEY: ${{ secrets.TODO_PRIVATE_KEY }}
OWNER: "myorg"
AUTO_ASSIGN: "true"
CLOSE_ISSUES: "false"
```
## TODO Options