Skip to content

Commit

Permalink
Fix example of workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
camilamaia committed Sep 21, 2020
1 parent 89f1033 commit c018071
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 16 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The following will take the yaml file and produce a scanapi-report.html file as

```yaml
- name: Run automated API tests
uses: scanapi/scanapi@v1
uses: scanapi/github-action@v1
with:
arguments: 'scanapi.yaml'
```
Expand All @@ -29,12 +29,17 @@ on:
types: [opened, synchronize]:

jobs:
Test:
scanapi:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run automated API tests
uses: scanapi/scanapi@v1
with:
args: 'scanapi.yml'
- uses: actions/checkout@master
- 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
with:
name: ScanAPI Report
path: scanapi-report.html
```
18 changes: 9 additions & 9 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
name: 'ScanAPI'
author: '@scanapi'
description: 'Allows any developer to run ScanAPI using github actions'
name: "ScanAPI"
author: "@scanapi"
description: "Allows any developer to run ScanAPI using github actions"
branding:
icon: 'align-justify'
color: 'gray-dark'
icon: "align-justify"
color: "gray-dark"
inputs:
arguments:
description: 'Desired arguments to run ScanAPI. Allow multiple parameters separated by spaces.'
description: "Desired arguments to run ScanAPI. Allow multiple parameters separated by spaces."
required: true
default: '--help'
default: "--help"
runs:
using: 'docker'
image: 'Dockerfile'
using: "docker"
image: "Dockerfile"
args:
- ${{ inputs.arguments }}

0 comments on commit c018071

Please sign in to comment.