Configure Customer.io CI/CD integration.
Use when setting up automated testing, deployment pipelines,
or continuous integration for Customer.io integrations.
Trigger with phrases like "customer.io ci", "customer.io github actions",
"customer.io pipeline", "customer.io automated testing".
Set up CI/CD pipelines for Customer.io integrations: GitHub Actions workflow with unit + integration tests, test fixtures with automatic cleanup, pre-commit hooks, and environment-specific credential management.
Prerequisites
GitHub repository with Node.js project
Separate Customer.io workspace for CI testing (do NOT use production)
GitHub Actions secrets configured
Instructions
Step 1: GitHub Actions Workflow
# .github/workflows/customerio-tests.yml
name: Customer.io Integration Tests
on:
push:
paths:
- "lib/customerio-*.ts"
- "services/customerio-*.ts"
- "tests/customerio*"
pull_request:
paths:
- "lib/customerio-*.ts"
- "services/customerio-*.ts"
env:
CUSTOMERIO_SITE_ID: ${{ secrets.CIO_TEST_SITE_ID }}
CUSTOMERIO_TRACK_API_KEY: ${{ secrets.CIO_TEST_TRACK_API_KEY }}
CUSTOMERIO_APP_API_KEY: ${{ secrets.CIO_TEST_APP_API_KEY }}
CUSTOMERIO_REGION: us
jobs:
unit-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
- run: npm ci
- run: npx vitest run tests/customerio --reporter=verbose
env:
CUSTOMERIO_DRY_RUN: "true" # Unit tests use mocks
integration-tests:
runs-on: ubuntu-latest
needs: unit-tests # Only run if unit tests pass
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
- run: npm ci
- name: Validate credentials
run: |
if [ -z "$CUSTOMERIO_SITE_ID" ]; then
echo "::warning::CIO credentials not configured — skipping integration tests"
exit 0
fi
- name: Run integration tests
run: npx vitest run tests/customerio.integration --reporter=verbose
- name: Cleanup test users
if: always()
run: npx tsx scripts/cio-cleanup-test-users.ts
Step 2: Test Fixtures and Helpers
// tests/helpers/cio-test-utils.ts
import { TrackClient, RegionUS } from "customerio-node";
const TEST_RUN_ID = `ci-${Date.now()}-${Math.random().toString(36).slice(2, 8)}`;
const createdUsers: string[] = [];
export function getCioTestClient(): TrackClient {
return new TrackClient(
process.env.CUSTOMERIO_SITE_ID!,
process.env.CUSTOMERIO_TRACK_API_KEY!,
{ region: RegionUS }
);
}
export function testUserId(label: string): string {
const id = `${TEST_RUN_ID}-${label}`;
createdUsers.push(id);
return id;
}
export async function cleanupTestUsers(client: TrackClient): Promise<void> {
console.log(`Cleaning up ${createdUsers.length} test users...`);
for (const userId of createdUsers) {
try {
await client.suppress(userId);
await client.destroy(userId);
} catch {
// Ignore cleanup errors
}
}
createdUsers.length = 0;
}
// scripts/cio-cleanup-test-users.ts
import { TrackClient, RegionUS } from "customerio-node";
const cio = new TrackClient(
process.env.CUSTOMERIO_SITE_ID!,
process.env.CUSTOMERIO_TRACK_API_KEY!,
{ region: RegionUS }
);
// Clean up any test users from failed CI runs
// This uses the ci- prefix convention from testUserId()
async function cleanup() {
console.log("Cleaning up CI test users...");
console.log("Note: Customer.io doesn't have a list/search API via Track API.");
console.log("Cleanup relies on suppress+destroy for known test user IDs.");
console.log("For bulk cleanup, use the Customer.io dashboard People filter.");
}
cleanup();
Step 5: GitHub Secrets Setup
# Set up CI secrets (use a dedicated test workspace — NEVER production)
gh secret set CIO_TEST_SITE_ID --body "your-test-site-id"
gh secret set CIO_TEST_TRACK_API_KEY --body "your-test-track-key"
gh secret set CIO_TEST_APP_API_KEY --body "your-test-app-key"
