Skip to content

Commit c018071

Browse files
committed
Fix example of workflow
1 parent 89f1033 commit c018071

File tree

2 files changed

+21
-16
lines changed

2 files changed

+21
-16
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The following will take the yaml file and produce a scanapi-report.html file as
1313

1414
```yaml
1515
- name: Run automated API tests
16-
uses: scanapi/scanapi@v1
16+
uses: scanapi/github-action@v1
1717
with:
1818
arguments: 'scanapi.yaml'
1919
```
@@ -29,12 +29,17 @@ on:
2929
types: [opened, synchronize]:
3030

3131
jobs:
32-
Test:
32+
scanapi:
3333
runs-on: ubuntu-latest
3434
steps:
35-
- uses: actions/checkout@v2
36-
- name: Run automated API tests
37-
uses: scanapi/scanapi@v1
38-
with:
39-
args: 'scanapi.yml'
35+
- uses: actions/checkout@master
36+
- name: Run automated API tests
37+
uses: scanapi/github-action@v1
38+
with:
39+
arguments: "run ./scanapi.yaml"
40+
- name: Upload scanapi-report.html
41+
uses: actions/upload-artifact@v2
42+
with:
43+
name: ScanAPI Report
44+
path: scanapi-report.html
4045
```

action.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
name: 'ScanAPI'
2-
author: '@scanapi'
3-
description: 'Allows any developer to run ScanAPI using github actions'
1+
name: "ScanAPI"
2+
author: "@scanapi"
3+
description: "Allows any developer to run ScanAPI using github actions"
44
branding:
5-
icon: 'align-justify'
6-
color: 'gray-dark'
5+
icon: "align-justify"
6+
color: "gray-dark"
77
inputs:
88
arguments:
9-
description: 'Desired arguments to run ScanAPI. Allow multiple parameters separated by spaces.'
9+
description: "Desired arguments to run ScanAPI. Allow multiple parameters separated by spaces."
1010
required: true
11-
default: '--help'
11+
default: "--help"
1212
runs:
13-
using: 'docker'
14-
image: 'Dockerfile'
13+
using: "docker"
14+
image: "Dockerfile"
1515
args:
1616
- ${{ inputs.arguments }}

0 commit comments

Comments
 (0)