Skip to content

📝 Document that we support GitLab 16+ #85

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
Aug 29, 2024

Conversation

NatoBoram
Copy link
Contributor

@NatoBoram NatoBoram commented Aug 29, 2024

Summary by CodeRabbit

  • Documentation
    • Updated integration documentation for CodeRabbit with GitLab to clarify compatibility requirements.
    • Added a note advising users to upgrade to GitLab version 16.x for optimal performance and to avoid issues with version 15.x.

@NatoBoram NatoBoram added the documentation Improvements or additions to documentation label Aug 29, 2024
@NatoBoram NatoBoram self-assigned this Aug 29, 2024
Copy link

cloudflare-workers-and-pages bot commented Aug 29, 2024

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: bc4583b
Status: ✅  Deploy successful!
Preview URL: https://adf4e061.coderabbit-docs.pages.dev
Branch Preview URL: https://feature-document-gl-version.coderabbit-docs.pages.dev

View logs

Copy link
Contributor

coderabbitaidev bot commented Aug 29, 2024

Walkthrough

The documentation for integrating CodeRabbit with GitLab has been updated to clarify compatibility requirements. It now specifies that CodeRabbit supports GitLab versions 16.x and above, while version 15.x may experience significant issues, including difficulties with posting review comments and the sign-up process. Users are encouraged to upgrade to version 16.x for optimal performance.

Changes

Files Change Summary
docs/platforms/self-hosted-gitlab.md Updated compatibility requirements for CodeRabbit with GitLab, specifying support for versions 16.x and above, and noting potential issues with version 15.x.

Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. 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 @coderabbitaidev in a new review comment at the desired location with your query. Examples:
    • @coderabbitaidev generate unit testing code for this file.
    • @coderabbitaidev modularize this function.
  • PR comments: Tag @coderabbitaidev 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:
    • @coderabbitaidev generate interesting stats about this repository and render them as a table.
    • @coderabbitaidev show all the console.log statements in this repository.
    • @coderabbitaidev read src/utils.ts and generate unit testing code.
    • @coderabbitaidev read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitaidev 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)

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

Other keywords and placeholders

  • Add @coderabbitaidev ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitaidev summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitaidev or @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
Contributor

@coderabbitaidev coderabbitaidev bot 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, codebase verification and nitpick comments (1)
docs/platforms/self-hosted-gitlab.md (1)

15-15: Correct the term "sign up" to "sign-up".

The term "sign up" should be hyphenated to "sign-up" for grammatical accuracy.

Apply this diff to correct the term:

-CodeRabbit supports GitLab `16.x` and above. Version `15.x` may experience unexpected issues such as review comments not being posted or the sign up process not working at all. While we won't block the integration, we recommend upgrading your GitLab instance to obtain the intended experience.
+CodeRabbit supports GitLab `16.x` and above. Version `15.x` may experience unexpected issues such as review comments not being posted or the sign-up process not working at all. While we won't block the integration, we recommend upgrading your GitLab instance to obtain the intended experience.
Tools
LanguageTool

[uncategorized] ~15-~15: The noun “sign-up” is spelled with a hyphen.
Context: ...review comments not being posted or the sign up process not working at all. While we wo...

(SIGN_UP_HYPHEN)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2fe74bc and bc4583b.

Files selected for processing (1)
  • docs/platforms/self-hosted-gitlab.md (1 hunks)
Additional context used
LanguageTool
docs/platforms/self-hosted-gitlab.md

[uncategorized] ~15-~15: The noun “sign-up” is spelled with a hyphen.
Context: ...review comments not being posted or the sign up process not working at all. While we wo...

(SIGN_UP_HYPHEN)

@NatoBoram NatoBoram merged commit 03e3abd into main Aug 29, 2024
1 check passed
@NatoBoram NatoBoram deleted the feature/document-gl-version-support branch August 29, 2024 19:17
@coderabbitaidev coderabbitaidev bot mentioned this pull request Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants