Skip to content

Conversation

@danciaclara
Copy link
Collaborator

@danciaclara danciaclara commented Oct 6, 2025

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • GitHub integration: minor formatting tweaks to labels and image spacing in setup steps.
    • GitLab integration: major rewrite introducing GitLab.com and Self‑managed editions with tabbed flows, edition‑specific onboarding and imagery, self‑hosted guidance, revised connection/setup steps, replaced "Sync pull requests" with "Configure PR state automation" (including reference formats and examples), expanded PR lifecycle mappings and added edition cautions.

@vercel
Copy link

vercel bot commented Oct 6, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Oct 13, 2025 11:56am

@coderabbitai
Copy link

coderabbitai bot commented Oct 6, 2025

Walkthrough

Docs updated: minor formatting and layout tweaks in the GitHub integration doc; substantial rework of the GitLab integration doc adding GitLab.com vs GitLab Self‑managed tabs, explicit self‑hosted setup flows, revised PR automation guidance, reference format examples, and expanded PR lifecycle mappings.

Changes

Cohort / File(s) Summary
GitHub doc adjustments
docs/integrations/github.mdx
Minor formatting: removed trailing periods after bold labels, adjusted blank lines around images, and small wording/anchor tweaks related to PR lifecycle/automation.
GitLab multi‑edition rewrite & PR automation
docs/integrations/gitlab.mdx
Introduced Tabs/TabItem UI for GitLab.com vs GitLab Self‑managed; added self‑hosted connection/setup steps and cautions; replaced “Sync pull requests” with “Configure PR state automation”; added reference format examples (bracketed/non‑bracketed), expanded PR lifecycle mapping, updated images and onboarding flows.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant Docs as "Plane Docs"
  participant UI as "Plane UI"
  participant GLdotcom as "GitLab.com"
  participant GLSelf as "GitLab Self‑managed"

  Note over Docs: GitLab integration guide presents edition Tabs (.com / Self‑managed)

  User->>UI: Open Integrations → Connect GitLab
  alt GitLab.com flow
    UI->>GLdotcom: OAuth authorize
    GLdotcom-->>UI: Tokens issued
    UI-->>User: Connected (cloud)
    User->>UI: Map projects & Configure PR state automation
    UI-->>User: Set reference format & lifecycle mapping
  else Self‑managed flow
    User->>UI: Enter instance URL + app creds
    UI->>GLSelf: Validate instance & app
    GLSelf-->>UI: Validation OK
    UI-->>User: Connected (self‑managed)
    User->>UI: Map projects & Configure PR state automation
    UI-->>User: Set reference format & lifecycle mapping (self‑hosted notes)
  end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

I nibble docs by moonlit screens,
Tabs divide the cloud and dens,
Self‑hosted burrows, OAuth beams,
PR states hop through mapped routines,
Carrots, anchors, bright new greens 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title “GitLab self-managed configuration” accurately highlights the primary change in the pull request, which is the addition of self-managed GitLab support and configuration guidance in the documentation. It is concise, specific, and directly related to the main modifications made. This phrasing clearly communicates the core update without extraneous detail.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch gitlab-enterprise

📜 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 2ca8c31 and c7ad9a5.

📒 Files selected for processing (2)
  • docs/integrations/github.mdx (2 hunks)
  • docs/integrations/gitlab.mdx (4 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai 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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a6f1fd and 97b5dd1.

📒 Files selected for processing (2)
  • docs/integrations/github.mdx (3 hunks)
  • docs/integrations/gitlab.mdx (4 hunks)

Co-authored-by: Saurabh Kumar <70131915+Saurabhkmr98@users.noreply.github.com>
Copy link

@coderabbitai coderabbitai 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: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 97b5dd1 and 0c105e6.

📒 Files selected for processing (1)
  • docs/integrations/gitlab.mdx (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Cursor Bugbot

Copy link

@coderabbitai coderabbitai 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

🧹 Nitpick comments (2)
docs/integrations/github.mdx (2)

20-24: Normalize trailing spaces for line breaks in bullets

Line 23 has three trailing spaces after “GitHub Enterprise Server” vs two on line 20. Use a consistent two-space break for both.


32-32: Use in-page hash anchor for same-page navigation

Prefer a hash-only link for the same page to avoid hardcoding the route and to keep SPA navigation smooth.

-3. [Add repository mappings](/integrations/github#configure-pr-state-automation)
+3. [Add repository mappings](#configure-pr-state-automation)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c105e6 and 52fb702.

📒 Files selected for processing (1)
  • docs/integrations/github.mdx (3 hunks)
🔇 Additional comments (1)
docs/integrations/github.mdx (1)

260-260: No lingering pluralized anchors found Verified across all .md and .mdx files—no instances of configure-pr-state-automations.

@danciaclara danciaclara merged commit 91813ec into master Oct 13, 2025
3 checks passed
@danciaclara danciaclara deleted the gitlab-enterprise branch October 13, 2025 13:22
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.

4 participants