Add step to install GitHub App for Self-Hosted #70
Conversation
Deploying coderabbit-docs with
|
| Latest commit: |
0a45ecc
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f42c32c0.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://gh-selfhosted-tweaks.coderabbit-docs.pages.dev |
|
Caution Review failedThe pull request is closed. WalkthroughThe document updates improve clarity and the logical flow of instructions for integrating the GitHub App with CodeRabbit. Key changes include simplifying the app name, renaming the installation step for better clarity, and adding a warning regarding the re-sending of installation events if the app was installed prematurely. These revisions enhance user guidance and facilitate a smoother setup process. Changes
TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitaidev[bot]](https://avatars.githubusercontent.com/in/375467?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/integrations/self-hosted-github.md (3 hunks)
Additional context used
LanguageTool
docs/integrations/self-hosted-github.md
[grammar] ~133-~133: The word ‘install’ is not a noun.
Context: ... performed this step before Step 4, the install event likely will have failed and you w...(A_INSTALL)
[uncategorized] ~133-~133: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he install event likely will have failed and you will need to re-send the installati...(COMMA_COMPOUND_SENTENCE)
Additional comments not posted (4)
docs/integrations/self-hosted-github.md (4)
64-64: LGTM!The changes to the GitHub App creation instructions improve clarity and conciseness.
123-123: LGTM!The changes improve the logical flow of the instructions.
126-130: LGTM!Renaming the step and adding new instructions for installing the GitHub App reflects a more logical progression in the setup process.
138-138: LGTM!Renaming the step and providing instructions for IP whitelisting improves the logical structure of the document.
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/integrations/self-hosted-github.md (4 hunks)
Additional context used
LanguageTool
docs/integrations/self-hosted-github.md
[grammar] ~140-~140: The word ‘install’ is not a noun.
Context: ... performed this step before Step 4, the install event likely will have failed and you w...(A_INSTALL)
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he install event likely will have failed and you will need to re-send the installati...(COMMA_COMPOUND_SENTENCE)
Additional comments not posted (3)
docs/integrations/self-hosted-github.md (3)
8-13: LGTM!The info block provides essential context for GitHub Enterprise Self-Hosted users.
Line range hint
71-129:
LGTM!The instructions for creating a GitHub App are clear and detailed.
Tools
LanguageTool
[grammar] ~109-~109: This phrase is duplicated. You should probably use “ID Client” only once.
Context: ...eep the following details handy: - App ID - Client ID - Client secret - Webhook secret - Private key ...(PHRASE_REPETITION)
130-132: LGTM!The instructions for submitting details accumulated in previous steps are clear and detailed.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
docs/integrations/self-hosted-github.md (2)
8-13: Improve readability of the info block.The info block is clear but can be slightly improved for readability.
- This page is for GitHub Enterprise Self-Hosted users only. - If you're using github.com, [login to CodeRabbit](https://app.coderabbit.ai) and add your repositories from there + This page is for GitHub Enterprise Self-Hosted users only. + If you're using github.com, [log in to CodeRabbit](https://app.coderabbit.ai) and add your repositories from there.
138-143: Fix grammatical issues in the warning note.The warning note provides critical troubleshooting information, but there are minor grammatical issues.
- If you performed this step before Step 4, the installation event likely will have failed and you will need to re-send the installation event. + If you performed this step before Step 4, the installation event likely will have failed, and you will need to re-send the installation event.Tools
LanguageTool
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...stallation event likely will have failed and you will need to re-send the installati...(COMMA_COMPOUND_SENTENCE)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/integrations/self-hosted-github.md (4 hunks)
Additional context used
LanguageTool
docs/integrations/self-hosted-github.md
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...stallation event likely will have failed and you will need to re-send the installati...(COMMA_COMPOUND_SENTENCE)
Additional comments not posted (3)
docs/integrations/self-hosted-github.md (3)
71-71: LGTM!The instructions for creating a GitHub App are clear and comprehensive.
133-137: LGTM!The instructions for installing the GitHub App are clear and provide necessary guidance for users.
Line range hint
145-153:
LGTM!The instructions for whitelisting the CodeRabbit IP address are clear and provide necessary guidance for users.
Tools
LanguageTool
[uncategorized] ~140-~140: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...stallation event likely will have failed and you will need to re-send the installati...(COMMA_COMPOUND_SENTENCE)
* Add step to install GitHub App * Disclaimer * Coderabbit suggestion: install -> installation * Coderabbit suggestions
* Coderabbit Docs Rework (wip) * WIP blog page * Fixed images * Wip added all blogs and docs * ✏️ Remove asterisk from CodeRabbit heading * Add Tailwind CSS configuration and update page title * Update logo href and navbar styling * Update Docusaurus configuration and custom CSS * Update routing and styling * Add sitemap configuration and update redirect paths * blog: cost effective generative ai app * fix: numbering * Update CodeRabbit links in documentation * Update CodeRabbit documentation * Update base URL and redirect to external documentation * Update links to Get Started page * Add new images and update links in docusaurus.config.ts and sidebars.ts * Add redirect to documentation page * Update slug in introduction.md * Update introduction.md and docusaurus.config.ts, delete index.tsx * Add code to change the docs link on the navbar * Remove unnecessary code and add redirect for docs * Update docs link and hide SVG icon * Adjustments for mobile view in custom.css * Update logo size and padding for smaller screens, center Discord link, and hide certain navbar links on mobile * Update image paths in CodeRabbit deep dive blog post * Update image in introduction.md * Update image URL in blog post * Update favicon links in blog post * Update og:image URL in blog post * Update blog post image URLs * Update image URLs in blog posts * feat: added document under integration on integration with self hosted gitlab * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <ksingh209@gmail.com> * Update self-hosted-gitlab.md * blog: modern ai stack for devs * citation: codex model use in gh copilot * fix: gh citation link * fix: typo * fix: typo * Update index.md * founderblogmissing * Remove markdown file * Update CodeRabbit description and add privacy and security information * Update link in introduction.md * nit * Add new images and delete old image files * Update self-hosted-gitlab.md * Update customize-coderabbit.md * Update self-hosted-gitlab.md * Update customize-coderabbit.md * format blog file * format all blog files * hide version 1 schema * Update faq.md * Fix images for light and dark mode. Made improvements to docs (#22) * Add ast-grep documentation page * Update the ast-grep documentation to include the coderabbit config file changes * Fix language review * Update coderabbit.yaml schema for ast-grep tool naming * Update coderabbig guide page with new coderabbit.yaml changes * Update 2023-11-13-boosting-engineering-efficiency.md * Move ast-grep documentation under the prompt-customization page * Change ast-grep naming * Correct grammar for ast-grep documentation * update faqs * restructure existing blog posts * Add ast-grep documentation page * Update the ast-grep documentation to include the coderabbit config file changes * Fix language review * Update coderabbit.yaml schema for ast-grep tool naming * Move ast-grep documentation under the prompt-customization page * restructure existing docs * review feedback * add preview image * use directory instead of folder terminology * nit * add disqus comments * fix admonitions * add fn acquisition blog (#27) * add fn acquisition blog * add links * small fix * update blog post * update blog post * update preview image * update preview image * minor update to the FAQ * Daily Standup Reporting Docs (#28) * Add daily standup reporting docs and images * Coderabbit suggestions * Add packages section and update existing docs for ast-grep (#29) * updateschemaexample (#31) * updateschemaexample * Update customize-coderabbit.md * minorchanges (#32) * updatefaq * FAQs * doc fixes (#33) Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: Gur singh <11731008+guritfaq@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * fix path instructions example * change the default example for coderabbit yaml * Blog - AI Code Reviews (#36) * newblog * RenameFolder * updatedesc * update example * blog home page * blog featured posts * AdminAccessToken * FixCasing * updatecasing * update docs * update schema * remove daily standup guide * Update YAML settings in configure-coderabbit.md (#40) * Update YAML settings in configure-coderabbit.md * Add configuration for `languagetool` integration in configure-coderabbit.md * update pricing * remove pnpm * ast-grep update * update knowledge_base settings * mention ast-grep-essentials * add review.profile to docs * update review status * revert review status change * add quotes * minor * improve config docs * add playground link * placeholder for high-level summary * remove v1 config documentation * remove ignore title example * remove ignore title example * UpatePauseCommandMessage * update docs * Update introduction.md * Add config for biome and hadolint (#43) * update auto_incremental_review * improve config docs * chore: Update CodeRabbit configuration settings (#44) * chore: Add config for new tools (#45) * UpdateDataPrivacy * chore: Update SwiftLint configuration file path (#47) * Update self hosted onboarding guide * update auto title * update phpstan instructions * Update npm dependencies and add docusaurus-json-schema-plugin (#49) * Update npm dependencies and add docusaurus-json-schema-plugin * Show CodeRabbit config schema from a file * Update faqs typos (#51) * ♻️ Clean faq typos * 💄 Update .png for support help dark and light mode * ♻️ Misc fixes and improvements * update docs * Create initial Gitlab Saas integration page * Update GitLab page content on the how to section with a note * add tip * update limits * 📝 Add Documentation for Deleting Account (#55) * On-demand report generation docs (#56) * Ondemand report input schema format * On-demand reporting docs * CodeRabbit suggestions * Typo * Add linter documentation (#59) * Add linter documentation - Update sidebar positions in documentation guides * docs: Move linter documentation to tools folder * Add more tools * Add LanguageTool documentation and configuration * Update Biome documentation and configuration * docs: Update linter documentation and configuration * chore: Update tools category label in _category_.yml * chore: Update tools category label and add new tools * docs: Fix typo in Biome linter documentation * chore: Add SwiftLint documentation and configuration * Add golangci-lint, PHPStan, and SwiftLint documentation and configuration * Add Yamllint documentation and configuration * Add Checkov and Gitleaks documentation and configuration * Update tool configuration documentation (#60) * chore: Update tool configuration documentation * Update tool configuration documentation * Update Gitleaks documentation (#61) * Update introduction.md and add video (#62) * Add table for Supported Tools by languages (#63) * Add table for Supported Tools by languages * Update supported tools table and documentation * Update tool configuration documentation * Update introduction and CodeRabbit documentation (#64) * Update introduction and CodeRabbit documentation * Update FAQ documentation * Update CodeRabbit documentation and remove reference to GitHub Copilot * Update CodeRabbit documentation and remove reference to GitHub Copilot * Update default settings for CodeRabbit tools (#65) * feat: added docs for detekt and eslint (#67) * feat: added docs for detekt and eslint * fix: lint * Add segment script and update iframe attributes for YouTube video player (#68) * Improve Documentation Structure and Accessibility in Markdown Files (#69) * Major refactor - Move configure and tools to top level - Update category positions - Move images to static dir - Update links * Update image file name in introduction.md * Update sidebar positions for integrations documentation * Update category positions for documentation * Update knowledge base integration description * Update FAQ with CodeRabbit comparison and CodeRabbit's uniqueness * Update redirects in docusaurus.config.ts * Update Jira and Linear integration configuration in knowledge base * Update GitLab integration documentation * Self-Hosted GitHub onboarding docs (#66) * Initial draft of Self-Hosted GitHub onboarding * Fix issues and reorg steps * Rebase & fix conflicts * sidebar_position * Add step to install GitHub App for Self-Hosted (#70) * Add step to install GitHub App * Disclaimer * Coderabbit suggestion: install -> installation * Coderabbit suggestions * Remove ESLint from JavaScript tools documentation (#71) * Add supported git platforms page in documentation (#72) * Add supported git platforms page in documentation * Fix typo in platforms.md * chore: Update redirect paths in docusaurus.config.ts * added yaml editor (#74) * added yaml editor * name fix * moved component to one code block * removed logs * Feature yaml editor (#76) * added yaml editor * name fix * moved component to one code block * removed logs * fix: yaml editor * fix: reviews * new line * fix: merge fix * Update schema.v2.json * 🎨 Run Markdownlint and Prettier (#84) * added correct scopes (#88) Co-authored-by: dikshant <raidikshant2@gmail.com> * Add Azure DevOps initial docs page * Update Azure DevOps * add redirect * rename AzureDevOps page * SaaS GitLab change to Gitlab.com and added relevant redirect Update GitLab sidebar label and link references in documentation (#93) * SaaS GitLab change to Gitlab.com and added relevant redirect * changes for the self-hosted-github to Github Enterprise Server * Azure DevOps Server Support * Update platforms.md * Remove segment (#104) * update: introduction and added a CTA minor change to recreate the PR --------- Co-authored-by: Karan Singh <ksingh209@gmail.com> Co-authored-by: gitcommitshow <pradeep@gitcommit.show> Co-authored-by: coderabbit-amank <aman@coderabbit.ai> Co-authored-by: Gur singh <11731008+guritfaq@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Gur <guritfaq@gmail.com> Co-authored-by: Harjot Gill <harjot.gill@fluxninja.com> Co-authored-by: Karan Singh <karan@coderabbit.ai> Co-authored-by: petrisorcoderabbit <petrisor@coderabbit.ai> Co-authored-by: Jaseel <12792882+Spikatrix@users.noreply.github.com> Co-authored-by: petrisorcoderabbit <155847819+petrisorcoderabbit@users.noreply.github.com> Co-authored-by: Hasit Mistry <hasitnm@gmail.com> Co-authored-by: Hasit Mistry <hasit@coderabbit.ai> Co-authored-by: Ruhan Muzaffar <ruhan@coderabbit.ai> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Nato Boram <NatoBoram@users.noreply.github.com> Co-authored-by: dikshant-infracloud <160205839+dikshant-infracloud@users.noreply.github.com> Co-authored-by: dikshant <raidikshant2@gmail.com> Co-authored-by: Aravind Putrevu <aravind.putrevu@gmail.com> Co-authored-by: Nick Busey <NickBusey@users.noreply.github.com>
Summary by CodeRabbit