Conversation
…stale TODOs Closes #2732
Code ReviewClean housekeeping PR. The new No blocking issues found. ✅ |
…omments-referencing-closed-github-issues
There was a problem hiding this comment.
Pull request overview
Adds a new CI-side audit to detect TODO(#NNN) comments that reference already-closed GitHub issues, and cleans up/updates a set of stale TODOs across the repo to reduce misleading technical-debt markers.
Changes:
- Add
scripts/check-todo-closed-issues.shto query GitHub and fail on TODOs pointing to closed issues (intended as a non-blocking CI warning). - Wire the check into CI (non-blocking) and expose it locally via
cargo make todo-closed-issues. - Remove/update multiple stale TODOs (and a few related formatting-only tweaks) across Rust, docs, config, and workflow files.
Reviewed changes
Copilot reviewed 28 out of 29 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/check-todo-closed-issues.sh | New script that finds TODO(#NNN) references and checks issue state via GitHub GraphQL. |
| .github/workflows/ci.yml | Adds a non-blocking CI step to run the new TODO closed-issue check. |
| Makefile.toml | Adds todo-closed-issues cargo-make task for local execution. |
| pytest/tests/test_lost_assets.py | Removes a stale TODO reference. |
| docs/migration-service.md | Replaces a TODO reference with a concrete doc link. |
| docs/chain-gateway-design.md | Removes stale TODO annotations from a design snippet. |
| crates/test-parallel-contract/src/lib.rs | Removes a stale TODO comment (minor whitespace tweak). |
| crates/node/src/run.rs | Updates TODO issue reference. |
| crates/node/src/providers/verify_foreign_tx.rs | Removes a stale TODO comment. |
| crates/node/src/providers/eddsa/key_resharing.rs | Removes stale TODO and reflows method call formatting. |
| crates/node/src/providers/eddsa/key_generation.rs | Removes stale TODO and reflows method call formatting. |
| crates/node/src/providers/ecdsa/key_resharing.rs | Removes stale TODO and reflows method call formatting. |
| crates/node/src/providers/ecdsa/key_generation.rs | Removes stale TODO and reflows method call formatting. |
| crates/node/src/providers/ckd/key_resharing.rs | Removes stale TODO and reflows method call formatting. |
| crates/node/src/providers/ckd/key_generation.rs | Removes stale TODO and reflows method call formatting. |
| crates/node/src/protocol.rs | Removes stale TODO commentary. |
| crates/node/src/network.rs | Removes stale TODO in a test/dummy implementation. |
| crates/node/src/indexer/handler.rs | Removes stale TODO comments in handler logic. |
| crates/node/src/indexer.rs | Removes stale TODO comments in RPC/indexer structures. |
| crates/node/src/config.rs | Removes stale TODO comments around secrets/respond config. |
| crates/node/src/cli.rs | Removes stale TODO from CLI arg docs. |
| crates/node/src/assets.rs | Rewords TODO doc comment into a note. |
| crates/contract/tests/sandbox/vote.rs | Removes stale TODO at file header. |
| crates/contract/tests/sandbox/utils/consts.rs | Rewords/removes stale TODOs in gas/deposit constants docs. |
| crates/contract/src/tee/measurements.rs | Removes stale TODO in migration helper docs. |
| crates/contract/README.md | Removes stale TODO from setup steps. |
| Cargo.toml | Removes a stale TODO and applies formatting-only changes. |
| .gitignore | Removes a stale TODO comment. |
| .github/dependabot.yml | Removes stale TODO notes / adjusts ignore list entries accordingly. |
Comments suppressed due to low confidence (1)
.github/workflows/ci.yml:607
- In CI this step will likely run unauthenticated:
gh api graphqlrequires a token (typically viaGH_TOKEN/GITHUB_TOKENenv). Consider settingGH_TOKEN: ${{ github.token }}for this step (or job-wide) and updatingfast-ci-checksjob permissions to includeissues: read, otherwise the check may consistently fail and show a permanent yellow warning.
steps:
- name: Checkout repository
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
This check is not part of |
The todo-format check was catching "todo" in the filename and script contents of check-todo-closed-issues.sh. Extract excluded patterns into a constant array for maintainability.
grep -z is a GNU extension not available on macOS/BSD grep. Use git ls-files (without -z) piped to grep -v instead.
…omments-referencing-closed-github-issues
|
@claude review |
Code ReviewClean housekeeping PR. No critical issues found. Minor (non-blocking): In check-todo-closed-issues.sh line 62, the grep pattern uses unescaped parentheses which are regex metacharacters. Consider grep -Fn for exact fixed-string matching. Not blocking since false positives are extremely unlikely. ✅ |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 29 out of 30 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This reverts commit 50bf38a.
|
PR title type suggestion: This PR primarily adds new CI infrastructure (workflow and check scripts), so the type prefix should probably be Suggested title: |
Clean up stale TODOs referencing closed GitHub issues and update references where work moved to new issues.
Split from the CI check work — the script and workflow changes are in #2749. This PR focuses on the TODO comment cleanup.
Closes #2750