-
Notifications
You must be signed in to change notification settings - Fork 0
ci(coderabbit): make Docstring Coverage advisory #105
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.