协作头脑风暴
brainstorming
在实现前澄清需求、探索设计选择,并形成清晰的开发方向。
elevenlabs-ci-integration【开发与工程】Configure CI/CD pipelines for ElevenLabs with mocked unit tests and gated integration tests. Use when setting up GitHub Actions for TTS projects, configuring CI test strategies, or automating ElevenLabs integration validation without burning character quota on every PR. Trigger with "elevenlabs CI", "elevenlabs GitHub Actions", "elevenlabs automated …
独立 GitHub 快照 · 自动分类 · 以原作者文档为准
name: elevenlabs-ci-integration description: | Configure CI/CD pipelines for ElevenLabs with mocked unit tests and gated integration tests. Use when setting up GitHub Actions for TTS projects, configuring CI test strategies, or automating ElevenLabs integration validation without burning character quota on every PR. Trigger with "elevenlabs CI", "elevenlabs GitHub Actions", "elevenlabs automated tests", "CI elevenlabs", "elevenlabs pipeline". allowed-tools: Read, Write, Edit, Bash(gh:*) version: 1.6.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io tags:
Set up CI/CD pipelines that test ElevenLabs integrations without burning
character quota on every PR. Uses a two-tier strategy: mocked unit tests on
every push (no API key, zero quota), and gated integration tests that hit
the real API only on main or a manual dispatch, behind a quota guard.
The full workflow YAML and secret setup live in references/implementation.md; the complete test code lives in references/examples.md. This file walks the strategy end to end, then drills into either reference for copy-paste source.
Create .github/workflows/elevenlabs-tests.yml with two jobs. unit-tests
runs on every push/PR with a mock key. integration-tests runs only on main
or workflow_dispatch, needs: unit-tests, and checks remaining quota before
spending any:
jobs:
unit-tests: # every push/PR — mock key, 0 quota
runs-on: ubuntu-latest
steps: [checkout, setup-node, npm ci, npm test -- --coverage]
# env: ELEVENLABS_API_KEY: "sk_test_mock_key_for_ci"
integration-tests: # main / manual only — real key
if: github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch'
needs: unit-tests
# 1) GET /v1/user → skip if remaining characters < 5000
# 2) npm run test:integration behind that guard
Copy the complete, runnable workflow from references/implementation.md.
gh secret set ELEVENLABS_API_KEY --body "sk_your_test_key_here"
# optional, for webhook tests:
gh secret set ELEVENLABS_WEBHOOK_SECRET --body "whsec_your_secret_here"
Mock the entire SDK so unit tests never call the API or spend quota. Minimal skeleton:
vi.mock("@elevenlabs/elevenlabs-js", () => ({
ElevenLabsClient: vi.fn().mockImplementation(() => ({
textToSpeech: { convert: vi.fn().mockResolvedValue(/* mock MP3 stream */) },
voices: { getAll: vi.fn().mockResolvedValue({ voices: [/* Rachel */] }) },
})),
}));
Full mock (streaming, voices, user/subscription) and assertions: references/examples.md.
Skip integration tests unless ELEVENLABS_INTEGRATION is set, and keep them
cheap — Flash model, short text, low bitrate:
const SKIP = !process.env.ELEVENLABS_INTEGRATION;
describe.skipIf(SKIP)("ElevenLabs Integration", () => { /* smoke tests */ });
Full smoke suite: references/examples.md.
Add test, test:integration, and test:ci scripts so CI and local runs
share one entry point. See
references/examples.md.
Once configured, the pipeline produces:
.github/workflows/elevenlabs-tests.yml — two-tier CI pipelineELEVENLABS_API_KEY (and optional webhook secret) stored in GitHub secretstests/unit/ mocked tests that run on every push at 0 character costtests/integration/ smoke tests gated to main/manual behind a quota guardtest, test:integration, test:ci) shared by CI and local| Tier | When | API Key | Quota Cost | Coverage |
|---|---|---|---|---|
| Unit tests | Every push/PR | Mock key | 0 characters | SDK integration patterns |
| Integration | Main + manual | Real test key | ~50 chars | End-to-end TTS verification |
| Quota check | Before integration | Real test key | 0 (GET only) | Prevents surprise billing |
| Issue | Cause | Solution |
|---|---|---|
| Secret not found in CI | Missing repository secret | gh secret set ELEVENLABS_API_KEY |
| Integration tests timeout | Slow TTS generation | Increase test timeout to 30s; use Flash model |
| Quota depleted in CI | Too many integration runs | Use quota guard; limit to main branch only |
| Mock drift | SDK API changed | Update mocks when upgrading SDK |
Run only the cheap tier locally (no API key, no quota):
npm test -- --coverage
Trigger the gated integration tier by hand (from the Actions tab or CLI):
gh workflow run elevenlabs-tests.yml
Run integration tests locally against a real test key:
ELEVENLABS_INTEGRATION=1 npm run test:integration
Full worked examples — complete SDK mock, gated smoke suite, and package scripts — are in references/examples.md.
For deployment patterns, see the elevenlabs-deploy-integration skill, which
covers promoting validated TTS builds through staging and production.