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

This skill helps you set up Juicebox CI/CD with GitHub Actions and tests, streamlining integration and deployment workflows.

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

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

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

# Juicebox CI Integration

## Overview
Configure CI/CD pipelines for Juicebox integration testing and deployment.

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

## Instructions

### Step 1: Configure GitHub Secrets
```bash
# Add secrets via GitHub CLI
gh secret set JUICEBOX_API_KEY --body "jb_test_xxxx"
gh secret set JUICEBOX_API_KEY_PROD --body "jb_prod_xxxx"
```

### Step 2: Create Test Workflow
```yaml
# .github/workflows/juicebox-tests.yml
name: Juicebox Integration Tests

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

env:
  JUICEBOX_API_KEY: ${{ secrets.JUICEBOX_API_KEY }}

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'

      - name: Install dependencies
        run: npm ci

      - name: Run Juicebox tests
        run: npm run test:juicebox

      - name: Upload test results
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: test-results
          path: coverage/
```

### Step 3: Add Integration Tests
```typescript
// tests/juicebox.integration.test.ts
import { describe, it, expect, beforeAll } from 'vitest';
import { JuiceboxClient } from '@juicebox/sdk';

describe('Juicebox Integration', () => {
  let client: JuiceboxClient;

  beforeAll(() => {
    if (!process.env.JUICEBOX_API_KEY) {
      throw new Error('JUICEBOX_API_KEY required for integration tests');
    }
    client = new JuiceboxClient({
      apiKey: process.env.JUICEBOX_API_KEY
    });
  });

  it('authenticates with valid API key', async () => {
    const user = await client.auth.me();
    expect(user.id).toBeDefined();
  });

  it('performs basic search', async () => {
    const results = await client.search.people({
      query: 'engineer',
      limit: 5
    });
    expect(results.profiles).toBeDefined();
  });

  it('handles invalid queries gracefully', async () => {
    await expect(
      client.search.people({ query: '', limit: 5 })
    ).rejects.toThrow();
  });
});
```

### Step 4: Configure Branch Protection
```yaml
# .github/workflows/required-checks.yml
name: Required Checks

on:
  pull_request:
    branches: [main]

jobs:
  juicebox-smoke-test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm ci
      - run: npm run test:juicebox:smoke
        env:
          JUICEBOX_API_KEY: ${{ secrets.JUICEBOX_API_KEY }}
```

### Step 5: Add Deployment Pipeline
```yaml
# .github/workflows/deploy.yml
name: Deploy

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    environment: production

    steps:
      - uses: actions/checkout@v4

      - name: Validate Juicebox config
        run: |
          curl -f -H "Authorization: Bearer ${{ secrets.JUICEBOX_API_KEY_PROD }}" \
            https://api.juicebox.ai/v1/auth/me

      - name: Deploy application
        run: npm run deploy
        env:
          JUICEBOX_API_KEY: ${{ secrets.JUICEBOX_API_KEY_PROD }}
```

## Output
- GitHub Actions workflow files
- Integration test suite
- Branch protection rules
- Deployment pipeline

## Error Handling
| CI Issue | Cause | Solution |
|----------|-------|----------|
| Secret not found | Not configured | Run `gh secret set` |
| Rate limited | Too many test runs | Use sandbox mode |
| Flaky tests | Network issues | Add retry logic |

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

## Next Steps
After CI setup, see `juicebox-deploy-integration` for deployment configuration.

Overview

This skill configures Juicebox CI/CD integration using GitHub Actions and automated tests. It provides ready-to-use workflow examples, test templates, and deployment steps to integrate Juicebox tests into your pipeline. Use it to validate API access, run integration tests, and gate deploys with branch protection.

How this skill works

The skill adds GitHub Actions workflows that run Juicebox integration and smoke tests using a JUICEBOX_API_KEY stored in GitHub Secrets. It includes a TypeScript/Vitest test suite that authenticates, runs searches, and checks error handling, plus deployment and required-check workflows that validate production credentials before deploys. Artifacts like coverage or test results are uploaded for inspection and workflows can be used as required checks for branch protection.

When to use it

  • Setting up automated integration tests against Juicebox in a GitHub repo
  • Adding CI gating to protect main branch before deploy
  • Integrating Juicebox test runs into pull request checks
  • Validating Juicebox production credentials before deployment
  • Troubleshooting flaky or rate-limited Juicebox test runs

Best practices

  • Store JUICEBOX_API_KEY and JUICEBOX_API_KEY_PROD as GitHub Secrets, not in code
  • Run smoke tests on pull requests and full integration on main branch
  • Cache node modules and use npm ci for deterministic installs
  • Upload test artifacts and coverage to debug CI failures
  • Add retries or sandbox mode to reduce rate limiting and flakiness

Example use cases

  • Create .github/workflows/juicebox-tests.yml to run integration test suite on push and PRs
  • Add tests/juicebox.integration.test.ts with Vitest to validate auth, search, and error handling
  • Use required-checks workflow to enforce smoke tests as branch protection checks
  • Add deploy.yml that validates production API key before running deployment script
  • Use gh CLI to set JUICEBOX_API_KEY and JUICEBOX_API_KEY_PROD from CI secrets manager

FAQ

What secrets are required and where to store them?

Set JUICEBOX_API_KEY and JUICEBOX_API_KEY_PROD as GitHub Secrets via gh secret set or the GitHub UI.

How to reduce flaky tests and rate limits?

Use sandbox mode when available, add retry logic in tests, and limit test frequency on the main branch.