Skip to content

Add OBJECT_STORE_URI configuration to self-hosted integration docs #294

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

Merged
merged 1 commit into from
Apr 21, 2025

Conversation

hasit
Copy link
Contributor

@hasit hasit commented Apr 21, 2025

No description provided.

@hasit hasit self-assigned this Apr 21, 2025
Copy link
Contributor

coderabbitai bot commented Apr 21, 2025

Walkthrough

The documentation for self-hosted deployments across Azure DevOps, Bitbucket, GitHub, and GitLab was updated to adjust the ordering of the ENABLE_LEARNINGS environment variable, placing it after ENABLE_METRICS. Additionally, a new environment variable, OBJECT_STORE_URI, was introduced in each guide, along with explanatory comments and example values. This variable is now documented as required when using CodeRabbit's learnings feature, specifying the URI for object storage such as S3 or GCS. No changes were made to logic, configuration, or exported entities.

Changes

File(s) Change Summary
docs/self-hosted/azure-devops.md Reordered ENABLE_LEARNINGS after ENABLE_METRICS and added OBJECT_STORE_URI with explanatory comment.
docs/self-hosted/bitbucket.md Reordered ENABLE_LEARNINGS after ENABLE_METRICS; added OBJECT_STORE_URI and usage instructions.
docs/self-hosted/github.md Moved ENABLE_LEARNINGS below ENABLE_METRICS, enabled by default; added OBJECT_STORE_URI with comment.
docs/self-hosted/gitlab.md Reordered ENABLE_LEARNINGS after ENABLE_METRICS; added OBJECT_STORE_URI and explanatory comment.

Poem

In docs we hop and shuffle lines,
With buckets and URIs—oh what signs!
Learnings enabled, now clear to see,
Object stores await, as easy as can be.
🐇✨
A hop, a skip, our docs align,
For CodeRabbit’s features, simply divine!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d47a4b4 and 6b2073b.

📒 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 (1 hunks)
  • docs/self-hosted/gitlab.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (4)
docs/self-hosted/bitbucket.md (1)

110-114: Documentation: Added OBJECT_STORE_URI and reordered ENABLE_LEARNINGS.

The new ENABLE_LEARNINGS entry is correctly placed below ENABLE_METRICS, and the OBJECT_STORE_URI variable is introduced with clear placeholder syntax and example formats. This aligns with other self-hosted guides.

docs/self-hosted/gitlab.md (1)

120-123: Documentation: Add OBJECT_STORE_URI and reposition ENABLE_LEARNINGS.

ENABLE_LEARNINGS is properly moved under ENABLE_METRICS, and the OBJECT_STORE_URI variable is introduced with placeholder and example URI formats, matching the pattern of other self-hosted docs.

docs/self-hosted/azure-devops.md (1)

116-119: Documentation: Reordered ENABLE_LEARNINGS and inserted OBJECT_STORE_URI.

The ENABLE_LEARNINGS setting now appears below ENABLE_METRICS, and the OBJECT_STORE_URI environment variable is added with example S3/GCS URI formats, maintaining consistency across platform docs.

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

129-132: Documentation: Introduced OBJECT_STORE_URI and updated ordering of ENABLE_LEARNINGS.

The .env example correctly places ENABLE_LEARNINGS after ENABLE_METRICS and adds OBJECT_STORE_URI with a clear placeholder and examples, consistent with other self-hosted integration guides.


🪧 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>, 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 to generate docstrings for this 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 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

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6b2073b
Status: ✅  Deploy successful!
Preview URL: https://73d5ce86.coderabbit-docs.pages.dev
Branch Preview URL: https://hasit-obj-storage.coderabbit-docs.pages.dev

View logs

@hasit hasit enabled auto-merge (squash) April 21, 2025 23:34
@hasit hasit merged commit 84ad6b2 into main Apr 21, 2025
4 checks passed
@hasit hasit deleted the hasit/obj-storage branch April 21, 2025 23:34
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