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

Tool to automatically open issues when TODO is found #210

Open
molant opened this issue May 16, 2017 · 3 comments
Open

Tool to automatically open issues when TODO is found #210

molant opened this issue May 16, 2017 · 3 comments

Comments

@molant
Copy link
Member

molant commented May 16, 2017

There are quite a few TODO comments in the code and no issues associated. We should have a script that is run in travis (master) that:

  • looks for all the TODO comments in the JS code (we probably just split by line)
  • checks if the comment has a #ID somewhere or a url to the GitHub issue
    • if yes it doesn't do anything
    • if not
      • it creates a new issue in GitHub with the title as the TODO comment, and the body with the name of the file and the line number
      • adds the #id to the end of the comment and commits the changes

I don't think it will be super complicated and can probably be a separate project.
There are some projects that do similar things, check todo search in npm. My 5 minute search didn't trigger anything like what I want but we should look a bit more into it.

@qzhou1607-zz
Copy link
Contributor

Found one that might help : fixme-to-issue. Once a TODO is found not followed by an issue number, a new issue will be created with a description containing the file Path and line number information. And then the TODO comment gets updated with the newly generated issue number appended.

@molant
Copy link
Member Author

molant commented Jun 19, 2017

It looks like it might work.
We will still need to:

  • decide name of label(s) and colors
  • share the credentials with the bot in a secure way (we can probably use the command line parameters and @alrra can say how to get the credentials when in Travis)
  • add the step to the test-on-travis at the end once all tests are passed
  • Commit the changes in the repo (if any) without triggering a new build

I think most of this things are for @alrra

@molant
Copy link
Member Author

molant commented Aug 11, 2017

I've created this label for the issues created automatically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants