| name | instantly-ci-integration |
|---|---|
| description | Configure Instantly CI/CD integration with GitHub Actions and testing. Use when setting up automated testing, configuring CI pipelines, or integrating Instantly tests into your build process. Trigger with phrases like "instantly CI", "instantly GitHub Actions", "instantly automated tests", "CI instantly". |
| allowed-tools | Read, Write, Edit, Bash(gh:*) |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <[email protected]> |
Instantly CI Integration
Overview
Set up CI/CD pipelines for Instantly integrations with automated testing.
Prerequisites
- GitHub repository with Actions enabled
- Instantly test API key
- npm/pnpm project configured
Instructions
Step 1: Create GitHub Actions Workflow
Create .github/workflows/instantly-integration.yml:
name: Instantly Integration Tests
on:
push:
branches: [main]
pull_request:
branches: [main]
env:
INSTANTLY_API_KEY: ${{ secrets.INSTANTLY_API_KEY }}
jobs:
test:
runs-on: ubuntu-latest
env:
INSTANTLY_API_KEY: ${{ secrets.INSTANTLY_API_KEY }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
- run: npm ci
- run: npm test -- --coverage
- run: npm run test:integration
Step 2: Configure Secrets
gh secret set INSTANTLY_API_KEY --body "sk_test_***"
Step 3: Add Integration Tests
describe('Instantly Integration', () => {
it.skipIf(!process.env.INSTANTLY_API_KEY)('should connect', async () => {
const client = getInstantlyClient();
const result = await client.healthCheck();
expect(result.status).toBe('ok');
});
});
Output
- Automated test pipeline
- PR checks configured
- Coverage reports uploaded
- Release workflow ready
Error Handling
| Issue | Cause | Solution |
|---|---|---|
| Secret not found | Missing configuration | Add secret via gh secret set |
| Tests timeout | Network issues | Increase timeout or mock |
| Auth failures | Invalid key | Check secret value |
Examples
Release Workflow
on:
push:
tags: ['v*']
jobs:
release:
runs-on: ubuntu-latest
env:
INSTANTLY_API_KEY: ${{ secrets.INSTANTLY_API_KEY_PROD }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '20'
- run: npm ci
- name: Verify Instantly production readiness
run: npm run test:integration
- run: npm run build
- run: npm publish
Branch Protection
required_status_checks:
- "test"
- "instantly-integration"
Resources
Next Steps
For deployment patterns, see instantly-deploy-integration.