fix(#1298): nest tools block under reviews in CodeRabbit config - #1316
fix(#1298): nest tools block under reviews in CodeRabbit config#1316Ryntak94 wants to merge 1 commit into
Conversation
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>
|
@Ryntak94: This pull request explicitly references no jira issue. DetailsIn response to this:
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. |
|
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 Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
|
Note
|
| 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 | 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.
Comment @coderabbitai help to get the list of available commands.
Note for reviewers: the
|
|
/assign |
|
/assign jbpratt |
The
tools:block in.coderabbit.yamlsat at the YAML document root, as a sibling ofreviews:,knowledge_base:andchat:. The CodeRabbit v2 schema (https://coderabbit.ai/integrations/schema.v2.json) setsadditionalProperties: falseat the root and only allowslanguage,tone_instructions,early_access,enable_free_tier,inheritance,issue_enrichment,code_generation,reviews,knowledge_baseandchatthere.toolsis defined underreviews, so the root-level block was rejected as an unrecognized key — which is exactly theValidation 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 thegolangci-lintandgitleakskeys (both valid per the schema, each taking anenabledboolean) and their explanatory comments, and relocates the section banner as a nested subsection alongside the otherreviews.*subsections. No settings change, only their position in the document.Closes #1298
Validation
tools:now sits inside thereviews:block (.coderabbit.yamlline 233), where the v2 schema defines it, with thegolangci-lintandgitleakskeys and theirenabledbooleans unchangedmaster's root-leveltools: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.