Ignore Dependabot security updates in the failure watcher - #461
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe Dependabot failure watcher documents run-title classification and filters recent runs to report only relevant Dependabot version update failures. ChangesDependabot watcher
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Updates the “Dependabot Failure Watcher” workflow to stop treating Dependabot security update workflow-run failures as actionable signal, so the scheduled watcher only flags failed version update runs and remains a meaningful indicator for ecosystem update health.
Changes:
- Filters out Dependabot security-update runs by
displayTitlepatterns (including a documented, intentionally-specific root match). - Moves the time-window bounding into
gh run listvia--createdto reduce history fetching and client-side filtering. - Expands and clarifies inline documentation explaining the different “Dependabot Updates” run types and why exclusions are necessary.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/dependabot-failure-watcher.yml:
- Line 97: Update the gh run list logic in the Dependabot failure watcher around
the --limit 500 option to detect when the result is saturated and avoid treating
the visible page as complete. Either paginate the run listing or split the
--created time range, and ensure older matching failures remain discoverable so
the watcher fails closed when unseen failures may exist.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 830093b6-2a3f-4def-85ff-7ac850e6c45e
📒 Files selected for processing (1)
.github/workflows/dependabot-failure-watcher.yml
| --json conclusion,createdAt,displayTitle,url \ | ||
| --jq "[.[] | select((.conclusion == \"failure\" or .conclusion == \"startup_failure\" or .conclusion == \"timed_out\") and .createdAt >= \"$since\")]") | ||
| --created ">=$since" \ | ||
| --limit 500 \ |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift
🧩 Analysis chain
🏁 Script executed:
#!/usr/bin/env bash
set -euo pipefail
: "${REPO:?set REPO=owner/name}"
since=$(date -u -d '8 days ago' +%Y-%m-%dT%H:%M:%SZ)
runs=$(gh run list \
--repo "$REPO" \
--workflow "Dependabot Updates" \
--created ">=$since" \
--limit 501 \
--json createdAt)
if [ "$(jq 'length' <<<"$runs")" -ge 501 ]; then
echo "More than 500 matching runs exist; the watcher may truncate results."
exit 1
fiRepository: maxmind/GeoIP2-python
Length of output: 199
🏁 Script executed:
#!/usr/bin/env bash
set -euo pipefail
echo "== workflow excerpt =="
if [ -f .github/workflows/dependabot-failure-watcher.yml ]; then
nl -ba .github/workflows/dependabot-failure-watcher.yml | sed -n '70,115p'
else
echo "Workflow file not found"
fi
echo
echo "== GitHub CLI availability and run_list help snippet =="
if command -v gh >/dev/null 2>&1; then
gh --version | head -3
gh run list --help 2>/tmp/gh-help.log | sed -n '/limit/,50p' || true
else
echo "gh not installed"
fi
echo
echo "== gh run list call sites =="
rg -n --hidden --glob '!node_modules' --glob '!dist' --glob '!build' 'gh run list|--limit 500|Dependabot Updates|run list' .Repository: maxmind/GeoIP2-python
Length of output: 222
🏁 Script executed:
#!/usr/bin/env bin/bash
set -euo pipefail
REPO="${REPO:-maxmind/GeoIP2-python}"
echo "== workflow excerpt =="
if [ -f .github/workflows/dependabot-failure-watcher.yml ]; then
awk 'NR>=70 && NR<=115 { printf "%7d %s\n", NR, $0 }' .github/workflows/dependabot-failure-watcher.yml
else
echo "Workflow file not found"
fi
echo
echo "== gh run list call sites =="
grep -RInE '(^|[^a-zA-Z0-9_])gh run list|--limit 500|Dependabot Updates|run list' .github . 2>/dev/null | head -200 || true
echo
echo "== gh availability/help =="
if command -v gh >/dev/null 2>&1; then
gh --version | head -3
gh run list --help | sed -n '/limit/,+30p' || true
else
echo "gh not installed"
fi
echo
echo "== repository workflow files =="
find .github/workflows -type f -exec sh -c 'echo "--- {}"; grep -nE "gh run list|limit 500|Dependabot Updates|created" "{}" | head -80 || true' \; || trueRepository: maxmind/GeoIP2-python
Length of output: 6142
🏁 Script executed:
#!/usr/bin/env bin/bash
set -euo pipefail
echo "== gh run list command/source references =="
(
command -v gh >/dev/null 2>&1 && gh --version | head -3 || true
command -v gh >/dev/null 2>&1 && gh run list -L 500 --help | sed -n '/flags/p;/limit/p' || true
command -v gh >/dev/null 2>&1 && gh api -X GET /users/mona/actions/runs?per_page=501\&include_workflow_runs=true >/tmp/maybe_api.json 2>/tmp/maybe_api.err; cat /tmp/maybe_api.err || true
)
echo
echo "== API documentation snippets from local gh docs if present =="
find "$(gh --config-dir 2>/dev/null || echo /tmp)" -path '*gh_run_list*' -type f 2>/dev/null | head -20 | xargs -r grep -n -i 'limit\|per_page\|runs' || trueRepository: maxmind/GeoIP2-python
Length of output: 579
Check for saturation after listing runs.
--limit 500 caps the gh run list result, and with --created newer runs filling that cap, older matching runs are dropped before the failure filter runs. Detect a saturated output page or paginate/split the time range so the watcher fails closed on unseen older failures.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.github/workflows/dependabot-failure-watcher.yml at line 97, Update the gh
run list logic in the Dependabot failure watcher around the --limit 500 option
to detect when the result is saturated and avoid treating the visible page as
complete. Either paginate the run listing or split the --created time range, and
ensure older matching failures remain discoverable so the watcher fails closed
when unseen failures may exist.
Source: MCP tools
GitHub runs both Dependabot version updates and Dependabot security
updates under one workflow name, "Dependabot Updates", and the watcher
counted both. Security updates routinely fail for reasons no pull request
can fix -- the advisory is against a dependency this project does not
declare directly, or no patched version is reachable. Left alone the
watcher stays red every week on those and trains everyone to ignore it.
Filter those runs out by title. Version updates are unaffected.
The title check is subtler than it looks, so document it properly. A
security job is marked by "/." AND a " for " suffix together; version
updates are either "/." with no " for " (the scheduled scan) or "/" with
one (the pull request). Both halves of " in /. for " are therefore
load-bearing -- matching on " in /." alone would discard every scan run,
which is most of the version-update runs and the shape the failures this
watcher was written for actually took.
That "/." spelling only separates the two at the repo root. In a
subdirectory a security update and a version update's pull request render
identically, so drop " in /e2e/{js,ts} for " by name as well. The Node
repos this workflow is shared with carry committed lockfiles under e2e/js
and e2e/ts, whose transitive dev dependencies attract advisories no pull
request can fix, and nothing in either is shipped code. That is 16
unactionable failures in each of GeoIP2-node and minfraud-api-node over
retained history; repos without those directories are unaffected.
Unlike the root filter, this one is not free. Both Node repos configure
npm with directories: ["/", "**/*"], and that glob does match e2e/js and
e2e/ts, so those directories do get version updates -- there is an open
version-update pull request under e2e/ts in both repos as this is
written. Dropping the pattern discards their pull-request refresh
failures along with the security jobs, and the ecosystem label is no help
because Dependabot writes "npm_and_yarn" for both. Taken anyway: the
scheduled scan is what this watcher primarily exists to catch and is
still reported for those directories, so what is given up is the narrower
"one open pull request has gone stale" signal for two directories of test
scaffolding. After filtering, 4 genuine failures remain reported in
GeoIP2-node and 3 in minfraud-api-node.
Reading the directories out of dependabot.yml would look more general and
was the earlier plan here, but it fails green. Entries may use globs, and
minfraud-api-dotnet's directories: ["**/*"] yields titles like "nuget in
/**/*" for the scan and "nuget in /MaxMind.MinFraud for
System.Net.Http.Json" for the pull request, neither of which any literal
comparison against the configured value matches -- so its two real nuget
failures would have been dropped without a word. A stale denylist
re-introduces noise, which is loud; a stale allowlist hides failures.
Name the three kinds of run in the comment while here, because the
scheduled scan and the per-pull-request refresh are easy to conflate: the
refresh runs are one per open pull request and are triggered by pushes to
the base branch or by rebases, not by the schedule, so they arrive in
bursts after merges. The scan is the kind this watcher primarily exists
to catch, which is what makes hiding a hypothetical refresh failure under
e2e an acceptable cost rather than a hole.
Bound the query server-side with --created instead of fetching all of
history and filtering by date locally, so --limit now caps an
already-narrowed window rather than standing in for one, and the run list
drops from several API pages to one. --limit rises 100 -> 500 as a
backstop: it still applies before the title filter, and reaching it would
silently drop the oldest in-window runs.
This workflow is shared verbatim across MaxMind repos. The change was
developed in maxmind/device-android and is applied here unmodified; see
that repo's commit for the measurements it was derived from.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
57f521d to
8c36bd2
Compare
GitHub runs Dependabot version updates and Dependabot security updates under one
workflow name,
Dependabot Updates, and the watcher counted both. Securityupdates routinely fail for reasons no pull request can fix -- the advisory is
against a dependency the project does not declare directly, or no patched
version is reachable -- so the watcher stays red every week on those and trains
everyone to ignore it.
This filters security-update runs out by title, documents why both halves of
" in /. for "are load-bearing, and bounds thegh run listquery server-sidewith
--createdinstead of fetching all of history and filtering locally.See the commit message for the full reasoning, including why reading the
directory list out of
dependabot.ymlwas tried and rejected.This workflow is shared verbatim across MaxMind repos. The change was developed
in maxmind/device-android (maxmind/device-android#71)
and is applied here unmodified; the resulting file is byte-identical in every
repo.
Summary by CodeRabbit