livesmoke

Overview ¶

Pre-release smoke test against the live API.

Runs the happy path + the common error paths across the events, invoices, and subscriptions resources. Used by .github/workflows/live-smoke.yml (maintainer-only).

Required env:

THREECOMMON_API_KEY    — a real API key

Optional env:

THREECOMMON_BASE_URL   — defaults to https://api.3common.com
SMOKE_EVENT_ID         — an event ID owned by the API-key host; if set,
                         exercises the events.Retrieve happy path
SMOKE_INVOICE_ID       — an invoice ID owned by the API-key host; if set,
                         exercises the invoices.Retrieve happy path
SMOKE_SUBSCRIPTION_ID  — a subscription ID owned by the API-key host; if
                         set, exercises subscriptions.Retrieve and
                         subscriptions.PreviewUpcomingInvoice

Run with: go run ./scripts/livesmoke