TODO ➜ GitHub Issue

This workflow uses alstr/todo-to-issue-action@v5 to create or close issues based on in-repo comment markers. It supports both automatic push-triggered scans and manual dispatch with configurable scan types.

Infrastructure

• Runner: Self-hosted dokploy runner

Triggers

• Push: Runs on any push to any branch
• Manual Dispatch: Can be manually triggered with custom configuration options

Manual Dispatch Options

When manually triggering the workflow, you can configure:

• Scan Type (required):
  • diff: Scans only changes in a specific commit
  • full_codebase: Scans the entire codebase
• Manual Commit Ref: SHA of the commit to scan (required for diff scan)
• Manual Base Ref: Earlier SHA to compare against (optional for diff scan)

Configuration

• Action Version: alstr/todo-to-issue-action@v5
• Language markers: Configured in .github/todo-to-issue-languages.json
• Permissions: contents:write, issues:write, pull-requests:write
• Token: Uses the default GITHUB_TOKEN

Features

• Auto-assign: Automatically assigns issues to the committer
• Auto-close: Closes issues when TODO markers are removed
• Issue URL insertion: Automatically adds GitHub issue links back to TODO comments
• Git integration: Commits and pushes URL insertions back to the repository
• Input validation: Ensures required parameters are provided for diff scans

Behavior

• Scans for TODO-like comments and creates corresponding GitHub issues
• When TODO markers are removed, automatically closes the associated issues
• Inserts GitHub issue URLs back into the codebase after creating issues
• Commits URL insertions with the message "Automatically added GitHub issue links to TODOs"