CLI Tool

qualflare-action (GitHub Action)

Full reference for the Qualflare GitHub Action — inputs, runner support, version pinning, and how it relates to the CLI.

qualflare-action

Qualflare/qualflare-action is a composite GitHub Action that wraps the qf CLI: it downloads the right qf binary for the runner, then runs the same qf login / qf collect two-step pattern documented in CI/CD Integration. It exists to remove the manual binary-download step from a GitHub Actions workflow — functionally, it's the CLI, not a separate upload mechanism.

Usage

- name: Run tests
  run: pytest --junitxml=results.xml
  continue-on-error: true   # let the upload step run even when tests fail

- name: Upload results to Qualflare
  uses: Qualflare/qualflare-action@v1
  with:
    token: ${{ secrets.QF_TOKEN }}
    project: myapp
    results: results.xml

continue-on-error: true on the step that runs your tests is required, not optional. GitHub Actions aborts the job on a failing step by default, which would skip the upload step entirely — exactly when you most want the failure analysis.

Inputs

InputRequiredDefaultDescription
tokenYesQualflare API token (qf_...). Store it as an encrypted secret, never inline.
projectYesYour Qualflare project identifier — the slug shown in the dashboard.
resultsYesPath or glob to your test result files (e.g. test-results/*.xml). Framework is auto-detected.
versionNolatestqualflare-cli version to install, e.g. 0.1.13.

Outputs

None. The action has no outputs: block — there's no steps.<id>.outputs.* value (such as a report URL) for a later step to consume.

Runner support

Linux and macOS (amd64/arm64) are fully supported. Windows runners are best-effort — if you're on Windows and hit issues, fall back to the manual CLI install.

What it doesn't expose

The action wraps only the two-step login/collect pattern with the four inputs above. Any qf collect flag beyond that — --environment, --milestone, --branch, --dry-run, and others — isn't reachable through the action. If you need one of those, install the CLI directly instead; see CI/CD Integration and Collect Command.

Version pinning

Qualflare/qualflare-action@v1 tracks the latest v1.x release of the action itself. The version input is separate — it pins which qualflare-cli release gets installed underneath, independent of the action's own version. Pin version explicitly in CI for reproducible builds; leave it on latest for local experimentation.