Skip to content

chore(renovate): simplify quickstart and batch weekly linter updates#257

Merged
zeitlinger merged 2 commits intomainfrom
codex/readme-quickstart-renovate-only
Apr 30, 2026
Merged

chore(renovate): simplify quickstart and batch weekly linter updates#257
zeitlinger merged 2 commits intomainfrom
codex/readme-quickstart-renovate-only

Conversation

@zeitlinger
Copy link
Copy Markdown
Member

@zeitlinger zeitlinger commented Apr 29, 2026

Blocked by #253

Summary

  • shrink the README quickstart [tools] example to three representative linters
  • manage those three README example versions with repo-local Renovate regex managers
  • keep the shared default.json free of repo-specific README rules
  • update the Renovate drift test so only shared managers are compared against default.json
  • keep flint-managed linter updates in a single weekly Monday Renovate PR with a clearer generated title

Why

The previous approach made README quickstart version drift break Renovate PRs, even though the README example is repository-specific. This change keeps the example small, keeps its version bumps automatic, and avoids pushing repo-local behavior into the shared preset.

The follow-up Renovate change also keeps linter bumps batched into one Monday PR, including majors, so the repo gets one coordinated linter-update PR instead of split grouped PRs with generic titles.

Validation

  • renovate-config-validator --no-global .github/renovate.json5
  • cargo test repo_renovate_config_stays_aligned_with_shared_preset_contract -- --nocapture
  • cargo test readme_quickstart_tools_snippets_stay_current -- --nocapture
  • cargo test default_renovate_preset_covers_all_linter_tools_weekly
  • cargo test repo_renovate_config_stays_aligned_with_shared_preset_contract
  • mise run lint:fix

Copilot AI review requested due to automatic review settings April 29, 2026 15:28
@zeitlinger zeitlinger requested a review from a team as a code owner April 29, 2026 15:28
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Simplifies the README quickstart [tools] example and moves README version maintenance into repo-local Renovate regex managers, while keeping the shared default.json preset contract stable.

Changes:

  • Reduce README quickstart tool list to three representative linters (shellcheck, shfmt, actionlint).
  • Add repo-local Renovate regex custom managers to update those README example versions automatically.
  • Update the Renovate alignment/drift test and committed renovate dependency snapshot to reflect the repo-local README managers.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/registry/tests.rs Adjusts the Renovate preset alignment test and updates the README quickstart snippet drift test keys.
src/readme_snippets.rs Shrinks QUICKSTART_KEYS to the three README example tools.
src/bin/sync-readme-snippets.rs Updates README snippet renderer to output only the three representative tools.
README.md Shrinks the quickstart [tools] example accordingly.
.github/renovate.json5 Adds repo-local regex managers to update the README quickstart tool versions.
.github/renovate-tracked-deps.json Tracks the new README regex dependencies in the committed Renovate snapshot.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/bin/sync-readme-snippets.rs
@zeitlinger zeitlinger changed the title docs: simplify quickstart renovate management chore(renovate): simplify quickstart and batch weekly linter updates Apr 29, 2026
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
@zeitlinger zeitlinger force-pushed the codex/readme-quickstart-renovate-only branch from 21cb168 to 677eb5e Compare April 30, 2026 13:07
@zeitlinger zeitlinger merged commit e4dd59e into main Apr 30, 2026
13 checks passed
@zeitlinger zeitlinger deleted the codex/readme-quickstart-renovate-only branch April 30, 2026 15:17
This was referenced May 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants