Live demonstration repository showcasing the incident.io GitHub Action with a realistic payment processing API.
You must fork this repository to run demos. Follow the Setup Guide to configure your fork with the required secrets and run your first demo.
- Fork this repository to your GitHub account
- Complete the Setup Guide (5 minutes)
- Run your first demo and watch alerts appear in incident.io
This repository shows how the incident.io GitHub Action automatically creates alerts from GitHub events, flowing critical information directly into your incident management workflow.
- CI/CD Pipeline Failures - Automatic alerts when builds or tests fail with auto-resolution when fixed
- Deployment Failures - Critical alerts for production deployment issues with auto-resolution
- Critical Pull Requests - Immediate notifications when PRs need urgent review with auto-resolution when closed/merged
- Custom Business Logic - Data quality checks and health monitoring integration
- Event Filtering - Only alert on specific severities or labels
- Deduplication - Prevent alert storms by grouping related events
- Severity Mapping - Map GitHub severities to your incident.io levels
- Custom Fields - Route alerts to teams via incident.io catalog
- Auto-Resolution - Automatically clear alerts when issues are fixed
Complete setup instructions are in docs/SETUP.md. The guide walks you through forking the repository, configuring incident.io alert sources, adding GitHub secrets, and running your first test.
Run demos via Actions → Demo Trigger. Each scenario demonstrates key integration features:
Duration: 2-3 minutes | Demonstrates CI failure detection with automatic resolution when builds are fixed, preventing broken code from reaching production. Detailed guide →
Duration: 2-3 minutes | Shows critical alerts for production deployment failures with automatic resolution when deployments succeed, reducing manual alert cleanup. Detailed guide →
Duration: 1 minute | Demonstrates urgent PR alerting based on labels with 1-hour SLA enforcement and auto-resolution when PRs are closed. Detailed guide →
Duration: 1-2 minutes | Shows integration of custom business logic and health monitoring into unified incident workflow. Detailed guide →
For detailed instructions, trigger options, and troubleshooting: See docs/SCENARIOS.md
See docs/DEMO_GUIDE.md for a step-by-step script to record a compelling demo video for your team.
GitHub Events → incident.io GitHub Action → incident.io API → Alerts & Incidents
↓ ↓
Workflows Catalog Routing
Security Scans Team Assignment
Deployments Auto-Resolution
PRs Workflow Triggers
This demo uses a simple Express.js payment processing API to provide realistic business context:
/api/payments- Payment processing endpoints/api/health- Health check endpoints/api/balance- Account balance endpoints
The application includes:
- Tests with controllable failures for CI demos
- Deployment scripts with failure simulation
- Data quality check scripts
- SETUP.md - Initial setup and configuration
- DEMO_GUIDE.md - Video recording script
- SCENARIOS.md - Detailed scenario documentation
.
├── .github/workflows/ # GitHub Actions workflows
│ ├── demo-trigger.yml # Master demo trigger with automated scenarios
│ ├── ci.yml # Main CI pipeline
│ ├── alert-ci-failures.yml # CI failure alerts with auto-resolution
│ ├── deployment.yml # Production deployment with integrated alerts
│ ├── alert-critical-pr.yml # Critical PR alerts with auto-resolution
│ └── custom-health-check.yml # Data quality checks
├── src/ # Application code
│ ├── app.js
│ ├── routes/
│ └── utils/
├── tests/ # Test files
├── scripts/ # Deployment and check scripts
└── docs/ # Documentation
This demo showcases the incident.io GitHub Action which automatically creates alerts in incident.io from GitHub workflow events.
Key capabilities:
- Monitors CI/CD pipelines, deployments, and PRs
- Rich filtering and deduplication
- Catalog-driven routing to teams
- Auto-resolution support
MIT
For setup help, troubleshooting, and support resources, see docs/SETUP.md.