Plan

Observations

The GitHub issue requests adding documentation for Gitea/Forgejo PR support to CodeRabbit. Currently, CodeRabbit supports 6 Git platforms including self-hosted GitLab, but not Gitea/Forgejo. These are self-hosted Git platforms that are API-compatible with each other (Forgejo is a fork of Gitea) and support OAuth2/webhooks similar to GitLab. The documentation follows a clear pattern with platform-specific guides under docs/platforms/ and self-hosted variants under docs/self-hosted/. The self-hosted GitLab documentation provides an excellent template for the integration workflow.

Approach

I'll create comprehensive documentation for Gitea/Forgejo support by following the established patterns in the codebase. Since Gitea and Forgejo are API-compatible and both are self-hosted platforms, I'll create a combined documentation approach that covers both platforms in a single guide, similar to how self-hosted GitLab is handled. This will include updating the platform overview pages, adding the new platform documentation, updating navigation, and ensuring consistency across all references to supported platforms.

Reasoning

I explored the repository structure and found it's a Docusaurus documentation site for CodeRabbit. I examined the current platform support documentation, particularly the self-hosted GitLab integration guide which serves as the best template. I checked the sidebar configuration to understand navigation structure, searched for any existing Gitea/Forgejo references (found none), and researched the technical compatibility between Gitea/Forgejo and existing Git platforms to understand integration requirements.

Proposed File Changes

📄 docs/platforms/gitea-forgejo.md ^(NEW) 🔗

References

📄 docs/platforms/self-hosted-gitlab.md

Create a comprehensive integration guide for Gitea and Forgejo platforms, using docs/platforms/self-hosted-gitlab.md as the template. The guide should cover both platforms in a single document since they are API-compatible. Include sections for:

Introduction explaining Gitea/Forgejo and their relationship

Version compatibility requirements (Gitea ≥1.22, Forgejo ≤7.0 for API compatibility)

Step-by-step integration process including:

Visiting CodeRabbit login page and selecting Gitea/Forgejo option

Entering the self-hosted instance URL

Automated vs manual onboarding options

Creating dedicated CodeRabbit user account

Setting up OAuth2 application with required scopes (api read_user email openid)

Generating personal access tokens

IP whitelisting requirements

Screenshots and visual guides (placeholder references for now)

Troubleshooting section

Links to official Gitea/Forgejo documentation

Use the same structure and tone as the GitLab guide but adapt the content for Gitea/Forgejo specifics. Include notes about API compatibility between the two platforms.

📄 docs/platforms/platforms.md ^(MODIFY) 🔗

References

📄 docs/platforms/gitea-forgejo.md ^(NEW)

Update the platform overview page to include Gitea/Forgejo in the list of supported Git platforms. Add the new platform to:

The bulleted list in the "Use CodeRabbit with Git platforms" section (after BitBucket Cloud)

The "What's next" section with a link to the new integration guide

Ensure the new platform follows the same formatting and presentation style as existing platforms. Update the introductory text if needed to reflect the expanded platform support.

📄 sidebars.ts ^(MODIFY) 🔗

References

📄 docs/platforms/gitea-forgejo.md ^(NEW)

📄 docs/self-hosted/gitea-forgejo.md ^(NEW)

Add the new Gitea/Forgejo platform documentation to the sidebar navigation. In the "Supported Git platforms" category (around line 47-54), add "platforms/gitea-forgejo" after "platforms/bitbucket-cloud" to maintain alphabetical ordering. This will make the new documentation accessible through the main navigation menu.
Add the self-hosted Gitea/Forgejo documentation to the "Self-host CodeRabbit" category in the sidebar. In the items array around line 62-67, add "self-hosted/gitea-forgejo" after "self-hosted/bitbucket" to maintain consistency with the platform ordering. This ensures both the main platform guide and self-hosted specific guide are accessible through navigation.

📄 docs/self-hosted/gitea-forgejo.md ^(NEW) 🔗

References

📄 docs/platforms/gitea-forgejo.md ^(NEW)

📄 docs/self-hosted/gitlab.md

Create a self-hosted specific guide for Gitea/Forgejo platforms, following the pattern established by other files in the docs/self-hosted/ directory. This should be a more concise version focusing specifically on self-hosted deployment considerations, referencing the main platform guide in docs/platforms/gitea-forgejo.md for detailed integration steps. Include:

Brief overview of self-hosted Gitea/Forgejo deployment

Links to the main integration guide

Self-hosted specific considerations (network access, firewall rules, etc.)

Reference to IP whitelisting requirements

Links to official Gitea/Forgejo self-hosting documentation

Keep this guide focused and avoid duplicating content from the main platform guide.

Diagram

sequenceDiagram
    participant User as User
    participant Docs as Documentation Site
    participant CR as CodeRabbit Platform
    participant GF as Gitea/Forgejo Instance
    
    User->>Docs: Browse platform options
    Docs->>User: Show Gitea/Forgejo integration guide
    User->>CR: Access CodeRabbit login
    CR->>User: Present Gitea/Forgejo option
    User->>GF: Create OAuth2 application
    GF->>User: Provide client credentials
    User->>GF: Create CodeRabbit user account
    GF->>User: Generate access token
    User->>CR: Submit instance URL and credentials
    CR->>GF: Establish OAuth connection
    CR->>User: Complete integration setup
    User->>Docs: Reference troubleshooting if needed

Import In IDE

🤖 Prompt for AI Agents

I have created the following plan after thorough exploration and analysis of the codebase. Follow the below plan verbatim. Trust the files and references. Do not re-verify what's written in the plan. Explore only when absolutely necessary. First implement all the proposed file changes and then I'll review all the changes together at the end.

### Observations

The GitHub issue requests adding documentation for Gitea/Forgejo PR support to CodeRabbit. Currently, CodeRabbit supports 6 Git platforms including self-hosted GitLab, but not Gitea/Forgejo. These are self-hosted Git platforms that are API-compatible with each other (Forgejo is a fork of Gitea) and support OAuth2/webhooks similar to GitLab. The documentation follows a clear pattern with platform-specific guides under `docs/platforms/` and self-hosted variants under `docs/self-hosted/`. The self-hosted GitLab documentation provides an excellent template for the integration workflow.

### Approach

I'll create comprehensive documentation for Gitea/Forgejo support by following the established patterns in the codebase. Since Gitea and Forgejo are API-compatible and both are self-hosted platforms, I'll create a combined documentation approach that covers both platforms in a single guide, similar to how self-hosted GitLab is handled. This will include updating the platform overview pages, adding the new platform documentation, updating navigation, and ensuring consistency across all references to supported platforms.

### Reasoning

I explored the repository structure and found it's a Docusaurus documentation site for CodeRabbit. I examined the current platform support documentation, particularly the self-hosted GitLab integration guide which serves as the best template. I checked the sidebar configuration to understand navigation structure, searched for any existing Gitea/Forgejo references (found none), and researched the technical compatibility between Gitea/Forgejo and existing Git platforms to understand integration requirements.

## Mermaid Diagram

sequenceDiagram
    participant User as User
    participant Docs as Documentation Site
    participant CR as CodeRabbit Platform
    participant GF as Gitea/Forgejo Instance
    
    User->>Docs: Browse platform options
    Docs->>User: Show Gitea/Forgejo integration guide
    User->>CR: Access CodeRabbit login
    CR->>User: Present Gitea/Forgejo option
    User->>GF: Create OAuth2 application
    GF->>User: Provide client credentials
    User->>GF: Create CodeRabbit user account
    GF->>User: Generate access token
    User->>CR: Submit instance URL and credentials
    CR->>GF: Establish OAuth connection
    CR->>User: Complete integration setup
    User->>Docs: Reference troubleshooting if needed

## Proposed File Changes

### docs/platforms/gitea-forgejo.md(NEW)

References: 

- docs/platforms/self-hosted-gitlab.md

Create a comprehensive integration guide for Gitea and Forgejo platforms, using `docs/platforms/self-hosted-gitlab.md` as the template. The guide should cover both platforms in a single document since they are API-compatible. Include sections for:

- Introduction explaining Gitea/Forgejo and their relationship
- Version compatibility requirements (Gitea ≥1.22, Forgejo ≤7.0 for API compatibility)
- Step-by-step integration process including:
  - Visiting CodeRabbit login page and selecting Gitea/Forgejo option
  - Entering the self-hosted instance URL
  - Automated vs manual onboarding options
  - Creating dedicated CodeRabbit user account
  - Setting up OAuth2 application with required scopes (`api read_user email openid`)
  - Generating personal access tokens
  - IP whitelisting requirements
- Screenshots and visual guides (placeholder references for now)
- Troubleshooting section
- Links to official Gitea/Forgejo documentation

Use the same structure and tone as the GitLab guide but adapt the content for Gitea/Forgejo specifics. Include notes about API compatibility between the two platforms.

### docs/platforms/platforms.md(MODIFY)

References: 

- docs/platforms/gitea-forgejo.md(NEW)

Update the platform overview page to include Gitea/Forgejo in the list of supported Git platforms. Add the new platform to:

1. The bulleted list in the "Use CodeRabbit with Git platforms" section (after BitBucket Cloud)
2. The "What's next" section with a link to the new integration guide

Ensure the new platform follows the same formatting and presentation style as existing platforms. Update the introductory text if needed to reflect the expanded platform support.

### sidebars.ts(MODIFY)

References: 

- docs/platforms/gitea-forgejo.md(NEW)
- docs/self-hosted/gitea-forgejo.md(NEW)

Add the new Gitea/Forgejo platform documentation to the sidebar navigation. In the "Supported Git platforms" category (around line 47-54), add `"platforms/gitea-forgejo"` after `"platforms/bitbucket-cloud"` to maintain alphabetical ordering. This will make the new documentation accessible through the main navigation menu.
Add the self-hosted Gitea/Forgejo documentation to the "Self-host CodeRabbit" category in the sidebar. In the items array around line 62-67, add `"self-hosted/gitea-forgejo"` after `"self-hosted/bitbucket"` to maintain consistency with the platform ordering. This ensures both the main platform guide and self-hosted specific guide are accessible through navigation.

### docs/self-hosted/gitea-forgejo.md(NEW)

References: 

- docs/platforms/gitea-forgejo.md(NEW)
- docs/self-hosted/gitlab.md

Create a self-hosted specific guide for Gitea/Forgejo platforms, following the pattern established by other files in the `docs/self-hosted/` directory. This should be a more concise version focusing specifically on self-hosted deployment considerations, referencing the main platform guide in `docs/platforms/gitea-forgejo.md` for detailed integration steps. Include:

- Brief overview of self-hosted Gitea/Forgejo deployment
- Links to the main integration guide
- Self-hosted specific considerations (network access, firewall rules, etc.)
- Reference to IP whitelisting requirements
- Links to official Gitea/Forgejo self-hosting documentation

Keep this guide focused and avoid duplicating content from the main platform guide.

Developer Humor

🐰 CodeRabbit hopped into new territory,\n> From GitLab's garden to Gitea's prairie!\n> Forgejo too, with API so true,\n> Now every repo can get a review! 🔍\n> Self-hosted or cloud, we're Git-ready proud! ☁️

Execution Information

Branch: main
Commit: ee5a787

💡 Tips

Supported Commands (Inside Comments)

Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Gitea/Forgejo PR support #489

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions