Merge pull request #2 from scanapi/feat-implements-action

feat: Initial implementation

Author: camilamaia

Dockerfile

@@ -8,8 +8,6 @@ RUN pip install pip setuptools --upgrade
 
 RUN pip install scanapi
 
-COPY . /app
+ENTRYPOINT ["/entrypoint.sh"]
 
-WORKDIR /app
-
-CMD ["scanapi"]
+COPY entrypoint.sh /entrypoint.sh

README.md

@@ -0,0 +1,40 @@
+# scanapi
+An action that allows developers to run ScanAPI using github actions.
+
+## Inputs
+
+### `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/scanapi@v1
+  with:
+    arguments: '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:
+  Test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run automated API tests
+      uses: scanapi/scanapi@v1
+      with:
+        arguments: 'scanapi.yml' 
+```

action.yml

@@ -0,0 +1,16 @@
+name: 'Run ScanAPI action'
+author: '@scanapi'
+description: 'Allows any developer to run ScanAPI using github actions'
+branding:
+  icon: 'align-justify'
+  color: 'gray-dark'
+inputs:
+  arguments:
+    description: 'Desired arguments to run scanapi. Allow multiple parameters separated by spaces.'
+    required: true
+    default: '--help'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{ inputs.arguments }}

entrypoint.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -e
+
+scanapi "$@"