v5.1.1 - Update README

No functional changes, just update the README.

v5.1.0 Add Rainforest branching support

New features

The run job and run_qa command now support specifying which Rainforest branch to use when starting a run via the branch parameter.

v5.0.0 - Add automation_max_retries, remove crowd, update default token value

Breaking changes

token parameter default value changed ⚠️

The default value for the token parameter has changed from RAINFOREST_TOKEN to RAINFOREST_API_TOKEN. This is so that it matches the default value for the corresponding --token flag of the Rainforest CLI. If you are currently relying on the default value, then to upgrade without issues, you must make either one of these changes:

Explicitly set the token parameter

Add token: RAINFOREST_TOKEN when calling either the run job or the run_qa command.

Update your environment variables in CircleCI

Replace the RAINFOREST_TOKEN environment variable with a new RAINFOREST_API_TOKEN variable in your project settings.

crowd parameter removed

The crowd parameter for the run job and the run_qa command was deprecated in v4.1.0 and replaced with execution_method.

New features

The run job and run_qa command now support overriding a Run Group's Test Retries setting via the automation_max_retries parameter.

v4.1.0 - Add execution_method, deprecate crowd

Deprecations / Replacements

A new execution_method parameter replaces the now-deprecated crowd parameter for the run job and run_qa command. You may not use both parameters together. If neither parameter is set the run will use the Run Group's execution method.

What	Then	Now
Running tests using the Tester Community	crowd: default	execution_method: crowd
Running tests using the Automation Service	crowd: automation	execution_method: automation
Running automatable tests using the Automation Service and non-automatable tests using the Tester Community	crowd: automation_and_crowd	execution_method: automation_and_crowd
Running tests using your On-Prem testers	crowd: on_premise_crowd	execution_method: on_premise

v4.0.0 - Drop support for deprecated `conflict` options

Breaking changes

The deprecated abort and abort-all options for the conflict parameter are no longer supported. Use cancel or cancel-all instead. (#45)

v3.3.2 - Hotfix for properly rerunning from failed

Fixes

Rerunning from failed was broken by the v3.3.0 release yesterday. This release fixes that.

v3.3.1 - Support storing results for separate runs separately

⚠️ Rerunning from failed is broken in this release. Please use v3.3.2 or newer.

---

Fixes

• Support storing separate results when calling the run job or run_qa command multiple times in a single workflow. Pass in the new junit_path parameter to any extra calls to ensure that each call has its results properly stored:

workflows:
  your_workflow:
    jobs:
      - rainforest/run:
        # ...
      - rainforest/run:
        # ...
        junit_path: "rainforest-second-run"

v3.3.0 - Support multiple run calls in a single workflow

⚠️ Rerunning from failed is broken in this release. Please use v3.3.2 or newer.

---

Fixes

• Support calling the run job multiple times in a single workflow. Pass in the new cache_key parameter to any extra calls to ensure that each call properly triggers a Rainforest run:

workflows:
  your_workflow:
    jobs:
      - rainforest/run:
        # ...
      - rainforest/run:
        # ...
        cache_key: "rainforest-second-run-{{ .Revision }}"

v3.2.0 - Support new conflict parameter options

Fixes

• Support the new cancel and cancel-all options for the conflict parameter

Deprecations

• The abort and abort-all options for the conflict parameter are now deprecated. Use cancel or cancel-all instead.

v3.1.1 - Run tests against a specific URL - FIXED

Bugfixes

• Properly pass the custom_url parameter to the CLI when it is set (#39, fixed by #40)