diff --git a/README.md b/README.md index fbf3224..2f6270d 100644 --- a/README.md +++ b/README.md @@ -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' ``` @@ -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 ``` diff --git a/action.yml b/action.yml index c4a91c2..bc7b9cd 100644 --- a/action.yml +++ b/action.yml @@ -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 }}