feat(ci): TODO GitHub issue checker

[clabby]

Overview

Adds a script to ops that greps through the codebase for TODO comments that reference GitHub issues. If any of the issues
referenced are closed, an error is thrown, and the script exits with a non-zero exit code and an error asking the user
to remove the stale TODO comment.

The script also has several options:

• --verbose: Prints out warnings and a summary for issues that were either not found as well as TODO comments with invalid formats.
• --strict: Fails if any TODO comments are found that fit an invalid format.

Accepted TODO formats

• TODO(<issue_number>): <description> (Default org & repo: "ethereum-optimism/optimism")
• TODO(repo#<issue_number>): <description> (Default org "ethereum-optimism")
• TODO(org/repo#<issue_number>): <description>

Examples

TODO

• Get a PAT secret for the ethereum-optimism organization in order for CI to be able to reference issues in client-pod.

[clabby]

Current dependencies on/for this PR:

• develop
  • PR feat(ci): TODO GitHub issue checker #7642 👈

This comment was auto-generated by Graphite.

[ajsutton]

Nice. :)

[ajsutton]

Somehow I lost the comment I was actually trying to add...

I'd suggest we run this only on a schedule and not with every PR. Otherwise closing an issue could prevent unrelated PRs from failing to merge which would be very disruptive. We can either add a slack notification on failures or possibly better, just reopen the issue. :)

[clabby]

Somehow I lost the comment I was actually trying to add...

I'd suggest we run this only on a schedule and not with every PR. Otherwise closing an issue could prevent unrelated PRs from failing to merge which would be very disruptive. We can either add a slack notification on failures or possibly better, just reopen the issue. :)

Added this - great point 👍

[ajsutton]

LGTM. Can try to tighten up the bash mode for a bit more safety but not worth stressing about too much given this is just informational.

[clabby]

Adding M-do-not-merge Meta: Do not merge . Need a GH PAT secret in CircleCI to read the private issues in the client-pod repo before we move everything into the public.

[sebastianst]

@clabby I added a PAT that should have the right permissions to CCI's env var CI_TODO_CHECKER_PAT. Please give it a try.