GitHub Integration & GitHub App
Install the official Kavach GitHub App, configure repository webhooks, and enable automated PR security status checks.
1. Installing the Kavach GitHub App
In Organization Settings > Integrations, click Connect GitHub. You will be redirected to GitHub to install the Kavach App into your organization or personal account. You can grant access to all repositories or selected repositories.
2. Required GitHub Permissions
Kavach requests minimal necessary permissions to function:
- Repository Contents (Read): To clone source code for AST scanning.
- Pull Requests (Read & Write): To post automated AutoFix diffs and status reviews.
- Checks (Read & Write): To report granular pass/fail status directly inside GitHub PR checks.
- Webhooks (Read & Write): To receive push and pull_request events automatically.
3. GitHub Actions Workflow Integration
Add a blocking merge check in your .github/workflows/security.yml file:
