Skip to content
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

chore: Forbid coderabbit on .md files #2134

Merged
merged 2 commits into from
Aug 13, 2024
Merged

Conversation

p-offtermatt
Copy link
Contributor

@p-offtermatt p-offtermatt commented Aug 8, 2024

Attempt #2.
#2099 just removed the path-specific instructions for coderabbit.
I hope this will work to stop it from touching .md files

It's hard to test locally, so unfortunately we have to iterate with PRs here

Summary by CodeRabbit

  • New Features

    • Introduced a path filter to streamline the review process by excluding Markdown files from reviews.
  • Bug Fixes

    • Removed the requirement for reviews on the changelog content.
  • Refactor

    • Clarified review instructions for Golang code and unit tests, ensuring adherence to coding standards.

@p-offtermatt p-offtermatt requested a review from a team as a code owner August 8, 2024 12:10
Copy link
Contributor

coderabbitai bot commented Aug 8, 2024

Walkthrough

Walkthrough

The recent changes to the .coderabbit.yml configuration streamline the review process by introducing a path filter that excludes Markdown files from assessments and removing the requirement for reviews related to changelog content. This refined focus allows for more targeted evaluations of Golang code and unit tests while maintaining adherence to style guides and coverage standards.

Changes

File Change Summary
.coderabbit.yml Added filter to exclude !*.md and removed ".changelog/*" from reviews

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7b481bd and cb3fd6d.

Files selected for processing (1)
  • .coderabbit.yml (2 hunks)
Files skipped from review due to trivial changes (1)
  • .coderabbit.yml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@p-offtermatt p-offtermatt enabled auto-merge August 13, 2024 08:17
@p-offtermatt p-offtermatt added this pull request to the merge queue Aug 13, 2024
Merged via the queue into main with commit 9a303a0 Aug 13, 2024
11 checks passed
@p-offtermatt p-offtermatt deleted the ph/coderabbit-markdown-no branch August 13, 2024 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants