diff --git a/.coderabbit.yaml b/.coderabbit.yaml new file mode 100644 index 0000000..f58f943 --- /dev/null +++ b/.coderabbit.yaml @@ -0,0 +1,29 @@ +# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json +# +# CodeRabbit configuration. Only the settings that differ from CodeRabbit's defaults +# are listed here; everything else stays at the default. +# +# inheritance: without this, a repository .coderabbit.yaml is the sole config source and +# REPLACES any organization/UI settings (the docstring ERROR gate itself lives in the UI, +# since the YAML default is `warning`). Enabling inheritance keeps every UI/org setting — +# path filters, request_changes_workflow, custom checks — and only overrides the one value +# defined below, so this change stays scoped to docstrings. +inheritance: true +reviews: + pre_merge_checks: + # Docstring Coverage measures a single coverage percentage across a PR's changed files + # and cannot be scoped per-path (the only path mechanism, reviews.path_filters, would + # drop the files from the whole review rather than from just this metric). + # + # This repository holds no Go — or any other docstring-bearing — production code: it is + # declarative org configuration (deploy/**.yaml), workflow templates, docs and a bash + # test script. So the metric has nothing to measure here and reports 0.00% against an + # 80% threshold, blocking merges on a documentation gap that does not exist (e.g. #103, + # whose only failed pre-merge check was Docstring Coverage 0.00% on a changeset of YAML + # manifests, a bash test and Markdown). + # + # Keep the check as an advisory WARNING — CodeRabbit still reports coverage — instead of + # a hard merge ERROR. Mirrors devantler-tech/ksail#6145, which made the same change for + # the same un-scopeable-metric reason. + docstrings: + mode: warning