instantly-ci-integration

# 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`: ```yaml 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 ```bash gh secret set INSTANTLY_API_KEY --body "sk_test_***" ``` ### Step 3: Add Integration Tests ```typescript 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 ```yaml 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 ```yaml required_status_checks: - "test" - "instantly-integration" ``` ## Resources - [GitHub Actions Documentation](https://docs.github.com/en/actions) - [Instantly CI Guide](https://docs.instantly.com/ci) ## Next Steps For deployment patterns, see `instantly-deploy-integration`.