exa-ci-integration
Configure Exa CI/CD integration with GitHub Actions and testing.Use when setting up automated testing, configuring CI pipelines,or integrating Exa tests into your build process.Trigger with phrases like "exa CI", "exa GitHub Actions","exa automated tests", "CI exa".
When & Why to Use This Skill
This Claude skill automates the setup and configuration of Exa CI/CD pipelines using GitHub Actions. It streamlines the integration of automated testing, secure credential management via GitHub Secrets, and the creation of robust integration test suites, ensuring seamless and reliable deployment workflows for Exa-powered applications.
Use Cases
- Automating the generation of GitHub Actions YAML workflows to run Exa integration tests on every push or pull request.
- Securely configuring Exa API keys and environment variables using the GitHub CLI (gh secret set) within a CI environment.
- Implementing automated health checks and connectivity tests for Exa clients to prevent build failures in production pipelines.
- Configuring advanced release workflows and branch protection rules that require successful Exa integration checks before code is merged or published.
| name | exa-ci-integration |
|---|---|
| description | | |
| allowed-tools | Read, Write, Edit, Bash(gh:*) |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Exa CI Integration
Overview
Set up CI/CD pipelines for Exa integrations with automated testing.
Prerequisites
- GitHub repository with Actions enabled
- Exa test API key
- npm/pnpm project configured
Instructions
Step 1: Create GitHub Actions Workflow
Create .github/workflows/exa-integration.yml:
name: Exa Integration Tests
on:
push:
branches: [main]
pull_request:
branches: [main]
env:
EXA_API_KEY: ${{ secrets.EXA_API_KEY }}
jobs:
test:
runs-on: ubuntu-latest
env:
EXA_API_KEY: ${{ secrets.EXA_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 EXA_API_KEY --body "sk_test_***"
Step 3: Add Integration Tests
describe('Exa Integration', () => {
it.skipIf(!process.env.EXA_API_KEY)('should connect', async () => {
const client = getExaClient();
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:
EXA_API_KEY: ${{ secrets.EXA_API_KEY_PROD }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '20'
- run: npm ci
- name: Verify Exa production readiness
run: npm run test:integration
- run: npm run build
- run: npm publish
Branch Protection
required_status_checks:
- "test"
- "exa-integration"
Resources
Next Steps
For deployment patterns, see exa-deploy-integration.