{"id":27554308,"url":"https://github.com/evisdrenova/todobot","last_synced_at":"2026-03-08T09:37:48.868Z","repository":{"id":286165354,"uuid":"960582654","full_name":"evisdrenova/todobot","owner":"evisdrenova","description":"A simple but powerful GitHub Action that automatically scans your codebase for `//TODO` comments and reports their count and locations whenever code is merged. ","archived":false,"fork":false,"pushed_at":"2025-04-04T17:45:01.000Z","size":5,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-19T17:57:48.670Z","etag":null,"topics":["ci","git"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/evisdrenova.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-04-04T17:25:28.000Z","updated_at":"2025-04-07T20:49:32.000Z","dependencies_parsed_at":"2025-04-04T18:42:49.042Z","dependency_job_id":null,"html_url":"https://github.com/evisdrenova/todobot","commit_stats":null,"previous_names":["evisdrenova/todobot"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/evisdrenova/todobot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evisdrenova%2Ftodobot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evisdrenova%2Ftodobot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evisdrenova%2Ftodobot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evisdrenova%2Ftodobot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/evisdrenova","download_url":"https://codeload.github.com/evisdrenova/todobot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evisdrenova%2Ftodobot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264446717,"owners_count":23609632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","git"],"created_at":"2025-04-19T14:31:14.081Z","updated_at":"2026-03-08T09:37:43.839Z","avatar_url":"https://github.com/evisdrenova.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# TODO Finder GitHub Action\n\nA simple but powerful GitHub Action that automatically scans your codebase for `//TODO` comments and reports their count and locations whenever code is merged.\n\n## Overview\n\nAs codebases grow, it's common to leave `//TODO` comments to mark areas that need future attention. However, these markers can easily be forgotten. This action helps you keep track of your technical debt by:\n\n1. Counting all `//TODO` comments in your codebase\n2. Listing their exact locations (file, line number, and content)\n3. Providing this information as both a workflow output and a downloadable report\n4. Commenting the results on merged PRs\n\n## Installation\n\n1. Create a `.github/workflows` directory in your repository (if it doesn't exist already)\n2. Create a new file `.github/workflows/todo-finder.yml`\n3. Copy the action YAML into this file\n4. Commit and push to your repository\n\nThat's it! The action will now run automatically whenever code is merged to your main branch.\n\n## When Does It Run?\n\nThe action is triggered on:\n- Direct pushes to the main/master branch\n- When a pull request to main/master is merged\n\nIt will not run on PRs that are closed without merging.\n\n## Output\n\nThe action provides:\n\n1. **GitHub Actions Workflow Summary**: The total number of TODOs appears in the workflow run summary.\n2. **Downloadable Report**: A Markdown file with detailed information about TODO locations.\n3. **PR Comments**: If triggered by a merged PR, the action will comment on that PR with the results.\n\nExample report:\n```markdown\n# TODO Finder Results\nGenerated on: Mon Apr 04 15:23:45 UTC 2025\n\n## Total TODOs found: 7\n\n## TODO Locations:\n\n- **src/components/UserProfile.js:42** - `//TODO: Add input validation`\n- **src/utils/api.js:87** - `//TODO: Implement error handling`\n- **src/reducers/auth.js:123** - `//TODO: Refactor this logic`\n- ...\n```\n\n## Customization\n\n### File Types\n\nBy default, the action scans the following file types:\n```\n*.js, *.jsx, *.ts, *.tsx, *.java, *.py, *.rb, *.php, *.c, *.cpp, *.h, *.hpp, *.cs, *.go, *.swift, *.kt\n```\n\nTo modify this list, edit the `--include` pattern in the `Find TODOs` step.\n\n### Excluded Directories\n\nBy default, the action excludes the following directories:\n```\nnode_modules, .git, build, dist, vendor\n```\n\nTo modify this list, edit the `--exclude-dir` pattern in the `Find TODOs` step.\n\n### TODO Format\n\nThis action searches for both `//TODO` (without space) and `// TODO` (with space) comment formats. \n\nIf you want to include additional formats (like Python-style `# TODO` comments), you can modify the grep patterns by adding to the regex pattern:\n\n```bash\ngrep -r --include=\"*.{js,jsx,ts,tsx,java,py,rb,php,c,cpp,h,hpp,cs,go,swift,kt}\" -E \"(//TODO|// TODO|# TODO)\" --exclude-dir={node_modules,.git,build,dist,vendor} . | wc -l\n```\n\n## Troubleshooting\n\n### Action Not Running\n\n- Ensure the workflow file is in the correct location (`.github/workflows/todo-finder.yml`)\n- Check that you're merging to the branch specified in the workflow (default: `main` or `master`)\n- Verify that your repository has GitHub Actions enabled\n\n### Missing TODOs\n\n- Check if your TODO format matches what the action is searching for (default: `//TODO`)\n- Ensure your file type is included in the search patterns\n- Verify that the directory containing your TODOs isn't in the excluded list\n\n## License\n\nThis project is available under the MIT License. Feel free to modify and adapt it to your needs.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n---\n\nFor any issues or suggestions, please open an issue in this repository.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevisdrenova%2Ftodobot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevisdrenova%2Ftodobot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevisdrenova%2Ftodobot/lists"}