Skip to main content

Run tests in CircleCI

Use a CircleCI job to run Qodex against staging for branches and production for main.

Before you start

You need:
  • A Qodex project with runnable scenarios.
  • A project API key from Settings > Platform > API keys.
  • A CircleCI project connected to your repository.

Add environment variables

In CircleCI, open Project Settings > Environment Variables.
  • QODEX_API_KEY: your qk_... key.
  • QODEX_PROJECT: your Qodex project slug.
Use a CircleCI context if multiple repositories should share the same Qodex secret.

Add the config

Save this file at .circleci/config.yml.

Gate the workflow

Make the Qodex job a required job before deploy steps. If your repository mirrors CircleCI checks back to GitHub, add the CircleCI check to branch protection.

Buildkite recipe

Generic shell recipe