home / skills / jeremylongshore / claude-code-plugins-plus-skills / clay-ci-integration

This skill helps you configure Clay CI/CD with GitHub Actions for automated testing and integrated quality checks across pipelines.

npx playbooks add skill jeremylongshore/claude-code-plugins-plus-skills --skill clay-ci-integration

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.7 KB
---
name: clay-ci-integration
description: |
  Configure Clay CI/CD integration with GitHub Actions and testing.
  Use when setting up automated testing, configuring CI pipelines,
  or integrating Clay tests into your build process.
  Trigger with phrases like "clay CI", "clay GitHub Actions",
  "clay automated tests", "CI clay".
allowed-tools: Read, Write, Edit, Bash(gh:*)
version: 1.0.0
license: MIT
author: Jeremy Longshore <[email protected]>
---

# Clay CI Integration

## Overview
Set up CI/CD pipelines for Clay integrations with automated testing.

## Prerequisites
- GitHub repository with Actions enabled
- Clay test API key
- npm/pnpm project configured

## Instructions

### Step 1: Create GitHub Actions Workflow
Create `.github/workflows/clay-integration.yml`:

```yaml
name: Clay Integration Tests

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

env:
  CLAY_API_KEY: ${{ secrets.CLAY_API_KEY }}

jobs:
  test:
    runs-on: ubuntu-latest
    env:
      CLAY_API_KEY: ${{ secrets.CLAY_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 CLAY_API_KEY --body "sk_test_***"
```

### Step 3: Add Integration Tests
```typescript
describe('Clay Integration', () => {
  it.skipIf(!process.env.CLAY_API_KEY)('should connect', async () => {
    const client = getClayClient();
    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:
      CLAY_API_KEY: ${{ secrets.CLAY_API_KEY_PROD }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm ci
      - name: Verify Clay production readiness
        run: npm run test:integration
      - run: npm run build
      - run: npm publish
```

### Branch Protection
```yaml
required_status_checks:
  - "test"
  - "clay-integration"
```

## Resources
- [GitHub Actions Documentation](https://docs.github.com/en/actions)
- [Clay CI Guide](https://docs.clay.com/ci)

## Next Steps
For deployment patterns, see `clay-deploy-integration`.

Overview

This skill configures Clay CI/CD integration with GitHub Actions to run automated tests and integration checks. It guides adding workflows, setting secrets, and writing integration tests so Clay health and behavior are validated in PRs and releases. The result is reproducible CI pipelines with coverage and release readiness checks.

How this skill works

The skill provides a recommended GitHub Actions workflow that installs Node, restores dependencies, runs unit and integration tests, and exposes the CLAY_API_KEY via repository secrets. It shows how to add a small integration test that skips when the API key is absent, and gives a release workflow pattern that runs integration tests before build and publish. Error causes and fixes for common CI failures are included.

When to use it

  • Setting up CI for a Clay-based project using npm/pnpm
  • Adding integration tests that call Clay services in CI
  • Configuring PR checks and branch protection around Clay tests
  • Creating a release workflow that verifies Clay readiness before publishing
  • Automating coverage and test reporting in repositories using Clay

Best practices

  • Store CLAY_API_KEY in GitHub Secrets and reference via env in workflows
  • Skip or mock integration tests when secret is missing to avoid flaky PR failures
  • Cache dependencies with setup-node and npm ci to speed runs
  • Keep integration test timeouts reasonable; increase only for genuine network needs
  • Run integration tests on release/tag workflows with production secrets only

Example use cases

  • Run unit tests + Clay integration checks on every PR to main
  • Use a tag-triggered release job that verifies Clay integration before publish
  • Protect main branch with required_status_checks for clay-integration and test jobs
  • Add a health-check integration test that asserts client.healthCheck() returns ok
  • Use CI to generate coverage reports and gate merge when coverage drops

FAQ

What if CI reports "Secret not found"?

Add the API key using gh secret set CLAY_API_KEY or through the repository settings secrets and ensure the workflow references the correct secret name.

How do I avoid flakiness from network timeouts in integration tests?

Mock network calls where possible, increase test timeouts only when needed, and run full external integration tests only on release or nightly runs.