Getting Started

1. Install the GitHub App

Visit the landing page and click Install Frost on GitHub. You'll be redirected to GitHub to authorize the app.

Choose the organization and repositories you want Frost to protect. You can grant access to all repositories or select specific ones.

2. Configure protected branches

After installation, navigate to any repository in the Frost dashboard. Open the Configuration tab to set up your protection rules:

• Daily protection windows — define recurring time ranges when merges should be blocked (e.g., overnight, weekends).
• Scheduled protection — set one-time date ranges for holidays, launch windows, or maintenance periods.
• Incident-driven protection — connect PagerDuty to automatically guard repos when a P1/P2 fires.

3. Add the required status check

For Frost to actually block merges, you need to add its status check as a required check in your GitHub branch protection rules.

1. Go to your repository on GitHub → Settings → Branches.
2. Edit the branch protection rule for your default branch (e.g., main).
3. Enable Require status checks to pass before merging.
4. Search for frost and add it as a required check.

Once added, Frost will report a passing or failing status check on every pull request depending on whether protection is currently active.

4. Override labels (optional)

Sometimes you need to merge during a protection window — like a hotfix during an incident. Frost supports bypass labels that let you override protection on a per-PR basis.

Configure your bypass label in the repository settings. When the label is applied to a PR, Frost will allow the merge even during active protection. Every override is recorded in the audit trail.

Next steps

• Set up PagerDuty integration
• Connect Slack notifications
• Read the FAQ