CI/CD Integration Guide
Automate policy testing and deployment with GitHub Actions. The TealTiger Playground ships with two pre-configured workflows — one for CI and one for CD — plus a built-in workflow generator for custom pipelines.
All workflows run within the GitHub Actions free tier (2,000 minutes/month). Estimated usage per CI run: ~2 minutes.
Overview
| Layer | What it does | Workflow file |
|---|
| CI | Lint, type-check, unit/property-based tests, E2E tests, coverage | .github/workflows/playground-ci.yml |
| CD | Build, deploy to Vercel, smoke tests, status notification | .github/workflows/playground-deploy.yml |
| Custom | Generate workflow YAML from the playground UI | On-demand |
playground/ change.
1. GitHub Actions Setup
Required Secrets
Navigate to Settings → Secrets and variables → Actions and add:
| Secret | Required by | Description |
|---|
VERCEL_TOKEN | CD workflow | Vercel API token |
VERCEL_ORG_ID | CD workflow | Your Vercel organization/team ID |
VERCEL_PROJECT_ID | CD workflow | The Vercel project ID |
TEALTIGER_WORKSPACE_ID | Custom workflows | Your TealTiger workspace ID |
TEALTIGER_DEPLOY_TOKEN | Custom workflows | Deploy token for automated deployment |
2. CI Workflow — Automated Testing
File: .github/workflows/playground-ci.yml
The CI workflow runs on every push to main and on pull requests that touch playground files.
Jobs
- Lint & Type Check — TypeScript compilation and ESLint
- Unit & Property-Based Tests — Vitest with fast-check and coverage
- E2E Tests — Playwright against the built output
- PR Comment — Summary table with results from all test jobs
## 🐯 TealTiger Playground CI Results
| Check | Status |
|-------|--------|
| Lint & Type Check | ✅ Passed |
| Unit & Property Tests | ✅ 142/142 passed |
| E2E Tests (Playwright) | ✅ 28/28 passed |
| Coverage | Lines: 83% | Branches: 71% |
Blocking PRs on Failure
Enable branch protection rules: Settings → Branches → Add rule for main → Enable Require status checks to pass before merging → Select the three CI jobs.
3. CD Workflow — Automated Deployment
File: .github/workflows/playground-deploy.yml
Triggers on pushes to main when playground files change. Jobs:
- Deploy to Vercel — builds and deploys to production
- Smoke Tests — health check, content verification, static asset check
- Deployment Status — sets commit status on GitHub
4. Generating Custom Workflows
import { CICDIntegrationService } from '../services/CICDIntegrationService';
const cicd = new CICDIntegrationService();
const workflowYaml = await cicd.generateWorkflow({
workspaceId: 'your-workspace-id',
githubRepo: 'your-org/your-repo',
branch: 'main',
testSuiteId: 'suite-abc123',
autoDeployOnMerge: true,
targetEnvironment: 'production',
});
5. Free Tier Budget Management
| Job | Estimated Duration |
|---|
| Lint & Type Check | ~1-2 min |
| Unit & Property Tests | ~2-3 min |
| E2E Tests (Playwright) | ~3-5 min |
| Deploy to Vercel | ~2-3 min |
- Path filters skip unrelated commits
- Concurrency controls cancel in-progress runs
- npm and Playwright browser caching between runs
- Timeout limits prevent runaway builds
6. Troubleshooting
| Issue | Solution |
|---|
| CI not triggering | Verify workflow file path and that changes are under playground/ |
| PR comment missing | Check pull-requests: write permission |
| Vercel deploy failing | Verify VERCEL_TOKEN, VERCEL_ORG_ID, VERCEL_PROJECT_ID secrets |
| Playwright failures in CI | Delete stale browser cache from Actions → Caches |
| Tests pass locally, fail in CI | Ensure package-lock.json is committed; check OS-specific issues |
