Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add todo-to-issue GitHub Action in order to add GitHub Issues from TODOs, etc. #152

Merged

Conversation

Stelzi79
Copy link
Contributor

I have found a GitHub Action (alstr/todo-to-issue-action ) that finds TODOs, FIXMEs, etc in coding files and creates GitHub Issues.

What todo-to-issue-action does:

This action will convert newly committed TODO comments to GitHub issues on push.

Optionally, issues can also be closed when the TODOs are removed in a future commit.

Action supports:

  • Multiple, customizable comments identifiers (FIXME, etc.),
  • Configurable auto-labeling,
  • Assignees,
  • Milestones,
  • Projects (classic).
  • todo-to-issue works with almost any programming language.

This action needs the Workflow permissions setting Read and Write permissions under Settings => Actions => General set in order to be allowed to create issues!

Before (or shortly after the merge) the action needs to be updated to point to the main branch (or whatever condition) in order to look at the main branch for TODOs on pushes.

When the TODO, etc. is removed the Issue is closed automatically. This can be configured. The automatic labeling (Fix me, Help Wanted, etc.) of issues also can be configured.

As an example on how to use it, I added a TODO in src/TagzApp.Common/Models/Content.cs. In my testing in my forked repo this worked. This is the Issue it created for #2!

I also added an .editorconfig that sets spaces as intentation for .yml files in the root directory.

Next Step:

  • add all TODOs, FIXMEs, etc. in changes to the repo

@Stelzi79 Stelzi79 changed the title created first TODO for testing todo-to-issue GitHub Action Add todo-to-issue GitHub Action in order to add GitHub Issues from TODOs, etc. Aug 31, 2023
@csharpfritz csharpfritz merged commit 187a5b4 into FritzAndFriends:main Sep 5, 2023
2 checks passed
@csharpfritz
Copy link
Contributor

Very cool update, and will help make it clear how our team collaborates and marks up code

@Stelzi79 Stelzi79 deleted the Stelzi79/TODOs_as_GHIssues branch September 12, 2023 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants