GitHub App Setup
Connect Oplane to your GitHub repositories in three steps. Once set up, Oplane can automatically review pull requests for architectural security risks — or run on demand when you need it.
Prerequisites: You need admin access to your GitHub organization to install the Oplane GitHub App.
Step 1: Install the Oplane GitHub App
In your Oplane dashboard, go to Settings in the sidebar, then the Git tab. Click the Install GitHub App button in the top right corner.
You'll be redirected to GitHub where you choose your organization and select which repositories the Oplane Bot should have access to. You can grant access to all repositories or pick specific ones.
Permissions granted: Read access to code, issues, members, and metadata. Read and write access to checks and pull requests — this is how Oplane posts review comments on your PRs.
Step 2: Link Your GitHub Account
After installing the app, go back to Settings → Git in Oplane. Under Linked Accounts, click Link GitHub to authorize the Oplane Bot. This lets Oplane know which repositories you personally have access to.
GitHub will ask you to authorize Oplane Bot. Review the permissions and click Authorize Oplane Bot.
Step 3: Choose a Review Mode
Once your account is linked, you'll see your repositories listed under My Repositories. For each repository, choose a review mode:
@oplane_review or oplane_review on a PR to trigger a review. Good for repositories where you want to review selectively.
Tip: You can change the review mode for any repository at any time. Use the search bar to quickly find specific repositories if you have many.