1
Get API Key
Go to the settings page on the Web UI to get your API key.
2
Add to CI / CD
If you use GitHub
If you use GitHub
- Create a secret for your API Key: Go to your GitHub repository, click on “Settings” > “Secrets and variables” > “Actions”. Then create a new Repository Secret named
STABLY_API_KEY
and paste your API Key into the secret value. - From a test suite’s page, click on the
Add to CI
button to get the code snippet that contains the test suite ID. - After copying the code snippet, create the file
.github/workflows/stably.yaml
in your GitHub repository and paste the code snippet there.
Testing your Pull Requests
Considering you already have a Test Suite to test a live environment, you can reuse that same test suite to run your Pull Request checks. For this, you must use theurl-replacement
option:Adding notes to test suite runs
When running multiple test suites concurrently, it can be challenging to identify and track specific test runs. To improve test run identification and organization, you can now attach descriptive notes to test suite runs executed via GitHub Actions using thenote
parameter.This feature allows you to:- Distinguish between concurrent test runs
- Add contextual information to test executions
- Improve test result tracking and analysis
If you use other CI / CD
If you use other CI / CD
The Stably API enables you to execute test suites programmatically. To authenticate and run tests, you’ll need two required information:
- A Stably API key for authentication (it must be a team API Key)
- A test suite ID that specifies which tests to run
curl
command: