@nacew/utestme-ci
v0.1.0
Published
Run uTestMe performance suites from CI (GitHub Actions, GitLab, any pipeline) and fail the build when they fail.
Downloads
365
Readme
@nacew/utestme-ci
Run your uTestMe performance suites from any CI and fail the build when they fail.
export UTESTME_TOKEN=utm_dk_… # a deploy token: Performance → Environments → Deploy tokens (CI)
npx @nacew/utestme-ci run # every suite of the token's environment
npx @nacew/utestme-ci run --suite "Checkout API" --suite "Landing pages"
npx @nacew/utestme-ci suites # what the token can runIt queues the runs, waits for them, prints one line per suite and exits:
0every suite passed1a suite failed (thresholds or API checks), could not finish, was not queued, or the wait timed out2the command could not run (no token, a suite name uTestMe does not have, uTestMe unreachable)
The commit, branch and a link back to the pipeline are read from GitHub Actions, GitLab CI, Bitbucket Pipelines, CircleCI and Vercel; --commit, --branch and --ci-url override them. On GitHub Actions it also writes a table to the job summary, an error annotation per failed suite, and the outputs passed and runs.
On GitHub there is also an Action: uses: nacew-account/utestme-action@v1.
Options
| Flag | Environment | Default |
| --------------------------- | ------------------------------------------- | ------------------ |
| --token | UTESTME_TOKEN (or UTESTME_DEPLOY_TOKEN) | — |
| --url | UTESTME_URL | https://utest.me |
| --suite, --suites "A,B" | UTESTME_SUITES | all |
| --release | UTESTME_RELEASE | — |
| --timeout <minutes> | UTESTME_TIMEOUT | 30 |
| --interval <seconds> | | 10 |
| --no-wait | | waits |
| --allow-skipped | | off |
| --json | | off |
A deploy token is a secret: it can start runs and mark deploys for one environment. Keep it in your CI's secrets, never in code.
