https://github.com/rapidapi/gh-api-testing-trigger
Trigger a RapidAPI Testing Test Execution via Github Actions
https://github.com/rapidapi/gh-api-testing-trigger
Last synced: 3 months ago
JSON representation
Trigger a RapidAPI Testing Test Execution via Github Actions
- Host: GitHub
- URL: https://github.com/rapidapi/gh-api-testing-trigger
- Owner: RapidAPI
- Created: 2020-10-13T00:24:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-27T15:30:20.000Z (almost 3 years ago)
- Last Synced: 2025-04-24T12:07:15.368Z (10 months ago)
- Language: JavaScript
- Size: 1.21 MB
- Stars: 26
- Watchers: 5
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RapidAPI Testing GitHub Actions
This GitHub Action allows you to trigger the execution of [RapidAPI Testing](https://rapidapi.com/testing) tests. This is especially useful
during CI/CD to ensure new deployments are functioning as expected.
## Complete example
```yaml
on: [push]
jobs:
run_api_test:
runs-on: ubuntu-latest
name: Execute RapidAPI API Tests
steps:
- name: Execute Tests
id: tstExec
uses: RapidAPI/gh-api-testing-trigger@v0.0.3
with:
test: 'YOUR_TEST_ID'
location: 'AWS-US-WEST-2'
environment: 'ENV_ID(OPTIONAL)'
- name: Show Results
run: echo "The test took ${{ steps.tstExec.outputs.time }}ms to run"; echo "The test result was ${{ steps.tstExec.outputs.computedStatus }}"; echo "View Report - ${{ steps.tstExec.outputs.reportUrl }}"
```
## Inputs
### `test`
**Required** The ID of the test you wish to execute.
### `location`
**Required** The location the test will be executed in. Options:
- `AWS-US-EAST-1` : N. Virginia
- `AWS-US-WEST-2` : Oregon
- `AWS-AP-EAST-1` : Hong Kong
- `AWS-AP-SOUTH-1` : Mumbai
- `AWS-AP-SOUTHEAST-1` : Singapore
- `AWS-AP-NORTHEAST-1` : Tokyo
- `AWS-EU-CENTRAL-1` : Frankfurt
- `AWS-EU-WEST-3` : Paris
- `AWS-SA-EAST-1` : São Paulo
### `environment`
The environment you want to run the test in. If you don't use environment omit this parameter
### `tenant`
The tenant to run the test against. Defaults to the public Hub `rapidapi.com`. For example for an enterprise
it may be `tenant: ${ENTERPRISE_DOMAIN}.hub.rapidapi.com`. Likewise, for different regions:
```yaml
US: https://acme.hub.rapidapi.com
CA: https://acme.hub-ca.rapidapi.com
EU: https://acme.hub-eu.rapidapi.com
```
With `acme` being a mock domain used as an example.
## Outputs
### `time`
The time it took the test to execute, in milliseconds (1000ms=s)
### `successful`
True/false based on the result of the test execution
### `reportUrl`
URL of a human-readable report of the test execution
### `computedStatus`
A human-readable test status that matches the status values on the test dashboard in the UI
## Help
For any help using this integration, reach out to `support@rapidapi.com`. You can also see RapidAPI Testing Guide in our [Help Center](https://docs.rapidapi.com/docs/creating-test-flows).