Code TODO CLI
A script turns code TODOs into Uclusion bugs and jobs.
TODO comment format
Any TODO of this format will create a Uclusion bug or job.
| [BUG (default), NOTE, or JOB] [type] comment
Case insensitive
for BUG, type is one of CRITICAL, NORMAL, or MINOR with default MINOR
for JOB, type is one of WAITING, READY, BACKLOG_READY, or BACKLOG_NOT_READY with default BACKLOG_NOT_READY
for example
// TODO | This is my bug
creates a minor bug in Uclusion. However
// TODO This is my bug
is a no op because the | is missing.
// TODO | JOB READY This is my job
Will create a job in Work Ready stage assigned to the user that created the credentials file.
Running Uclusion CLI
In the same directory as your uclusion.json run
uclusionCLI.py
After completion
// TODO | JOB READY This is my job
becomes
// TODO J-Engineering-3 This is my job
where ‘J-Engineering-3’ is the short code of the created job.
When the job J-Engineering-3 is complete, running uclusionCLI.py again marks the TODO done.
// DONE J-Engineering-3 This is my job