Support and setup

Questions or problems: pratik.phodu@gmail.com. Include the repository name, the commit SHA and, if you have it, the response of the upload step.

Setup

  1. Install Coverbird from the Cursor Origin marketplace (or the button on the home page) and select the repositories to cover. Coverbird works on native Origin repositories; GitHub mirrors are read-only for apps.
  2. Sign in at /login with the email you use on Origin, open the dashboard, and under Repositories press Create token. Copy the token (it is shown once) into your CI secrets as COVERBIRD_TOKEN.
  3. Upload coverage after your tests, for every commit you push. Pick one of the snippets below.
  4. Open a pull request. Coverbird posts a check run, one comment and annotations once the upload for the head commit arrives.

GitHub Actions-style step (any CI that runs shell steps)

- name: Upload coverage to Coverbird
  run: npx --yes coverbird upload --file coverage/lcov.info
  env:
    COVERBIRD_TOKEN: ${{ secrets.COVERBIRD_TOKEN }}

The CLI reads the commit SHA and branch from GitHub Actions, GitLab CI, CircleCI, Buildkite, Jenkins, Azure Pipelines and Bitbucket Pipelines variables. Elsewhere pass --sha and --branch. It gzips the report before sending.

GitLab-style job

test:
  script:
    - npm ci
    - npm test -- --coverage
    - npx --yes coverbird upload --file coverage/lcov.info
  # COVERBIRD_TOKEN: add it as a masked CI/CD variable

Plain curl (no Node needed)

gzip -c coverage.xml | curl -fsS -X POST \
  "https://coverbird.netlify.app/api/upload?sha=$COMMIT_SHA&branch=$BRANCH" \
  -H "Authorization: Bearer $COVERBIRD_TOKEN" \
  -H "Content-Encoding: gzip" \
  --data-binary @-

sha must be the full 40-character commit SHA of the pull request head. Uploads on the default branch become the baseline for "change vs base". Supported formats: LCOV, Cobertura XML, JaCoCo XML and Go coverprofile (detected automatically; force one with format=lcov|cobertura|jacoco|go or --format).

Monorepos

npx --yes coverbird upload --file packages/web/coverage/lcov.info --path-prefix packages/web --flag web
npx --yes coverbird upload --file packages/api/coverage/lcov.info --path-prefix packages/api --flag api
# curl: add &pathPrefix=packages/web&flag=web to the URL

Troubleshooting

The check says "Waiting for coverage upload"

Coverbird has not received a report for the pull request's head commit. Check that the upload step ran and succeeded (it answers HTTP 202), that COVERBIRD_TOKEN is set for that job, and that the SHA sent is the head commit of the pull request. CI systems that test a temporary merge commit report a different SHA: pass the head commit explicitly with --sha. An upload that arrives before the pull request is opened is kept and used as soon as the pull request appears. The dashboard's event log shows every upload received.

403 on a mirrored repository

Repositories mirrored from GitHub are read-only for Origin apps, so Origin refuses Coverbird's checks and comments (403). Coverbird marks these repositories as mirrors and skips them. Use it on a native Origin repository.

Upload answers 402 or 403

402: the repository is paused by the plan limit. The Free plan covers 1 repository; switch the active repository off in the dashboard to free the slot, or upgrade to Pro for unlimited repositories. 403: the repository is switched off in the dashboard, no longer selected for the app in Origin, or the app was uninstalled.

Changing the threshold

In the dashboard, each repository has a diff threshold (default 80%) and an optional total threshold. The check fails when diff coverage, rounded to two decimals, is below the diff threshold, or total coverage is below the total threshold. A pull request that adds no executable lines passes. Use Re-run on the check in Origin to apply a new threshold to an open pull request.

Files show no coverage in a monorepo

If the report's paths are relative to a package directory, pass --path-prefix packages/<name>. If they carry an absolute CI workspace path that is not detected, pass --root with the checkout directory.

413 or 429 responses

413: the report is too large (10 MiB as sent, 20 MiB after decompression); gzip it (the CLI does by default). 429: more than 60 uploads in an hour for one token; wait for the time in the Retry-After header.

Uninstall

  1. Uninstall Coverbird in Origin where your workspace's installed apps are managed, or press Disconnect on the installation in the Coverbird dashboard (this removes the installation in Origin too).
  2. Coverbird then deletes that installation's repositories, upload tokens, pull request records, coverage reports and check results. See the privacy policy for what is kept.
  3. Remove the upload step and the COVERBIRD_TOKEN secret from your CI.
  4. If you are on Pro, cancel the subscription from the dashboard's billing page; uninstalling does not cancel it.

To delete your account entirely, email pratik.phodu@gmail.com.