WalkthroughThe pull request involves updating documentation for self-hosted CodeRabbit installations across multiple platform-specific guides (Azure DevOps, Bitbucket, GitHub, and GitLab). The primary changes focus on modifying the.env file configuration, specifically theCODERABBIT_API_KEY entry. The updates remove square brackets around the API key placeholder, indicating a more explicit configuration requirement. In the GitHub documentation, an additional change includes adding "Actions: Read-only" to the GitHub App permissions. Changes| File | Change Summary |
|---|
docs/self-hosted/azure-devops.md | Removed brackets fromCODERABBIT_API_KEY configuration | docs/self-hosted/bitbucket.md | Removed brackets fromCODERABBIT_API_KEY
Added newCODERABBIT_LICENSE_KEY configuration | docs/self-hosted/github.md | Removed brackets fromCODERABBIT_API_KEY
Added "Actions: Read-only" to GitHub App permissions | docs/self-hosted/gitlab.md | Removed brackets fromCODERABBIT_API_KEY configuration |
Possibly related PRsSuggested reviewers- aravindputrevu
- alexcoderabbitai
- tyaga001
Poem🐰 Configs dancing, brackets flee,
API keys now set free!
No more square brackets to hide,
CodeRabbit's docs now clarified with pride.
Documentation's rabbit hop complete! 🔑
📜 Recent review detailsConfiguration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro 📥 CommitsReviewing files that changed from the base of the PR and between74aaf1e and1ee5861. 📒 Files selected for processing (4)docs/self-hosted/azure-devops.md (1 hunks)docs/self-hosted/bitbucket.md (1 hunks)docs/self-hosted/github.md (2 hunks)docs/self-hosted/gitlab.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)- GitHub Check: Cloudflare Pages
🔇 Additional comments (6)docs/self-hosted/github.md (2)25-25:LGTM! Actions permission addition is appropriate.
The addition of "Actions: Read-only" permission is well-placed and correctly specified with the minimum required access level.
104-104:LGTM! API key format update improves clarity.
The removal of square brackets from the API key placeholder correctly indicates that this is a required field. docs/self-hosted/gitlab.md (1)94-94:LGTM! API key format update is consistent.
The removal of square brackets from the API key placeholder aligns with the changes in other platform documentation. docs/self-hosted/azure-devops.md (2)89-89:LGTM! API key format update is consistent.
The removal of square brackets from the API key placeholder aligns with the changes in other platform documentation.
Line range hint1-150:Fix contradictory note about optional values. The note section contains the same issue as in the GitLab documentation regarding the meaning of bracketed values. docs/self-hosted/bitbucket.md (1)80-82:LGTM! Configuration updates are clear and consistent.
The changes appropriately: - Add the required license key configuration
- Update the API key format to match other platform documentation
🪧 TipsChatThere are 3 ways to chat withCodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@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 using 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 generate docstrings togenerate docstrings for this PR. (Beta)@coderabbitai resolve resolve all the CodeRabbit review comments.@coderabbitai configuration to show the current CodeRabbit configuration for the repository.@coderabbitai help to get help.
Other keywords and placeholders- Add
@coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summary to generate the high-level summary at a specific location in the PR description. - Add
@coderabbitai anywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)- You can programmatically configure CodeRabbit by adding a
.coderabbit.yaml file to the root of your repository. - Please see theconfiguration 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 ourDocumentation for detailed information on how to use CodeRabbit.
- Join ourDiscord Community to get help, request features, and share feedback.
- Follow us onX/Twitter for updates and announcements.
|
No description provided.