TestOps logo
Try TestOps

Release information

Launches can carry a release identifier — a version number, branch name, or any delivery marker — that becomes available for filtering, comparison, and dashboards. The value is supplied from CI through an environment variable mapped at the project level.

In the examples below, the CI variable is named RELEASE, but the name can be different in your environment.

How to set it up

The setup has four parts:

  1. Add an environment variable on a CI pipeline level.
  2. Declare the corresponding Environment variable in Allure TestOps.
  3. Map the CI variable to the Allure TestOps environment variable at project level.
  4. Run the pipeline and verify that the launch now shows the release value.

1. Add the variable in CI

  1. Open your Jenkins job → Configure.
  2. Scroll to This project is parameterized:
    1. Select Add Parameter and use String Parameter.
    2. Set Name as RELEASE.
    3. Save the pipeline config.

Adding a build parameter

This makes RELEASE available to the job as an environment variable.

For the Jenkins-side setup details, see Jenkins.

  1. In your GitHub repository go to .github/workflows/ then open the target workflow's YAML file.
  2. Add the RELEASE item to the input section.
  3. Map RELEASE input to the RELEASE environment variable in the env section (see the screenshot).
  4. Commit the changes.

Adding an environment variable in GitHub

This makes RELEASE available to the job as an environment variable.

For the GitHub-side workflow setup details, see GitHub.

  1. Open your GitLab Project → Build → Pipeline editor.
  2. Add the RELEASE variable in the variables section (see the screenshot).
  3. Click Commit changes to save.

Adding an environment variable in GitLab

This makes RELEASE available to the job as an environment variable.

For the GitLab-side pipeline setup details, see GitLab.

2. Declare the environment variable in Allure TestOps

You need to be Allure TestOps administrator.

  1. Go to Administration > Environment settings.
  2. Click Add variable.
  3. Name it Release (any name works).
  4. Save it.

Creating the variable in Allure TestOps

3. Map the CI variable in the project

  1. In your project go to Settings → Environment.
  2. Click Create mapping and set the following:
    • Mapping key: RELEASE (the variable name as received from the pipeline).
    • Environment variable: the Release variable created in step 2.
  3. Save the mapping.

Mapping environment variables in project settings

4. Run the pipeline and verify the launch

Trigger your CI pipeline and set the value of RELEASE to the release identifier being tested.

Run the pipeline

Open Launches and check the launch created by the pipeline run. The Environment field shows Release: X.Y.Z.

Launch with release information

You can now filter launches by release:

Filtering launches by release

And compare launches from different releases:

Choosing launches for comparison

Comparing launches

Use release information in dashboards

In the Dashboards section, create a widget and configure it with AQL to scope it to a specific release.

Dashboard with release data

For dashboard setup, see Dashboards.

Caveats

  • The variable must exist both in CI and in the Allure TestOps environment mapping, otherwise the release value will not appear in the launch.
  • Release information is most useful when the naming stays consistent across pipelines and projects.

Next steps

© Qameta Software Inc. All rights reserved.