https://github.com/steadybit/run-experiment

https://github.com/steadybit/run-experiment

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/steadybit/run-experiment
• Owner: steadybit
• Created: 2021-02-18T15:32:34.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-27T11:30:42.000Z (15 days ago)
• Last Synced: 2025-01-27T12:32:33.274Z (15 days ago)
• Language: JavaScript
• Size: 1.04 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Run Experiment action

Runs an experiment and checks the status of the experiment while executing

## Inputs

### `apiAccessToken`

**Required** Access Token to be used for accessing steadybit API.

### `baseURL`

Base URL of steadybit. Default`"https://platform.steadybit.io"`

### `experimentKey`

Key of the experiment to be executed. **Required** if you don't provide the `externalId` to lookup your experiment.

### `externalId`

External ID of the experiment to be executed. Alternative to lookup the experiment by `experimentKey`

### `expectedState`

The expected state of the experiment after attacks started to mark Action successful. Default`"COMPLETED"`

### `expectedFailureReason`

The expected failure reason of the experiment to mark Action successful. Default`""`

### `maxRetriesOnExpectationFailure`

An optional of retries to attempt when `expectedState` does not match the actual state. Default `"0"`.

### `delayBetweenRetriesOnExpectationFailure`

Number of milliseconds to wait between experiment executions when an experiment has to be retried due to expectation failures. Default `"60000"`.

## Outputs

None for now

## Example usage

```

- name: Run Experiment (EXPERIMENT-1)

uses: steadybit/run-experiment@v1

with:

  apiAccessToken: ${{ secrets.STEADYBIT_API_ACCESS_TOKEN }}

  experimentKey: 'EXPERIMENT-1'

```