https://github.com/tomashubelbauer/todo-comments-github-issues
A GitHub Actions action to sync code to-do comments to GitHub issues
https://github.com/tomashubelbauer/todo-comments-github-issues
github-actions github-issues to-do
Last synced: about 1 month ago
JSON representation
A GitHub Actions action to sync code to-do comments to GitHub issues
- Host: GitHub
- URL: https://github.com/tomashubelbauer/todo-comments-github-issues
- Owner: TomasHubelbauer
- Created: 2022-04-15T10:59:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-22T15:46:18.000Z (about 4 years ago)
- Last Synced: 2025-06-01T16:38:41.353Z (about 1 year ago)
- Topics: github-actions, github-issues, to-do
- Language: JavaScript
- Homepage:
- Size: 94.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `TODO` Comments GitHub Issues GitHub Action
[`todo`]: https://github.com/tomashubelbauer/todo
This GitHub Actions action scans your repository's code base for `TODO` comments
using [`todo`] and syncs them to GitHub Issues of the repository.
- New `TODO` comment opens a new issues
- Moved `TODO` comment (line number change) renames the issue
- Edited `TODO` comment (text change) closes the old issue and opens a new issue
- Removed `TODO` comment closes the old issue with a comment
The issue body contains a permalink to the `TODO` line, making it a code preview
box. The closure comment references the associated commit and shows its message.
This action has no `inputs` or `outputs`.
[`todo`] supports a couple of `TODO` comment patterns, only those are supported.
This is not configurable.
The `GITHUB_TOKEN` workflow PAT is used to call the GitHub API. See more at:
https://docs.github.com/en/actions/security-guides/automatic-token-authentication
This is not configurable.
Issues maintained by this action are labeled `todo-comment`.
This is not configurable.
## Usage
`.github/workflows/main.yml`:
```yml
name: main
on: push
jobs:
main:
runs-on: ubuntu-latest
steps:
- name: Sync to-do comments with GitHub Issues
uses: tomashubelbauer/todo-comments-github-issues@main
```
You can see this in action (pun intended) in this GitHub repository:
https://github.com/tomashubelbauer/todo-comments-github-issues-demo
I have not published this GitHub Action to the GitHub Marketplace.
## Development
1. Make a change here
2. Go to https://github.com/tomashubelbauer/todo-comments-github-issues-demo/actions/workflows/main.yml
3. Click Run workflow
## Contributing
I am not likely to accept contributions unless they benefit my use-case.
Feel free to fork this GitHub Action and adjust it to suit your needs.