Skip to content

fix(#1298): nest tools block under reviews in CodeRabbit config - #1316

Open
Ryntak94 wants to merge 1 commit into
quay:masterfrom
Ryntak94:fix/coderabbit-tools-key-1298
Open

fix(#1298): nest tools block under reviews in CodeRabbit config#1316
Ryntak94 wants to merge 1 commit into
quay:masterfrom
Ryntak94:fix/coderabbit-tools-key-1298

Conversation

@Ryntak94

@Ryntak94 Ryntak94 commented Aug 25, 2026

Copy link
Copy Markdown

The tools: block in .coderabbit.yaml sat at the YAML document root, as a sibling of reviews:, knowledge_base: and chat:. The CodeRabbit v2 schema (https://coderabbit.ai/integrations/schema.v2.json) sets additionalProperties: false at the root and only allows language, tone_instructions, early_access, enable_free_tier, inheritance, issue_enrichment, code_generation, reviews, knowledge_base and chat there. tools is defined under reviews, so the root-level block was rejected as an unrecognized key — which is exactly the Validation error: Unrecognized key: "tools" warning CodeRabbit posted on #1296 — and both the golangci-lint and gitleaks integrations were silently disabled for every review.

This moves the block to reviews.tools, keeping the golangci-lint and gitleaks keys (both valid per the schema, each taking an enabled boolean) and their explanatory comments, and relocates the section banner as a nested subsection alongside the other reviews.* subsections. No settings change, only their position in the document.


Closes #1298

Validation

  • tools: now sits inside the reviews: block (.coderabbit.yaml line 233), where the v2 schema defines it, with the golangci-lint and gitleaks keys and their enabled booleans unchanged
  • The file validated cleanly against schema.v2.json when the change was made
  • Not verifiable on this PR — criteria 1 and 2 in the issue (no configuration warning; golangci-lint/gitleaks findings appearing in reviews) can only be confirmed after this merges. CodeRabbit reviews a fork PR using the target branch's configuration, so the review here reads master's root-level tools: key and warns about it regardless of what this branch does. See the comment below for the details; both criteria should be checked on the first PR opened after this one lands.

The tools: block sat at the YAML document root as a sibling of
reviews:, knowledge_base: and chat:. The CodeRabbit v2 schema
(https://coderabbit.ai/integrations/schema.v2.json) sets
additionalProperties: false at the root and only allows language,
tone_instructions, early_access, enable_free_tier, inheritance,
issue_enrichment, code_generation, reviews, knowledge_base and chat
there. tools is defined under reviews, so the root-level block was
rejected as an unrecognized key and both the golangci-lint and
gitleaks integrations were silently disabled for every review.

Move the block to reviews.tools, keeping the golangci-lint and
gitleaks keys (both valid per the schema, each taking an enabled
boolean) and their explanatory comments, and relocate the section
banner as a nested subsection alongside the other reviews.*
subsections. The file now validates cleanly against the v2 schema.

Closes quay#1298

Signed-off-by: Ryan Matthews <ryan.matthews.professional@gmail.com>
@openshift-ci-robot

Copy link
Copy Markdown
Collaborator

@Ryntak94: This pull request explicitly references no jira issue.

Details

In response to this:

The tools: block in .coderabbit.yaml sat at the YAML document root, as a sibling of reviews:, knowledge_base: and chat:. The CodeRabbit v2 schema (https://coderabbit.ai/integrations/schema.v2.json) sets additionalProperties: false at the root and only allows language, tone_instructions, early_access, enable_free_tier, inheritance, issue_enrichment, code_generation, reviews, knowledge_base and chat there. tools is defined under reviews, so the root-level block was rejected as an unrecognized key — which is exactly the Validation error: Unrecognized key: "tools" warning CodeRabbit posted on #1296 — and both the golangci-lint and gitleaks integrations were silently disabled for every review.

This moves the block to reviews.tools, keeping the golangci-lint and gitleaks keys (both valid per the schema, each taking an enabled boolean) and their explanatory comments, and relocates the section banner as a nested subsection alongside the other reviews.* subsections. No settings change, only their position in the document.


Closes #1298

Validation

  • tools: now sits inside the reviews: block (.coderabbit.yaml line 233), where the v2 schema defines it, with the golangci-lint and gitleaks keys and their enabled booleans unchanged
  • The file validated cleanly against schema.v2.json when the change was made
  • Confirmed against a live review — the definitive check is that CodeRabbit posts no configuration warning on this PR, and that golangci-lint/gitleaks findings appear in its review

Opened as a draft: CodeRabbit's own review of this PR is the end-to-end validation for criteria 1 and 2 in the issue.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci

openshift-ci Bot commented Aug 25, 2026

Copy link
Copy Markdown

Hi @Ryntak94. Thanks for your PR.

I'm waiting for a quay member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown

Note

.coderabbit.yaml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

⚠️ Parsing warnings (1)
Validation error: Unrecognized key: "tools"
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: a3b902dc-b303-40fc-84c8-40bbef2fd77c

📥 Commits

Reviewing files that changed from the base of the PR and between 691a3b4 and 8519198.

📒 Files selected for processing (1)
  • .coderabbit.yaml

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The .coderabbit.yaml configuration moves the tools block from the top level into reviews.tools. The golangci-lint and gitleaks settings remain unchanged.

Changes

CodeRabbit configuration

Layer / File(s) Summary
Move tool configuration under reviews
.coderabbit.yaml
Removes the top-level tools block and adds the same golangci-lint and gitleaks configuration under reviews.tools.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 85191

This PR only moves the existing review-tool configuration under the correct settings block, preserving its values. No actionable merge-blocking risk remains after normal checks and review; live confirmation of the integrations can remain a follow-up.

🚥 Pre-merge checks | ✅ 8 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title describes the configuration change, but it does not start with a PROJQUAY Jira ticket reference or NO-ISSUE:. Rename the title to start with a valid reference, such as "PROJQUAY-1298: nest tools block under reviews in CodeRabbit config" or "NO-ISSUE: nest tools block under reviews in CodeRabbit config".
✅ Passed checks (8 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The PR moves tools under reviews.tools, which addresses issue #1298's schema-location requirement and preserves the golangci-lint and gitleaks settings. The stated schema validation supports the imple…
Out of Scope Changes check ✅ Passed The PR changes only the nesting of the tools block in .coderabbit.yaml. The change directly supports issue #1298 and contains no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Crd Backward Compatibility ✅ Passed The pull request changes only .coderabbit.yaml. The committed diff against its parent contains no files under apis/quay/v1/, so no CRD backward-compatibility check applies.
No Weak Cryptographic Algorithms ✅ Passed PASS — The PR changes only .coderabbit.yaml. The diff moves the existing tools block under reviews; it adds no cryptographic implementation, weak algorithm usage, or InsecureSkipVerify: true. …
No Privileged Containers ✅ Passed PASS. The pull request changes only .coderabbit.yaml. The diff moves the tools configuration under reviews; it adds no container or Kubernetes manifest settings. The privileged, hostPID, `ho…
No Sensitive Data In Logs ✅ Passed PASS: The pull request changes only .coderabbit.yaml, moving the existing tools block under reviews. The diff introduces no log.Info, log.Error, klog.*, or fmt.Print* logging statements,…
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Full details: Linked Issues check

Explanation

The PR moves tools under reviews.tools, which addresses issue #1298's schema-location requirement and preserves the golangci-lint and gitleaks settings. The stated schema validation supports the implementation.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Full details: No Weak Cryptographic Algorithms

Explanation

PASS — The PR changes only .coderabbit.yaml. The diff moves the existing tools block under reviews; it adds no cryptographic implementation, weak algorithm usage, or InsecureSkipVerify: true. The MD5/SHA-1/DES/RC4/3DES text remains unchanged as review instructions, not code usage.

Full details: No Privileged Containers

Explanation

PASS. The pull request changes only .coderabbit.yaml. The diff moves the tools configuration under reviews; it adds no container or Kubernetes manifest settings. The privileged, hostPID, hostNetwork, hostIPC, and SYS_ADMIN matches are review-instruction text, not privilege declarations, and the relevant matches are pre-existing.

Full details: No Sensitive Data In Logs

Explanation

PASS: The pull request changes only .coderabbit.yaml, moving the existing tools block under reviews. The diff introduces no log.Info, log.Error, klog.*, or fmt.Print* logging statements, and it adds no sensitive values. The word secrets appears only in a configuration comment describing gitleaks.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Ryntak94
Ryntak94 marked this pull request as ready for review August 25, 2026 03:10
@Ryntak94

Copy link
Copy Markdown
Author

Note for reviewers: the Unrecognized key: "tools" warning above is expected on this PR

CodeRabbit has posted its usual Validation error: Unrecognized key: "tools" note on this PR — the very warning this PR fixes. That is not evidence the fix doesn't work. CodeRabbit reviews a fork PR using the configuration from the target branch, not the one in the PR. It spells this out itself on the sibling PR #1317:

This pull request changes a CodeRabbit configuration file. Because it comes from a fork or its author is not a repository collaborator, reviews use only the configuration from the target branch. The proposed configuration will take effect after it is merged.

So the review that runs here reads master's .coderabbit.yaml, where tools: is still at the document root — and correctly warns about it. The moved block on this branch is never loaded.

That makes validation criterion 1 in #1298 ("CodeRabbit no longer reports a configuration warning on new PRs") unverifiable before merge, by construction; the same applies to criterion 2, since golangci-lint and gitleaks stay disabled while the root-level tools: key is the one in effect. Both should be confirmed on the first PR opened after this one merges, and this change is trivially revertable if they aren't.

What can be checked here and now, from the diff alone:

  • tools: now sits under reviews:, which is where the v2 schema defines it — the root object sets additionalProperties: false and does not list tools among its allowed keys.
  • The golangci-lint and gitleaks entries and their enabled booleans are carried over unchanged; this is a move, not a settings change.

@Ryntak94 Ryntak94 changed the title NO-ISSUE: fix(#1298): nest tools block under reviews in CodeRabbit config fix(#1298): nest tools block under reviews in CodeRabbit config Aug 25, 2026
@Ryntak94

Copy link
Copy Markdown
Author

/assign

@Ryntak94 Ryntak94 removed their assignment Aug 25, 2026
@Ryntak94

Copy link
Copy Markdown
Author

/assign jbpratt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

fix .coderabbit.yaml: tools key is unrecognized, golangci-lint and gitleaks are silently disabled

3 participants