Skip to content

Add documentation for integrating CodeRabbit with self-hosted GitHub #41

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

Closed
wants to merge 5 commits into from

Conversation

hasit
Copy link
Contributor

@hasit hasit commented May 9, 2024

No description provided.

@hasit hasit self-assigned this May 9, 2024
Copy link

netlify bot commented May 9, 2024

Deploy Preview for reliable-buttercream-0e11cf failed.

⚠️ Continuous deployment needs attention — organization-owned private repository detected.
Upgrade to Pro or change repository settings in order to continue deploying from this repository.
For more information, visit the deploy log and FAQ page.

Name Link
🔨 Latest commit c6dd4a2
🔍 Latest deploy log https://app.netlify.com/sites/reliable-buttercream-0e11cf/deploys/663d0f2565f2fb0008a288f8

Copy link
Contributor

coderabbitaidev bot commented May 9, 2024

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (2)
  • docs/integrations/self-hosted-github.md is excluded by none and included by none
  • package.json is excluded by !**/*.json and included by none

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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.

Copy link

cloudflare-workers-and-pages bot commented May 9, 2024

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: c6dd4a2
Status: ✅  Deploy successful!
Preview URL: https://708c7e7e.coderabbit-docs.pages.dev
Branch Preview URL: https://hasit-self-hosted.coderabbit-docs.pages.dev

View logs

@hasit hasit closed this May 9, 2024
@hasit hasit deleted the hasit/self-hosted branch May 9, 2024 18:25
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.

1 participant