Overview
The GitHub integration allows Steadwing to analyze your codebase and track deployments, commits, and releases. This enables comprehensive root cause analysis by correlating production incidents with recent code changes, helping you identify which deployment or commit may have introduced an issue.Why Use GitHub with Steadwing?
Deployment Tracking
Correlate incidents with recent deployments and releases
Code Change Analysis
Identify which commits may have caused production issues
Codebase Insights
Enable Steadwing to analyze your code for better solution proposals
Timeline Correlation
Link incidents to specific PRs, commits, and deployment times
Benefits
- Faster Root Cause Identification - Quickly pinpoint which code change triggered an incident
- Automated Code Analysis - Steadwing reviews relevant code sections during RCA
- Deployment Context - Understand what was deployed when an incident occurred
- Better Solution Proposals - Get context-aware fixes based on your actual codebase
- Historical Insights - Track patterns between code changes and incidents over time
Setup Instructions
Step 1: Connect GitHub OAuth
- Navigate to Steadwing Settings
- Find the GitHub integration card
- Click the Connect button
- You will be redirected to GitHub’s authorization page
- Click Authorize Steadwing to complete OAuth
Step 2: Install Steadwing GitHub App
After completing OAuth, you must install the Steadwing GitHub App on your repositories:- Follow the installation link provided in the settings page (Step 2)
- Choose where to install the app:
- All repositories - Install on all current and future repos
- Select repositories - Choose specific repositories
- Click Install to complete the setup
- The Steadwing app will now have access to track changes in your selected repositories
Step 3: Verify Installation
- Go to your GitHub organization settings
- Navigate to Installed GitHub Apps
- Confirm that Steadwing appears in the list
- Check that the correct repositories are selected
How GitHub Integration Works
Automatic Event Tracking
Steadwing automatically monitors and tracks:- Commits - Every commit pushed to your repositories
- Pull Requests - PR merges and their associated changes
- Releases - Tagged releases and their deployment times
- Deployments - Deployment events via GitHub Actions or other CI/CD tools
Root Cause Analysis
When an incident occurs, Steadwing:- Identifies the incident time window
- Retrieves all commits, PRs, and deployments within that window
- Analyzes code changes that may have introduced the issue
- Correlates file changes with error patterns
- Proposes solutions based on your codebase
Code Analysis
Steadwing can:- Review relevant files and functions
- Identify potentially problematic changes
- Suggest code-level fixes
- Link incidents to specific lines of code
Configuration
Required Permissions
The GitHub integration requires:- repo - Full access to private and public repositories
- Read repository contents
- Read commit history
- Read pull request data
- read:org - Organization membership information
- Read organization and team membership
Repository Access
You can control which repositories Steadwing can access:- Go to GitHub Settings → Integrations → Applications
- Find Steadwing in the list
- Click Configure
- Modify repository access settings
- Save changes
FAQs
Why do I need to complete Step 2 separately?
Why do I need to complete Step 2 separately?
OAuth (Step 1) authorizes Steadwing to access GitHub, but installing the GitHub App (Step 2) grants specific repository access and enables webhook events for real-time tracking.
Can I limit Steadwing's access to specific repositories?
Can I limit Steadwing's access to specific repositories?
Yes, during Step 2 you can select specific repositories instead of granting access to all repositories. You can modify this later in GitHub settings.
Does Steadwing modify my code or create commits?
Does Steadwing modify my code or create commits?
No, Steadwing only has read access. It analyzes your code but never modifies, commits, or pushes changes to your repositories.
What happens if I add new repositories later?
What happens if I add new repositories later?
If you selected “All repositories” during installation, new repositories will automatically be tracked. Otherwise, you need to manually grant access to new repositories in GitHub settings.
Does Steadwing work with private repositories?
Does Steadwing work with private repositories?
Yes, Steadwing works with both public and private repositories. The
repo permission grants access to private repositories.