feat: add README validator configuration and update requirements#48
Merged
Merged
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces README validator configurations (.readme-validator.yaml) at the root and in the configs/ directory, updates the root and pre-commit READMEs with detailed requirements, and reformats several JSON configuration files (release-please-config.json, renovate-grouping.json, and renovate-presets.json) into a more compact, single-line array format. The review feedback highlights a syntax issue in the README.md where a JavaScript-style comment is used inside a JSON code block, and suggests adding References and Layout to the optional_sections in the README validator configurations to prevent validation failures on the repository's own documentation.
…renovate-presets.json conflicts with Biome formatting
… update renovate.json to manage biome version
Biome 2.4+ changed the `expand` default so `auto` collapses primitive arrays that fit within lineWidth — turning readable one-item-per-line Renovate config into dense single-line arrays. Pin `json.formatter.expand: "always"` in the canonical config to restore the expanded, greppable, clean-diff style, and reformat all JSON so the committed files match. Assisted-by: Claude:claude-opus-4-8 Claude-Session: https://claude.ai/code/session_019fUUJwmbqHgziAmyPxZEDb
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the canonical README validator configuration (
.readme-validator.yaml) to the organization-wide.githubrepository, making the "Requirements" section required across all repositories. Updates this repository's rootREADME.mdandprecommit/README.mdto define and satisfy the new "Requirements" section.Changes
configs/.readme-validator.yamland root.readme-validator.yamlwith a requiredRequirementssection and additionalReferencesandLayoutoptional sections.Requirementssection listing thetofu-githubrepository configuration dependency and optional Nix/direnv setup, plus added a valid JSON block for installation references.Requirementssection specifying git, runtime tool dependencies (Node, Python, Terraform), and optional Nix/direnv setup.Test Plan
npx markdownlint-cli2 "**/*.md"andnpx @biomejs/biome check .both report 0 errors.