[PATCH] ci: configure Coderabbit

[PATCH] ci: configure Coderabbit

[David Marchand]

Coderabbit currently runs in ovsrobot repository (and can be used in
public personal forks).

poems are funny, but not really helpful.
Reduce some noise by disabling (or collapsing) some verbose outputs.

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
I copied the tone instructions and some settings from grout.
The docstrings check is noisy, and often wrong for C headers
(especially EAL arch headers).

Opinions?

---
 .coderabbit.yaml           | 14 ++++++++++++++
 MAINTAINERS                |  1 +
 devtools/check-spdx-tag.sh |  2 +-
 3 files changed, 16 insertions(+), 1 deletion(-)
 create mode 100644 .coderabbit.yaml

diff --git a/.coderabbit.yaml b/.coderabbit.yaml
new file mode 100644
index 0000000000..7968f4f4ba
--- /dev/null
+++ b/.coderabbit.yaml
@@ -0,0 +1,14 @@
+language: "en-US"
+tone_instructions: "Only provide helpful, relevant comments. Be brief and terse but clear."
+reviews:
+  profile: "chill"
+  collapse_walkthrough: true
+  changed_files_summary: false
+  sequence_diagrams: false
+  suggested_labels: false
+  poem: false
+  finishing_touches:
+    docstrings:
+      enabled: false
+    unit_tests:
+      enabled: false
diff --git a/MAINTAINERS b/MAINTAINERS
index 1a2729be66..b82632fea3 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -141,6 +141,7 @@ M: Aaron Conole <aconole@redhat.com>
 M: Michael Santana <maicolgabriel@hotmail.com>
 F: .github/workflows/build.yml
 F: .ci/
+F: .coderabbit.yaml
 
 Driver information
 M: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
diff --git a/devtools/check-spdx-tag.sh b/devtools/check-spdx-tag.sh
index 984825026e..eb4a88a3fb 100755
--- a/devtools/check-spdx-tag.sh
+++ b/devtools/check-spdx-tag.sh
@@ -18,7 +18,7 @@ print_usage () {
 no_license_list=\
 ':^.git* :^.mailmap :^.ci/* :^README :^*/README* :^MAINTAINERS :^VERSION :^ABI_VERSION '\
 ':^license/ :^config/ :^buildtools/ :^*.abignore :^*.cocci :^*/poetry.lock '\
-':^*/Kbuild :^kernel/linux/uapi/version '\
+':^*/Kbuild :^kernel/linux/uapi/version :^.coderabbit.yaml '\
 ':^*.ini :^*.data :^*.json :^*.cfg :^*.txt :^*.svg :^*.png'
 
 check_spdx() {
-- 
2.51.0

Re: [PATCH] ci: configure Coderabbit

[Burakov, Anatoly]

On 10/1/2025 10:18 AM, David Marchand wrote:
> Coderabbit currently runs in ovsrobot repository (and can be used in
> public personal forks).
> 
> poems are funny, but not really helpful.
> Reduce some noise by disabling (or collapsing) some verbose outputs.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> I copied the tone instructions and some settings from grout.
> The docstrings check is noisy, and often wrong for C headers
> (especially EAL arch headers).
> 
> Opinions?
> 
> ---

Hi David,

Can you provide a little more details on what exactly you are proposing?

On the back of this patch, I installed CodeRabbit in my IDE (VSCode), 
and did a review of one of my recent patchsets - it's quite interesting, 
actually, and the comments provided were basic but meaningful, alas the 
free version is limited to like 1 review per 30 minutes or something so 
it's a bit limiting. On top of that, I found the tool a lot more usable 
than GitHub Copilot reviews, which are attached to GH pull requests 
rather than Git branches, and they take a lot less time to boot, so I 
feel like this tool has potential.

That said, I'm not sure what this patch is supposed to do - is it to 
have it set up to review patches automatically?

-- 
Thanks,
Anatoly

Re: [PATCH] ci: configure Coderabbit

[David Marchand]

On Wed, 1 Oct 2025 at 16:04, Burakov, Anatoly <anatoly.burakov@intel.com> wrote:
>
> On 10/1/2025 10:18 AM, David Marchand wrote:
> > Coderabbit currently runs in ovsrobot repository (and can be used in
> > public personal forks).
> >
> > poems are funny, but not really helpful.
> > Reduce some noise by disabling (or collapsing) some verbose outputs.
> >
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
> > ---
> > I copied the tone instructions and some settings from grout.
> > The docstrings check is noisy, and often wrong for C headers
> > (especially EAL arch headers).
> >
> > Opinions?
> >
> > ---
>
> Hi David,
>
> Can you provide a little more details on what exactly you are proposing?
>
> On the back of this patch, I installed CodeRabbit in my IDE (VSCode),
> and did a review of one of my recent patchsets - it's quite interesting,
> actually, and the comments provided were basic but meaningful, alas the
> free version is limited to like 1 review per 30 minutes or something so
> it's a bit limiting. On top of that, I found the tool a lot more usable
> than GitHub Copilot reviews, which are attached to GH pull requests
> rather than Git branches, and they take a lot less time to boot, so I
> feel like this tool has potential.
>
> That said, I'm not sure what this patch is supposed to do - is it to
> have it set up to review patches automatically?

The ovsrobot creates pull requests in its dpdk github repository, and
Coderabbit and sourcery are invoked on them.
Look for a link in patchwork, under the name "ci/github-robot-post".

For example, this exact patch got a branch and pr in ovsrobot/dpdk:
https://github.com/ovsrobot/dpdk/tree/series_36267
https://github.com/ovsrobot/dpdk/pull/124


-- 
David Marchand

Re: [PATCH] ci: configure Coderabbit

[David Marchand]

On Wed, 1 Oct 2025 at 16:12, David Marchand <david.marchand@redhat.com> wrote:
> On Wed, 1 Oct 2025 at 16:04, Burakov, Anatoly <anatoly.burakov@intel.com> wrote:
> > Can you provide a little more details on what exactly you are proposing?
> >
> > On the back of this patch, I installed CodeRabbit in my IDE (VSCode),
> > and did a review of one of my recent patchsets - it's quite interesting,
> > actually, and the comments provided were basic but meaningful, alas the
> > free version is limited to like 1 review per 30 minutes or something so
> > it's a bit limiting. On top of that, I found the tool a lot more usable
> > than GitHub Copilot reviews, which are attached to GH pull requests
> > rather than Git branches, and they take a lot less time to boot, so I
> > feel like this tool has potential.
> >
> > That said, I'm not sure what this patch is supposed to do - is it to
> > have it set up to review patches automatically?
>
> The ovsrobot creates pull requests in its dpdk github repository, and
> Coderabbit and sourcery are invoked on them.
> Look for a link in patchwork, under the name "ci/github-robot-post".
>
> For example, this exact patch got a branch and pr in ovsrobot/dpdk:
> https://github.com/ovsrobot/dpdk/tree/series_36267
> https://github.com/ovsrobot/dpdk/pull/124

Btw, you'll notice a bit of noise, due to how the PR is created
against ovsrobot/main, and not the exact DPDK main branch at the
moment the patch is submitted on the ml.


-- 
David Marchand

Re: [PATCH] ci: configure Coderabbit

[Burakov, Anatoly]

On 10/1/2025 4:23 PM, David Marchand wrote:
> On Wed, 1 Oct 2025 at 16:12, David Marchand <david.marchand@redhat.com> wrote:
>> On Wed, 1 Oct 2025 at 16:04, Burakov, Anatoly <anatoly.burakov@intel.com> wrote:
>>> Can you provide a little more details on what exactly you are proposing?
>>>
>>> On the back of this patch, I installed CodeRabbit in my IDE (VSCode),
>>> and did a review of one of my recent patchsets - it's quite interesting,
>>> actually, and the comments provided were basic but meaningful, alas the
>>> free version is limited to like 1 review per 30 minutes or something so
>>> it's a bit limiting. On top of that, I found the tool a lot more usable
>>> than GitHub Copilot reviews, which are attached to GH pull requests
>>> rather than Git branches, and they take a lot less time to boot, so I
>>> feel like this tool has potential.
>>>
>>> That said, I'm not sure what this patch is supposed to do - is it to
>>> have it set up to review patches automatically?
>>
>> The ovsrobot creates pull requests in its dpdk github repository, and
>> Coderabbit and sourcery are invoked on them.
>> Look for a link in patchwork, under the name "ci/github-robot-post".
>>
>> For example, this exact patch got a branch and pr in ovsrobot/dpdk:
>> https://github.com/ovsrobot/dpdk/tree/series_36267
>> https://github.com/ovsrobot/dpdk/pull/124
> 
> Btw, you'll notice a bit of noise, due to how the PR is created
> against ovsrobot/main, and not the exact DPDK main branch at the
> moment the patch is submitted on the ml.
> 
> 

Wow, I didn't know this was a thing! Sourcery actually seems like the 
more impressive one in terms of summarizing the changes and aiding in 
review, but those two in tandem look pretty cool indeed. Makes me think 
of an alternate reality where we use GitHub (or something else more 
modern) to review code :)

So I guess this patch just configures CodeRabbit better. In that case,

Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>

-- 
Thanks,
Anatoly

Re: [PATCH] ci: configure Coderabbit

[David Marchand]

On Thu, 2 Oct 2025 at 12:34, Burakov, Anatoly <anatoly.burakov@intel.com> wrote:
>
> On 10/1/2025 4:23 PM, David Marchand wrote:
> > On Wed, 1 Oct 2025 at 16:12, David Marchand <david.marchand@redhat.com> wrote:
> >> On Wed, 1 Oct 2025 at 16:04, Burakov, Anatoly <anatoly.burakov@intel.com> wrote:
> >>> Can you provide a little more details on what exactly you are proposing?
> >>>
> >>> On the back of this patch, I installed CodeRabbit in my IDE (VSCode),
> >>> and did a review of one of my recent patchsets - it's quite interesting,
> >>> actually, and the comments provided were basic but meaningful, alas the
> >>> free version is limited to like 1 review per 30 minutes or something so
> >>> it's a bit limiting. On top of that, I found the tool a lot more usable
> >>> than GitHub Copilot reviews, which are attached to GH pull requests
> >>> rather than Git branches, and they take a lot less time to boot, so I
> >>> feel like this tool has potential.
> >>>
> >>> That said, I'm not sure what this patch is supposed to do - is it to
> >>> have it set up to review patches automatically?
> >>
> >> The ovsrobot creates pull requests in its dpdk github repository, and
> >> Coderabbit and sourcery are invoked on them.
> >> Look for a link in patchwork, under the name "ci/github-robot-post".
> >>
> >> For example, this exact patch got a branch and pr in ovsrobot/dpdk:
> >> https://github.com/ovsrobot/dpdk/tree/series_36267
> >> https://github.com/ovsrobot/dpdk/pull/124
> >
> > Btw, you'll notice a bit of noise, due to how the PR is created
> > against ovsrobot/main, and not the exact DPDK main branch at the
> > moment the patch is submitted on the ml.
> >
> >
>
> Wow, I didn't know this was a thing! Sourcery actually seems like the
> more impressive one in terms of summarizing the changes and aiding in
> review, but those two in tandem look pretty cool indeed. Makes me think

Well, Robin gave better feedback on Coderabbit than on Sourcery so far.
Coderabbit seems less picky on credits when it comes to opensource
projects (I did not check in details, that's *my* feeling when looking
at reviews in DPDK PRs where I see sourcery complaining we consumed
too many credits recently).

One important difference between the two is that it does not seem
possible to tweak sourcery with settings stored in your repo like what
is done in this patch.
This may be a problem for the DPDK github org, where we have DPDK and
grout starting to use AI bot for reviews, and may have different
opinions on how to configure the tools.


> of an alternate reality where we use GitHub (or something else more
> modern) to review code :)

Erm, my personal opinion, the github PR webui is a *mess*.


-- 
David Marchand

Re: [PATCH] ci: configure Coderabbit

[Burakov, Anatoly]

On 10/2/2025 1:54 PM, David Marchand wrote:
> On Thu, 2 Oct 2025 at 12:34, Burakov, Anatoly <anatoly.burakov@intel.com> wrote:
>>
>> On 10/1/2025 4:23 PM, David Marchand wrote:
>>> On Wed, 1 Oct 2025 at 16:12, David Marchand <david.marchand@redhat.com> wrote:
>>>> On Wed, 1 Oct 2025 at 16:04, Burakov, Anatoly <anatoly.burakov@intel.com> wrote:
>>>>> Can you provide a little more details on what exactly you are proposing?
>>>>>
>>>>> On the back of this patch, I installed CodeRabbit in my IDE (VSCode),
>>>>> and did a review of one of my recent patchsets - it's quite interesting,
>>>>> actually, and the comments provided were basic but meaningful, alas the
>>>>> free version is limited to like 1 review per 30 minutes or something so
>>>>> it's a bit limiting. On top of that, I found the tool a lot more usable
>>>>> than GitHub Copilot reviews, which are attached to GH pull requests
>>>>> rather than Git branches, and they take a lot less time to boot, so I
>>>>> feel like this tool has potential.
>>>>>
>>>>> That said, I'm not sure what this patch is supposed to do - is it to
>>>>> have it set up to review patches automatically?
>>>>
>>>> The ovsrobot creates pull requests in its dpdk github repository, and
>>>> Coderabbit and sourcery are invoked on them.
>>>> Look for a link in patchwork, under the name "ci/github-robot-post".
>>>>
>>>> For example, this exact patch got a branch and pr in ovsrobot/dpdk:
>>>> https://github.com/ovsrobot/dpdk/tree/series_36267
>>>> https://github.com/ovsrobot/dpdk/pull/124
>>>
>>> Btw, you'll notice a bit of noise, due to how the PR is created
>>> against ovsrobot/main, and not the exact DPDK main branch at the
>>> moment the patch is submitted on the ml.
>>>
>>>
>>
>> Wow, I didn't know this was a thing! Sourcery actually seems like the
>> more impressive one in terms of summarizing the changes and aiding in
>> review, but those two in tandem look pretty cool indeed. Makes me think
> 
> Well, Robin gave better feedback on Coderabbit than on Sourcery so far.
> Coderabbit seems less picky on credits when it comes to opensource
> projects (I did not check in details, that's *my* feeling when looking
> at reviews in DPDK PRs where I see sourcery complaining we consumed
> too many credits recently).
> 
> One important difference between the two is that it does not seem
> possible to tweak sourcery with settings stored in your repo like what
> is done in this patch.
> This may be a problem for the DPDK github org, where we have DPDK and
> grout starting to use AI bot for reviews, and may have different
> opinions on how to configure the tools.

Well, sure, but I meant in terms of actual usefulness of the tool rather 
than the technicalities of its usage. It may very well be that 
CodeRabbit is more generous and configurable. I was mostly referring to 
Sourcery's ability to summarize review and provide context that, at 
least for the examples that I looked at, seems to be helpful.

> 
> 
>> of an alternate reality where we use GitHub (or something else more
>> modern) to review code :)
> 
> Erm, my personal opinion, the github PR webui is a *mess*.

Just about every review format is going to be a mess, but I'm comparing 
it to patches and patchwork. There's a lot wrong with web UI's such as 
GitHub/GitLab etc. but they do fix *some* issues with patch workflow, 
and there's a lot to be said for having reviewed code right in your IDE 
(which IDE's can do with GitHub integration) where you can debug it and 
provide comments inline. I personally find that to be valuable.

-- 
Thanks,
Anatoly