Setup
Connect your repository through a Managed Workspace:- Connect GitHub — install the Oplane GitHub App and link your repositories
- Connect GitLab — sign in with GitLab and select your projects
How it works
When a PR or MR is opened or updated, the Oplane worker analyses the diff, creates a threat model scoped to the changes, and posts requirements as review comments directly on the relevant lines.Automatic analysis
Oplane reads the diff, identifies architectural and security-relevant changes, and generates security requirements specific to what changed. Each finding is posted as an inline comment on the affected lines — so you get feedback exactly where it matters.Review modes
You can configure how Oplane reviews your PRs/MRs per workspace:- Analyse every PR/MR — Oplane runs automatically on every new pull request or merge request. Best for projects with active development.
- On request — Mention
@oplanein a comment on any PR or MR to trigger a review when you need it. - Disabled — No automatic reviews for this workspace.
Check failure threshold
By default, the Oplane Security Review check reports Neutral when unresolved requirements exist. GitHub branch protection and GitLab merge-request approvals treat Neutral as passing, so the check surfaces findings without blocking a merge. Set a check failure threshold per repository to have the check report Fail whenever an unresolved requirement sits at or above a severity you choose. Combined with your CI pipeline’s branch protection rules, this acts as a merge gate to prevent unresolved requirements from slipping through.Configure the failure threshold
- Open the workspace for the repository (Managed Workspace).
- Go to workspace settings and find the linked repository.
- Under Check failure threshold, pick a severity level:
Use as a merge gate
Oplane does not modify your branch protection. You control which branches enforce the check by marking it as required in your Git provider:- GitHub — Open the repository’s Settings → Branches → Branch protection rules (or Settings → Rules → Rulesets), edit the rule for the target branch, and add
Oplane Security Reviewunder Require status checks to pass before merging. Once you have finished editing the rule, set the Enforcement Status to Active. - GitLab — Open the project’s Settings → Merge requests and require the
Oplane Security Reviewstatus check under Merge checks, or add it as a required approval rule.
Clear a failing check without a new push
Resolving a requirement in Oplane re-posts the Oplane Security Review check on the same commit SHA that was reviewed. You do not need to push a new commit to clear a failing check. Both of the following trigger a refresh:- Marking a requirement as resolved, out of scope, or accepted risk in the Oplane dashboard.
- Calling the MCP
update_implementation_statetool from your coding agent.