Skip to content

fix(ci): stop the to-do scan filing an issue from its own comment #304

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.

Sign up for GitHub

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

Merged
devantler merged 2 commits into from
Sep 26, 2026
Merged

fix(ci): stop the to-do scan filing an issue from its own comment #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebfcce5
fix(ci): stop the to-do scan filing an issue from its own comment
devantler Sep 26, 2026
5e9931a
docs(create-issues-from-todos): the marker matches in any case, so hy…
devantler Sep 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/scan-for-todo-comments.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ jobs:
# local path. Same-commit resolution — no release lag, no tag refs; consumer SHA-pinning
# policies see only the pinned actions/checkout plus a local `./` path. The composite's
# own internal checkout then re-syncs the workspace (git clean removes this untracked
# dir), so the todo-comment scan never sees the actions repo's sources. (Lowercase on
# purpose: the scanner keys on the uppercase marker, so naming it here would file an issue.)
# dir), so the to-do comment scan never sees the actions repo's sources. (Always hyphenated
# here: the scanner matches the marker in any letter case, so naming it would file an issue.)
Comment thread
devantler marked this conversation as resolved.
- name: 📥 Checkout devantler-tech/.github (this workflow's commit)
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
Expand All @@ -62,7 +62,7 @@ jobs:

# The sibling composite runs its own actions/checkout, whose git clean deletes this
# untracked self-checkout mid-job. That is intended (it hides the actions sources from
# the todo scan above), but the runner re-reads the composite's action.yaml from disk to
# the to-do scan above), but the runner re-reads the composite's action.yaml from disk to
# run its post-cleanup steps — which then fails with "Can't find action.yml". Re-materialise
# the directory AFTER the scan so the post phase can reload it; the scanner has already run,
# so it still never sees the actions repo's own sources.
Expand Down
6 changes: 3 additions & 3 deletions actions/create-issues-from-todos/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Scan code for TODO comments and automatically create corresponding GitHub issues

## What counts as a TODO

The scanner treats the uppercase marker as a TODO wherever it appears in a comment, including
in ordinary prose, and titles the issue with the text that follows it. When a comment only
describes TODOs, write the word in lowercase, or exclude the file with `ignore`.
The scanner treats the marker as a TODO in any letter case, wherever it appears in a comment,
including in ordinary prose, and titles the issue with the text that follows it. When a comment
only describes TODOs, hyphenate the word (`to-do`), or exclude the file with `ignore`.

## Usage

Expand Down
Loading