search

alstr / todo-to-issue-action

Action that converts TODO comments to GitHub issues on push.
MIT License
630 stars 121 forks source link

How to fail the build if TODO has incorrect format? #113

Closed dgroup closed 2 years ago

dgroup commented 2 years ago

How to force developers to use such a format of TODO items using indentation and expected tags like labels, assignees, etc.:

        # TODO Come up with a more imaginative greeting
        #  Everyone uses hello world and it's boring.
        #  labels: enhancement, help wanted
        #  assignees: alstr, bouteillerAlan, hbjydev
        #  milestone: 1

? Is it possible to fail workflow if todo has the wrong/unsupported format?

alstr commented 2 years ago

At the moment, the action ignores any options specified other than labels, assignees, etc. Would you want it to fail if someone included something like label instead of labels? The indentation is helpful but I don't think there is a problem if it's not followed exactly.

In terms of the actual labels, there isn't really an incorrect format here. If someone included labels: enhancement bug, forgetting a comma, it would be hard to detect that because theoretically there could be a single label called 'enhancement bug'.

Assignees and milestones get silently dropped if they don't already exist. Would you want it to fail in those situations?

alstr commented 2 years ago

Closing due to inactivity but please reply if you have more to add.