This repository was archived by the owner on Aug 16, 2025. It is now read-only.

coderabbitai/coderabbit-docsPublic archive

NotificationsYou must be signed in to change notification settings
Fork69
Star116

Update github env var examples#157

Merged

NickBusey merged 2 commits intomainfromnick/env-var-details

Nov 27, 2024

Merged

Update github env var examples#157

NickBusey merged 2 commits intomainfromnick/env-var-details

Nov 27, 2024

Conversation

Copy link

Contributor

NickBusey commentedNov 27, 2024

No description provided.

Update github env var examples

348244e

Copy link

Contributor

coderabbitaibot commentedNov 27, 2024•
edited
Loading

Walkthrough

The changes in this pull request involve updates to thedocs/self-hosted/github.md anddocs/integrations/knowledge-base.md files, specifically enhancing the instructions for self-hosting CodeRabbit with GitHub and clarifying integration setups. Key modifications include the renaming of environment variables related to knowledge base configuration and the addition of notes clarifying the purpose of the new flags. The overall structure and flow of both documents remain unchanged, ensuring users receive clear guidance on setting up the necessary configurations.

Changes

File	Change Summary
docs/self-hosted/github.md	Updated environment variables:`ON_PREM_KNOWLEDGE_BASE` to`SELF_HOSTED_KNOWLEDGE_BASE` and`ON_PREM_KNOWLEDGE_BASE_BRANCH` to`SELF_HOSTED_KNOWLEDGE_BASE_BRANCH`. Added clarification note regarding the new variable's purpose. Instructions for GitHub App setup remain unchanged.
docs/integrations/knowledge-base.md	Renamed`ON_PREM_KNOWLEDGE_BASE` to`SELF_HOSTED_KNOWLEDGE_BASE` in two instances. Clarified integration steps for Jira and Linear while preserving existing functionality.

Possibly related PRs

Add onprem learning config #148: The changes in this PR involve adding new environment variables related to self-hosting, specificallyON_PREM_KNOWLEDGE_BASE andON_PREM_KNOWLEDGE_BASE_BRANCH, which are directly related to the updates made in the main PR regarding the renaming of these variables toSELF_HOSTED_KNOWLEDGE_BASE andSELF_HOSTED_KNOWLEDGE_BASE_BRANCH.
Add more details on how to use on-prem knowledge base #154: This PR discusses theON_PREM_KNOWLEDGE_BASE configuration option and adds a reference to the "Self-hosted knowledge base" section, which aligns with the main PR's updates on the same topic.
Add chroma db docs #153: This PR includes updates to thedocs/self-hosted/github.md file, adding theCHROMADB_URL environment variable, which complements the changes made in the main PR regarding environment variable configurations for self-hosting.
Flesh out knowledgebase docs a bit #150: This PR enhances the knowledge base documentation, which is relevant as it discusses the internal knowledge base features that are tied to the changes in the main PR regarding self-hosting configurations.

Suggested reviewers

MonRay2024
aravindputrevu

🐰 In the garden where knowledge grows,
New variables sprout, as everyone knows.
With GitHub's help, we self-host with cheer,
A brighter path for all to steer!
Let's hop along, the future's so bright,
With every change, we take flight! 🌟

🪧 Tips

Chat

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

NickBuseyenabled auto-merge (squash)

November 27, 2024 22:33

Copy link

cloudflare-workers-and-pagesbot commentedNov 27, 2024•
edited
Loading

Deploying coderabbit-docs with Cloudflare Pages

Latest commit:	`2aab642`
Status:	✅ Deploy successful!
Preview URL:	https://be34ae07.coderabbit-docs.pages.dev
Branch Preview URL:	https://nick-env-var-details.coderabbit-docs.pages.dev

View logs

coderabbitaibot suggested changes

Nov 27, 2024

View reviewed changes

Copy link

Contributor

coderabbitaibot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between61fdd10 and348244e.

📒 Files selected for processing (1)

docs/self-hosted/github.md (2 hunks)

🔇 Additional comments (2)

docs/self-hosted/github.md (2)

99-99:LGTM! Clear documentation about data storage.

The comment effectively explains that enabling this flag will store learnings on CodeRabbit servers using the API key.

Line range hint1-1:Verify the knowledge base documentation link.

Please ensure that the link to/integrations/knowledge-base#self-hosted in the note section is still valid and points to the correct documentation.

✅ Verification successful

Link to knowledge base documentation is valid and correctly anchored

The verification confirms that:

The filedocs/integrations/knowledge-base.md exists in the expected location
It contains the correct section header with the matching anchor{#self-hosted}

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash# Check if the knowledge base documentation file existsfd -t f"knowledge-base.md" docs/integrations/# If it exists, verify the self-hosted section headerif fd -t f"knowledge-base.md" docs/integrations/>/dev/null;then  rg"^#+.*self.hosted" -i docs/integrations/knowledge-base.mdfi

Length of output: 237

docs/self-hosted/github.mdShow resolvedHide resolved

Update github env var examples

2aab642

coderabbitaibot reviewed

Nov 27, 2024

View reviewed changes

Copy link

Contributor

coderabbitaibot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

docs/integrations/knowledge-base.md (1)
69-69:Add a comma for better readability.
The sentence would be clearer with a comma after "learnings.json".
-should contain a file called learnings.json with an entry containing what you told+should contain a file called learnings.json, with an entry containing what you told
🧰 Tools
🪛 LanguageTool
[uncategorized] ~69-~69: Possible missing comma found.
Context: ... should contain a file called learnings.json with an entry containing what you told ...
(AI_HYDRA_LEO_MISSING_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between348244e and2aab642.

📒 Files selected for processing (1)

docs/integrations/knowledge-base.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/integrations/knowledge-base.md

[uncategorized] ~69-~69: Possible missing comma found.
Context: ... should contain a file called learnings.json with an entry containing what you told ...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (1)

docs/integrations/knowledge-base.md (1)

52-52:LGTM! Environment variable renaming is consistent.

The renaming fromON_PREM_* toSELF_HOSTED_* is more accurate and aligns well with the documentation's intent.

Also applies to: 56-56