dependency-updates does not know `.github/renovate.json5`

Open Beginner friendly
  • Is something wrong?
#245 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
python, scala
Domain
tooling

Research direction

The Renovate locations are a tuple in checks/dependency_updates.py around line 7; add .github/renovate.json5 and the other listed paths there. Scala Steward would need a new .scala-steward.conf entry in the same check, and the issue names no test file. Done when a repo containing only .github/renovate.json5 with {} gets PASS from the dependency-updates check, and the Scala Steward case is handled as well.

Written by the indexing model from the issue text.

Description

prettier (whose CI runs renovate-config-validator on it), vite, okhttp, junit5 and opentelemetry-proto carry .github/renovate.json5 and get WARN "no automated dependency updates configured". checks/dependency_updates.py lists renovate.json5 and .github/renovate.json but not .github/renovate.json5. Also: Scala Steward (.scala-steward.conf, validated in CI by cats and http4s) is the Scala ecosystem's update bot.

Evidence from the corpus audit

prettier/prettier, vitejs/vite / dependency-updates
  • kind: FALSE_NEGATIVE
  • actual: WARN: no automated dependency updates configured
  • expected: PASS: both repositories carry a Renovate configuration at .github/renovate.json5 (prettier's CI even validates it).
  • evidence: prettier .github/renovate.json5:1-3: { / $schema: "https://docs.renovatebot.com/renovate-schema.json", / dependencyDashboardApproval: true,;
    prettier .github/workflows/lint.yml:71: run: yarn dlx --package renovate@latest renovate-config-validator; vite: .github/renovate.json5 exists.
    Validator checks/dependency_updates.py:7: ("Renovate", ("renovate.json", "renovate.json5", ".github/renovate.json", ".renovaterc", ".renovaterc.json"))
    — .github/renovate.json5 (and .renovaterc.json5, .gitlab/renovate.json*) are missing from Renovate's documented locations.
  • repro: a repo with only .github/renovate.json5 containing {}.
  • confidence: high
square/okhttp, junit-team/junit5 / dependency-updates
  • kind: FALSE_NEGATIVE
  • actual: WARN: no automated dependency updates configured (both)
  • expected: PASS: Renovate is configured
  • evidence: okhttp .github/renovate.json5 (file exists; .github/workflows/build.yml:52 even runs rinchsan/renovate-config-validator); junit5 .github/renovate.json5;
    validator project_validator/checks/dependency_updates.py:7: ("Renovate", ("renovate.json", "renovate.json5", ".github/renovate.json", ".renovaterc", ".renovaterc.json")) — .github/renovate.json5 (and .renovaterc.json5, .gitlab/renovate.json[5]) are missing from the list
  • repro: a repo with only .github/renovate.json5 containing {}
  • confidence: high
open-telemetry/opentelemetry-proto / dependency-updates
  • kind: FALSE_NEGATIVE
  • actual: WARN: no automated dependency updates configured
  • expected: PASS: a Renovate configuration exists at .github/renovate.json5 (the # renovate-friendly Dockerfile and helpers:pinGitHubActionDigestsToSemver show it is live).
  • evidence: .github/renovate.json5:1-5: "$schema": "https://docs.renovatebot.com/renovate-schema.json", "extends": ["config:best-practices", ...]; validator project_validator/checks/dependency_updates.py:7: ("Renovate", ("renovate.json", "renovate.json5", ".github/renovate.json", ".renovaterc", ".renovaterc.json")) — .github/renovate.json5 is missing from the tuple (Renovate also accepts .github/renovate.json5, .gitlab/renovate.json5, .renovaterc.json5).
  • repro: a repo with only .github/renovate.json5 containing {"extends": ["config:recommended"]}.
  • confidence: high
typelevel/cats, http4s/http4s / dependency-updates
  • kind: UNSUPPORTED
  • actual: [WARN] dependency-updates: no automated dependency updates configured
  • expected: PASS: Scala Steward is the Scala ecosystem's update bot and both repos configure it and validate the config in CI.
  • evidence: .scala-steward.conf in cats, http4s (also metals and scalafmt, which PASS through Dependabot);
    cats .github/workflows/ci.yml:398: - run: scala-steward validate-repo-config .scala-steward.conf; http4s ci.yml:311 (same).
    Source: checks/dependency_updates.py:6-7 knows Dependabot and Renovate configurations only.
  • repro: an sbt project with a .scala-steward.conf.
  • confidence: high
clap-rs/clap, starship/starship, astral-sh/ruff / dependency-updates
  • kind: FALSE_NEGATIVE
  • actual: WARN: no automated dependency updates configured
  • expected: PASS: Renovate is configured in .github/renovate.json5, a location Renovate documents
  • evidence: clap-rs__clap/.github/renovate.json5, starship__starship/.github/renovate.json5, astral-sh__ruff/.github/renovate.json5 exist (ls .github);
    validator checks/dependency_updates.py:7: ("Renovate", ("renovate.json", "renovate.json5", ".github/renovate.json", ".renovaterc", ".renovaterc.json")) — .github/renovate.json5 missing
  • repro: a repo with only .github/renovate.json5 ({}) → WARN
  • confidence: high

Found by the regression-corpus audit (235 real repositories, one or more per ecosystem profile; corpus and expected results in corpus/). Evidence is quoted from the audited checkouts at the commits pinned in corpus/projects.toml; <checkouts>/<owner>__<repo> is such a checkout.

🤖 Generated with Claude Code

https://claude.ai/code/session_01ByTXNqDWdM7HzezrFtEvQt

Dominant language
Python
Stars
4
Forks
1
Avg merge
10h 41m
Merged PRs (30d)
79

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cpp-best-practices/project_validator

All issues in cpp-best-practices/project_validator

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.