How do I use scantodo in a GitHub Actions CI pipeline?

[imxde-code]

I want to block PRs that introduce new FIXME comments. How do I integrate scantodo into my GitHub Actions workflow?

I tried running it in my workflow but I am not sure how to configure it to only fail on FIXME and not TODO.

[imxde-code]

Great question! Here is a minimal GitHub Actions workflow:

# .github/workflows/ci.yml
name: CI
on: [push, pull_request]
jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npx scantodo --types FIXME

The key is --types FIXME — this tells scantodo to only scan for FIXME comments and ignore TODO, HACK, NOTE, and XXX. Since scantodo exits with code 1 when it finds matches, the workflow step will fail automatically.

If you ever need to run it in reporting mode without failing CI, add the --no-fail flag.