Add GHE integration#462
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Review limit reached
More reviews will be available in 55 minutes and 4 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR standardizes integration documentation heading capitalization across Draw.io, GitLab, Sentry, and Slack while significantly expanding and reorganizing the GitHub integration guide with detailed feature descriptions, step-by-step setup flows, and dedicated configuration sections for GitHub Cloud, Enterprise Cloud, and Enterprise Server environments. ChangesIntegration Documentation Capitalization Standardization
GitHub Integration Documentation Expansion
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/integrations/github.md (1)
179-180:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winRemove the dead in-page link.
/integrations/github#from-profile-settingshas no matching anchor in this file, so that link will not resolve.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/integrations/github.md` around lines 179 - 180, The in-page link "/integrations/github#from-profile-settings" in the paragraph starting "Only one Workspace Admin can connect their GitHub account via Workspace Settings..." is dead; either remove the fragment (use "/integrations/github") or replace it with a correct target that actually exists (or add the corresponding anchor "from-profile-settings" elsewhere in the document). Update the link text to point to the valid URL or remove the fragment so the link resolves.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/integrations/github.md`:
- Line 82: Update the image alt-text typos by changing "Connect GitHub Enerprise
Cloud" to "Connect GitHub Enterprise Cloud" for the markdown image occurrences
(the inline image tag shown in the diff and the duplicate at the other
occurrence mentioned); search for that exact alt string in
docs/integrations/github.md and correct both instances.
- Around line 77-80: The callout text is internally inconsistent about
availability and mixes GHE.com with Enterprise Server; update the [!CAUTION]
block to clearly state whether the integration is only available on Plane Cloud
or also on self-hosted instances, and correct the GitHub product reference: use
"GitHub Enterprise Cloud (GHE.com)" when referring to the cloud product and
"GitHub Enterprise Server" when referring to self-hosted instances; also make
the setup requirement explicit (e.g., "If you use GitHub Enterprise Server,
create a GitHub App in your Enterprise Server instance; Plane Cloud users must
follow the Cloud-specific setup") and adjust the linked setup guide wording to
point to the appropriate guide for each environment.
- Around line 12-19: Remove trailing whitespace from the listed bullets in the
GitHub integrations section (the lines starting with "**GitHub Cloud**
(github.com)", "**GitHub Enterprise Cloud** (ghe.com)", and "**GitHub Enterprise
Server** (self-hosted)") so the file passes formatting checks, then run the
formatter via "pnpm fix:format" to apply and verify the changes before merging.
- Line 8: The overview overstates sync behavior: update the GitHub integration
overview paragraph so it no longer claims that "comments" and "assignees" always
reflect changes from either system; instead state that comment synchronization
only round-trips when bidirectional sync is enabled and assignee synchronization
depends on configured user mapping. Locate the sentence mentioning "comments,
labels, and assignees reflect changes from either system" and replace it with
clarified wording that calls out the conditional nature of comment sync
(requires bidirectional sync) and assignee sync (requires user mapping), and
optionally link to the sections that explain bidirectional sync and user
mapping.
- Line 43: The docs use mixed casing for the sync labels (`plane`/`github` vs
`Plane`/`GitHub`); pick a single canonical form (prefer lowercase `plane` and
`github`) and update every occurrence so the initial sentence and all setup
steps consistently reference the same label casing—replace instances of `Plane`
and `GitHub` (and any other variants) with `plane` and `github` in the sections
that describe creating labels and triggering syncs.
---
Outside diff comments:
In `@docs/integrations/github.md`:
- Around line 179-180: The in-page link
"/integrations/github#from-profile-settings" in the paragraph starting "Only one
Workspace Admin can connect their GitHub account via Workspace Settings..." is
dead; either remove the fragment (use "/integrations/github") or replace it with
a correct target that actually exists (or add the corresponding anchor
"from-profile-settings" elsewhere in the document). Update the link text to
point to the valid URL or remove the fragment so the link resolves.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: da55a496-b888-414e-a14b-de84129c9a9f
📒 Files selected for processing (5)
docs/integrations/draw-io.mddocs/integrations/github.mddocs/integrations/gitlab.mddocs/integrations/sentry.mddocs/integrations/slack.md
| # GitHub integration <Badge type="info" text="Pro" /> | ||
|
|
||
| GitHub integration with Plane allows seamless synchronization between your GitHub repositories and Plane projects. By linking the two, your issues and pull requests stay updated across both platforms, enhancing collaboration and streamlining your workflow. Whether you're managing code, tasks, or both, this integration ensures your team stays in sync without the hassle of switching between platforms. | ||
| GitHub integration with Plane allows seamless synchronization between your GitHub repositories and Plane projects. By linking the two, your issues and pull requests stay updated across both platforms. Issues, comments, labels, and assignees reflect changes from either system. Pull request events automatically move work items through your Plane workflow. |
There was a problem hiding this comment.
Tighten the overview claim.
comments and assignees do not always “reflect changes from either system” here; comment sync only round-trips with bidirectional sync, and assignee sync depends on user mapping later in the doc.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/integrations/github.md` at line 8, The overview overstates sync
behavior: update the GitHub integration overview paragraph so it no longer
claims that "comments" and "assignees" always reflect changes from either
system; instead state that comment synchronization only round-trips when
bidirectional sync is enabled and assignee synchronization depends on configured
user mapping. Locate the sentence mentioning "comments, labels, and assignees
reflect changes from either system" and replace it with clarified wording that
calls out the conditional nature of comment sync (requires bidirectional sync)
and assignee sync (requires user mapping), and optionally link to the sections
that explain bidirectional sync and user mapping.
|
|
||
| - Your Plane account must have **Admin** or **Owner** role in the workspace. | ||
| - One GitHub organization can be connected to **one** Plane workspace. If an organization is already connected to another workspace anywhere in Plane, the connection attempt fails with an error. | ||
| - The `plane` label on a GitHub issue and the `github` label on a Plane work item are what trigger syncing. Create these labels on both platforms. |
There was a problem hiding this comment.
Use one canonical label casing throughout.
This section says plane/github, but the setup steps later use Plane/GitHub. That inconsistency makes the flow ambiguous and can lead users to create the wrong labels.
Also applies to: 238-239, 257-258
🧰 Tools
🪛 LanguageTool
[uncategorized] ~43-~43: The official name of this software platform is spelled with a capital “H”.
Context: ...plane label on a GitHub issue and the github label on a Plane work item are what tr...
(GITHUB)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/integrations/github.md` at line 43, The docs use mixed casing for the
sync labels (`plane`/`github` vs `Plane`/`GitHub`); pick a single canonical form
(prefer lowercase `plane` and `github`) and update every occurrence so the
initial sentence and all setup steps consistently reference the same label
casing—replace instances of `Plane` and `GitHub` (and any other variants) with
`plane` and `github` in the sections that describe creating labels and
triggering syncs.
| > | ||
| > Before you can integrate with GitHub Enterprise Cloud (GHE.com) , you must first create and configure a GitHub App in your GitHub Enterprise Server instance. This is required for both Plane Cloud and self-hosted users. Follow this [setup guide](https://developers.plane.so/self-hosting/govern/integrations/github?edition=github-enterprise-cloud#create-github-app) first before diving into the steps on this page. | ||
|
|
||
|  |
There was a problem hiding this comment.
Fix the image alt-text typos.
Enerprise is misspelled in both image captions.
Also applies to: 127-127
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/integrations/github.md` at line 82, Update the image alt-text typos by
changing "Connect GitHub Enerprise Cloud" to "Connect GitHub Enterprise Cloud"
for the markdown image occurrences (the inline image tag shown in the diff and
the duplicate at the other occurrence mentioned); search for that exact alt
string in docs/integrations/github.md and correct both instances.
1 participant
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit