GitLab self-managed configuration #153
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughGitHub doc: indentation-only formatting fixes. GitLab doc: restructured from a single linear guide into tabbed GitLab Cloud vs GitLab Self‑managed flows with per-path redirect URIs, scopes, images, per-tab configuration steps, and edition-aware activation links. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsUI as "Docs (Tabbed UI)"
participant GitProvider as "GitLab Provider"
participant Plane as "Plane Instance / Admin"
User->>DocsUI: Open GitLab integration page
DocsUI-->>User: Render tabs (GitLab Cloud / GitLab Self‑managed)
alt Select Cloud
User->>DocsUI: Choose "GitLab Cloud" tab
DocsUI-->>User: Show Cloud-specific redirect URI, scopes, images
else Select Self‑managed
User->>DocsUI: Choose "GitLab Self‑managed" tab
DocsUI-->>User: Show self‑managed redirect URI, scopes, images
end
User->>GitProvider: Create App with shown redirect URI & scopes
GitProvider-->>User: Return Client ID / Client Secret
User->>Plane: Provide credentials to Plane (per-tab env/UI steps)
Plane-->>User: Display edition-aware activation link / next steps
Note over DocsUI,Plane: Flow differs only by selected tab (Cloud vs Self‑managed)
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
self-hosting/govern/integrations/github.mdx (1)
75-134: Restore ordered-list indentation inside the GitHub Enterprise tab.Dropping the two leading spaces before list items 2‑7 breaks the numbered list inside the tab—MDX treats them as separate paragraphs, so the order resets in the rendered docs. Please re-indent those items (match the Cloud tab) to preserve the sequence.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
self-hosting/govern/integrations/github.mdx(3 hunks)self-hosting/govern/integrations/gitlab.mdx(2 hunks)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
self-hosting/govern/integrations/gitlab.mdx (1)
132-139: Add self‑managed instance configuration/env vars (currently missing).Users copy credentials but aren’t told where to put them; the setup is incomplete without instance configuration.
Proposed patch (adjust env var names to match Plane’s actual config if different):
<Tab title="GitLab Self-managed"> 1. Copy the **Application ID** and **Secret** from the newly created application.  -2. Once you've created the application, [activate the GitLab Self-managed integration in Plane](https://docs.plane.so/integrations/gitlab?edition=gitlab-self-managed). +2. Add these environment variables to your Plane instance's `.env` file: + + ```bash + GITLAB_ENTERPRISE_CLIENT_ID=<application_id> + GITLAB_ENTERPRISE_CLIENT_SECRET=<secret> + GITLAB_ENTERPRISE_BASE_URL=<https://your-gitlab-instance> + ``` + +3. Save the file and restart the instance. + +4. Once you've completed the instance configuration, [activate the GitLab Self-managed integration in Plane](https://docs.plane.so/integrations/gitlab?edition=gitlab-self-managed). </Tab>Please confirm the exact env var keys Plane expects for self‑managed (enterprise) GitLab.
🧹 Nitpick comments (3)
self-hosting/govern/integrations/gitlab.mdx (3)
50-61: Reassess scopes: avoid redundant/over-broad permissions.If
apiis required,read_apiis redundant; if only read is needed, preferread_apiwithoutapi. Confirm the minimal scopes Plane actually uses.
82-96: Verify self‑managed redirect URIs and add language hint.Confirm both callbacks, especially the “gitlab-enterprise” paths, are correct for Plane Cloud vs Self-hosted. Consider adding a language hint to the code fences (bash) for consistency.
31-37: Unify UI navigation wording for consistency.Cloud uses “Preferences” while Self‑managed uses “Edit profile.” If both are valid (version-dependent), consider noting both to reduce confusion.
Also applies to: 65-69
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
self-hosting/govern/integrations/gitlab.mdx(4 hunks)
🔇 Additional comments (2)
self-hosting/govern/integrations/gitlab.mdx (2)
29-63: Cloud tab rendering and confidentiality fix look good.Tabs, lists, and code fences render correctly; “Confidential” is required—good catch.
114-131: Cloud instance configuration steps are complete.Env vars and restart instructions are clear; activation link is edition‑specific.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit