https://github.com/scanapi/github-action
Github Action for ScanAPI
https://github.com/scanapi/github-action
docker github-action hacktoberfest scanapi
Last synced: 10 months ago
JSON representation
Github Action for ScanAPI
- Host: GitHub
- URL: https://github.com/scanapi/github-action
- Owner: scanapi
- License: mit
- Created: 2020-04-21T17:11:55.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2021-05-11T22:31:45.000Z (over 4 years ago)
- Last Synced: 2024-05-19T17:49:02.643Z (over 1 year ago)
- Topics: docker, github-action, hacktoberfest, scanapi
- Language: Dockerfile
- Homepage: https://github.com/marketplace/actions/scanapi
- Size: 11.7 KB
- Stars: 11
- Watchers: 17
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# ScanaAPI
An action that allows developers to run ScanAPI using github actions.
## Inputs
### `scanapi_version`
The version of ScanAPI to install (default: latest).
### `arguments`
Desired arguments to run scanapi. Allow multiple parameters separated by spaces. Default value is `--help`
## Example usage
The following will take the yaml file and produce a scanapi-report.html file as output.
```yaml
- name: Run automated API tests
uses: scanapi/github-action@v1
with:
scanapi_version: '==2.0.0'
arguments: 'run ./scanapi.yaml'
```
## Example workflow
Complete example used in a workflow/yaml file. This produce a scanapi-report.html file as output.
```yaml
name: Run tests
on:
pull_request:
types: [opened, synchronize]:
jobs:
scanapi:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run automated API tests
uses: scanapi/github-action@v1
with:
arguments: "run ./scanapi.yaml"
- name: Upload scanapi-report.html
uses: actions/upload-artifact@v2
if: ${{ always() }}
with:
name: ScanAPI Report
path: scanapi-report.html
```