alexandretrotel/Todo Tree Action
Scans PRs for TODO comments and posts them as a comment
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | GitHub token for posting comments | yes | ${{ github.token }} |
| path | Path to scan | no | . |
| tags | Comma-separated tags to search for (e.g., TODO,FIXME,BUG,HACK) | no | TODO,FIXME,BUG |
| include-patterns | Comma-separated file patterns to include (e.g., *.rs,*.ts) | no | "" |
| exclude-patterns | Comma-separated file patterns to exclude (e.g., *.min.js,vendor/**) | no | "" |
| changed-only | Only scan files changed in this PR | no | false |
| new-only | Only show NEW TODOs (not present in base branch) | no | false |
| fail-on-todos | Fail the action if any TODOs are found | no | false |
| fail-on-fixme | Fail the action if FIXME or BUG comments are found | no | false |
| max-todos | Maximum number of TODOs allowed before failing (empty = unlimited) | no | "" |
| show-annotations | Show TODOs as GitHub annotations on the files | no | true |
| max-annotations | Maximum number of annotations to show (GitHub limit is 50) | no | 50 |
| post-comment | Post a summary comment on the PR | no | true |
| comment-header | Custom header for the PR comment | no | ## Todo Tree Summary |
Outputs
| name | description |
|---|---|
| total | Total number of TODOs found |
| files_count | Number of files containing TODOs |
| has_todos | Whether any TODOs were found (true/false) |
| json | Full JSON output from todo-tree |