Add coderabbit config and clean up configuration#2
Conversation
Copy Crossplane's coderabbit config as a starting point and remove irrelevant parts. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 | ||
|
|
||
| - name: Lint and Push Protocol Buffers | ||
| - name: Lint Protocol Buffers |
There was a problem hiding this comment.
i'd argue we don't need to do the protobuf linting - we also copy protobufs from c/c to https://github.com/crossplane/function-sdk-go and we don't lint them there either - so that has precedent 🤔
There was a problem hiding this comment.
Yeah, makes sense. Updated.
| error testing uses proper patterns (cmpopts.EquateErrors, sentinel | ||
| errors for complex cases). | ||
|
|
||
| - path: "**/design/**" |
There was a problem hiding this comment.
i see some patterns that are in c/c but not applicable here - want to take a pass to trim this down to only what's applicable in this repo?
There was a problem hiding this comment.
apis/ and test/ I expect will be relevant in the near future, so I left them in. design/ I'm less certain about but figured it was worth keeping in case we introduce design docs here as well.
There was a problem hiding this comment.
I thought it was required by the policy. In any case I'd say to keep it, it allows us also to automatically assign people on PRs and also we might want to match dirs with people in the future
There was a problem hiding this comment.
are you referring to the community extension project policies?
just to be clear, the only requirement there is for OWNERS.md, there is no requirement for CODEOWNERS
There was a problem hiding this comment.
Updated the CODEOWNERS to include the additional maintainers rather than removing it completely.
This repository has additional maintainers beyond the @crossplane/crossplane-maintainers group. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
The protos in this repository are vendored from crossplane/crossplane, so no need to lint them or push them to the Buf schema registry. This avoids the need for a `BUF_TOKEN` secret in this repo. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
|
Warning Ignoring CodeRabbit configuration file changes. For security, only the configuration from the base branch is applied for open source repositories. 📝 WalkthroughWalkthroughA comprehensive CodeRabbit review configuration is introduced alongside adjustments to CI workflow, code ownership assignments, and contributing documentation. The protobuf schema linting CI job is removed, and two additional maintainers are added to the default code-owner rule. ChangesRepository Governance & Review Configuration
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.coderabbit.yaml:
- Around line 170-173: Remove the stray leading double-quote at the start of the
block scalar for the custom check description that begins with "Fails if files
under 'apis/**' or 'cmd/**'..." so the text is a normal YAML block (no literal
leading quote); locate the YAML value containing that sentence and delete the
initial " character so the check instructions read cleanly without the preserved
quote.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 73f5b6c1-4ea8-4859-89ea-e461c0ce4e4e
📒 Files selected for processing (4)
.coderabbit.yaml.github/workflows/ci.ymlCODEOWNERSCONTRIBUTING.md
💤 Files with no reviewable changes (1)
- .github/workflows/ci.yml
| "Fails if files under 'apis/**' or 'cmd/**' remove or rename public | ||
| fields/flags, add new required public fields/flags, or remove behavior | ||
| without label 'breaking-change'. | ||
|
|
There was a problem hiding this comment.
Remove the stray leading quote in custom check instructions.
The block scalar begins with an extra " character, which is preserved literally and makes the check text noisy/ambiguous.
Suggested fix
- name: "Breaking Changes"
mode: "error"
instructions: |
- "Fails if files under 'apis/**' or 'cmd/**' remove or rename public
+ Fails if files under 'apis/**' or 'cmd/**' remove or rename public
fields/flags, add new required public fields/flags, or remove behavior
without label 'breaking-change'.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "Fails if files under 'apis/**' or 'cmd/**' remove or rename public | |
| fields/flags, add new required public fields/flags, or remove behavior | |
| without label 'breaking-change'. | |
| - name: "Breaking Changes" | |
| mode: "error" | |
| instructions: | | |
| Fails if files under 'apis/**' or 'cmd/**' remove or rename public | |
| fields/flags, add new required public fields/flags, or remove behavior | |
| without label 'breaking-change'. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.coderabbit.yaml around lines 170 - 173, Remove the stray leading
double-quote at the start of the block scalar for the custom check description
that begins with "Fails if files under 'apis/**' or 'cmd/**'..." so the text is
a normal YAML block (no literal leading quote); locate the YAML value containing
that sentence and delete the initial " character so the check instructions read
cleanly without the preserved quote.
3 participants
Description of your changes
Three small changes to our repository configuration:
I have:
./nix.sh flake checkto ensure this PR is ready for review.- [ ] Added or updated unit tests.- [ ] Linked a PR or a docs tracking issue to document this change.- [ ] Addedbackport release-x.ylabels to auto-backport this PR.Summary by CodeRabbit
Chores
Documentation