Skip to content

feat: improve coderabbit workflow #5294

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.

Sign up for GitHub

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

Open
animeshk923 wants to merge 4 commits into
base: master
Choose a base branch
from
+52 −0
Open

feat: improve coderabbit workflow #5294

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a799f6c
feat: improve coderabbit workflow
animeshk923 Mar 28, 2026
294df52
Merge branch 'master' into coderabbit-power-up
animeshk923 Mar 29, 2026
7f6dce6
Update .coderabbit.yaml
animeshk923 Mar 29, 2026
328d232
fix: apply suggestion from
animeshk923 Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .coderabbit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
language: "en-US"
reviews:
poem: false
suggested_reviewers: false
suggested_labels: false
sequence_diagrams: false
high_level_summary: true
high_level_summary_placeholder: "@coderabbitai summary"
profile: chill
auto_review:
enabled: true
auto_incremental_review: true
ignore_usernames: [dependabot, asyncapi-bot]
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Mar 29, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify actual PR author logins used in asyncapi/website (read-only).
# Expected: confirm exact bot logins, then mirror them in reviews.auto_review.ignore_usernames.

gh api repos/asyncapi/website/pulls --paginate -q '.[].user.login' \
  | sort -u \
  | rg -n 'dependabot|asyncapi-bot'

Repository: asyncapi/website

Length of output: 90

🏁 Script executed:

# Search for bot references in the repository structure
find . -type f \( -name "*.yml" -o -name "*.yaml" -o -name "*.md" \) | head -20

Repository: asyncapi/website

Length of output: 960

🏁 Script executed:

# Look for workflow files that might mention bots
fd -e yml -e yaml .github/workflows/ 2>/dev/null | xargs grep -l "dependabot\|asyncapi-bot" 2>/dev/null || echo "No matches found"

Repository: asyncapi/website

Length of output: 76

🏁 Script executed:

# Search for any mentions of bot usernames in the codebase
rg "dependabot|asyncapi-bot" -t yml -t yaml -t md 2>/dev/null || echo "No matches found"

Repository: asyncapi/website

Length of output: 76

🌐 Web query:

GitHub bot usernames naming conventions dependabot asyncapi-bot exact format

💡 Result:

GitHub bot usernames follow a convention of ending with -bot or [bot]. Dependabot uses dependabot-bot (commit signing account for the Dependabot app, github.com/dependabot-bot). asyncapi-bot is the top contributor to AsyncAPI repositories like asyncapi/chatbot (github.com/asyncapi/chatbot contributors). No strict official format is documented in GitHub docs; common practice is descriptive name + "-bot" for identification as a bot account. GitHub usernames allow alphanumeric characters and hyphens, no underscores generally (except internal uses). Branch names for Dependabot PRs follow "dependabot/{packageManager}/{targetBranch}/{dependencyName}-{version}", configurable via dependabot.yml (e.g., separator: space or hyphen).

Citations:

🏁 Script executed:

# Check if there's any CONTRIBUTING or documentation mentioning bots
fd -t f \( -name "CONTRIBUTING*" -o -name "AUTHOR*" -o -name "README*" \) | xargs grep -l "bot\|dependabot" 2>/dev/null || echo "No docs found mentioning bots"

Repository: asyncapi/website

Length of output: 337

🏁 Script executed:

# Search for any references to bot accounts in the entire repo
rg "asyncapi-bot|dependabot" -i --max-count 20 2>/dev/null || echo "No references found"

Repository: asyncapi/website

Length of output: 2328

🏁 Script executed:

# Check the .coderabbit.yaml file to see full context
cat -n .coderabbit.yaml | head -30

Repository: asyncapi/website

Length of output: 1280

🌐 Web query:

asyncapi-bot-eve GitHub AsyncAPI project bot username

💡 Result:

The GitHub username for the asyncapi-bot-eve, which is an official bot for the AsyncAPI project named after their mascot Eve, is asyncapi-bot-eve. It handles automation tasks like managing global GitHub Actions workflows across AsyncAPI repositories, as part of the @asyncapi/bots team. Repositories need to add @asyncapi-bot-eve to their CODEOWNERS file for automatic PR approvals from the bot.

Citations:

Add asyncapi-bot-eve to the ignore_usernames list.

Line 13 is missing asyncapi-bot-eve, which is the official AsyncAPI bot listed in CODEOWNERS and governance documentation as actively used for GitHub Actions automation. The configuration should be:

ignore_usernames: [dependabot, asyncapi-bot, asyncapi-bot-eve]

This ensures auto-review is skipped for both dependabot and the AsyncAPI bot accounts. The current configuration will still trigger auto-reviews for PRs from asyncapi-bot-eve.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.coderabbit.yaml at line 13, Update the ignore_usernames list so it includes
the AsyncAPI automation account: add "asyncapi-bot-eve" to the existing
ignore_usernames array (the YAML key ignore_usernames) so the entry becomes
[dependabot, asyncapi-bot, asyncapi-bot-eve]; ensure proper YAML quoting/commas
if needed and keep the same spacing/style as the surrounding file.

Copy link
Copy Markdown
Contributor Author

@animeshk923 animeshk923 Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be implemented?

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check actual PR authors that are bots in asyncapi/website
gh api "repos/asyncapi/website/pulls?state=all&per_page=50" \
  -q '.[].user | select(.type == "Bot" or (.login | test("bot"; "i"))) | .login' \
  | sort | uniq -c | sort -rn | head -20

Length of output: 44

@animeshk923 Based on checking the last 50 PRs in asyncapi/website, the only bot accounts that actually open PRs are:

Bot PRs (recent 50)
asyncapi-bot 15
dependabot[bot] 12
asyncapi-bot-eve 0

asyncapi-bot-eve operates as a reviewer/approver (via CODEOWNERS), not as a PR author, so adding it to ignore_usernames would have no practical effect for this repository.

You can safely skip this suggestion. The current configuration already covers the bots that actually open PRs here.

One minor note for awareness: the actual GitHub login for Dependabot is dependabot[bot], but CodeRabbit's ignore_usernames matching is case-insensitive and handles the [bot] suffix, so the existing dependabot entry works correctly.

🧠 Learnings used 
Learnt from: akshatnema
Repo: asyncapi/website PR: 3298
File: .coderrabbit.yml:2-2
Timestamp: 2024-10-23T09:13:57.844Z
Learning: When a user prefers detailed reviews including nitpicks, set `reviews.profile` to `"assertive"` in the `.coderrabbit.yml` configuration file.

Learnt from: akshatnema
Repo: asyncapi/website PR: 3265
File: tests/fixtures/toolsObjectData.js:51-52
Timestamp: 2024-10-09T17:35:36.557Z
Learning: When reviewing code in the 'asyncapi/website' repository, akshatnema prefers that I do not provide committable code suggestions.

Learnt from: asyncapi-bot
Repo: asyncapi/website PR: 0
File: :0-0
Timestamp: 2025-02-18T12:07:42.211Z
Learning: The following PR commands are supported in the asyncapi/website repository:
- `/please-take-a-look` or `/ptal`: Requests attention from reviewers who haven't reviewed the PR
- `/ready-to-merge` or `/rtm`: Triggers automerge when all conditions are met
- `/do-not-merge` or `/dnm`: Blocks automerge even if all conditions are met
- `/autoupdate` or `/au`: Adds autoupdate label to keep PR in sync with target branch
- `/update` or `/u`: One-time update of PR with latest changes from target branch

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

Copy link
Copy Markdown
Member

@princerajpoot20 princerajpoot20 Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@animeshk923 not needed. asyncapi-bot-eve does not creats pr

review_status: true
commit_status: true
changed_files_summary: true
assess_linked_issues: true
related_issues: true
related_prs: true
pre_merge_checks:
title:
mode: error
requirements: "Use a concise title that follows our Conventional Commits guidelines and clearly summarizes the change in imperative mood (for example: 'add new helper for listing operations')."
tools:
markdownlint:
enabled: true
Expand All @@ -27,9 +47,20 @@ reviews:
enabled: true
knowledge_base:
opt_out: false
web_search:
enabled: true
# Code Guidelines - automatically detects team standards
code_guidelines:
enabled: true
filePatterns:
# Add custom patterns here if you have other guideline files:
- ".github/pr-review-checklist.md"
- "CONTRIBUTING.md"
learnings:
scope: "local"
issues:
scope: "local"
pull_requests:
scope: "local"
mcp:
usage: auto
19 changes: 19 additions & 0 deletions .github/pr-review-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### What reviewer looks at during PR review
The following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge.

1. **PR Title**: Use a concise title that follows our [Conventional Commits](https://github.com/asyncapi/website/blob/master/CONTRIBUTING.md#conventional-commits) guidelines and clearly summarizes the change using [imperative mood](https://cbea.ms/git-commit/#imperative) (it means `spoken or written as if giving a command or instruction`, like "add new helper for listing operations")

1. **PR Description**: Clearly explain the issue being solved, summarize the changes made, and mention the related issue.
> **Note** - Ensure the PR Description includes `Resolves #<issue-number>` or `Fixes #<issue-number>` this will automatically close the linked issue when the PR is merged and helps automate the maintainers workflow.

Comment on lines +1 to +8
Copy link
Copy Markdown
Member

@princerajpoot20 princerajpoot20 Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this checklist, please add the most important point: attaching testing evidence from the temporary deployment link. This should be mandatory.

Even if your code is just a refactoring and does not add any new features, you should still provide testing evidence for the parts of the code you modified to ensure there are no regressions.

Hence, please add this point.

Copy link
Copy Markdown
Contributor Author

@animeshk923 animeshk923 Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do we mean and consider as a testing evidence here?

Copy link
Copy Markdown
Contributor Author

@animeshk923 animeshk923 Apr 20, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

resolved through 328d232

1. **Comments and JSDoc**: Write clear and consistent JSDoc comments for functions, including parameter types, return values, and error conditions, so others can easily understand and use the code.

1. **DRY Code**: Ensure the code follows the **Don't Repeat Yourself** principle. Look out for duplicate logic that can be reused.

1. **Test Coverage**: Ensure the new code is well-tested with meaningful test cases that pass consistently and cover all relevant edge cases.

1. **Commit History**: Contributors should avoid force-pushing as much as possible. It makes it harder to track incremental changes and review the latest updates.

1. **Reduce Scope When Needed**: If an issue or PR feels too large or complex, consider splitting it and creating follow-up issues. Smaller, focused PRs are easier to review and merge.

1. **Bot Comments:** As reviewers, check that contributors have appropriately addressed comments or suggestions made by automated bots. If there are bot comments the reviewer disagrees with, react to them or mark them as resolved, so the review history remains clear and accurate.
Loading