|
1 |
| -# upload-run-inputs-executable-action |
| 1 | +# Notify QA Wolf on Deploy |
| 2 | + |
| 3 | +## Introduction |
| 4 | + |
| 5 | +This action uploads a executable file to be used in a test workflow. this action uses [the `@qawolf/ci-sdk` |
| 6 | +package](https://www.npmjs.com/package/@qawolf/ci-sdk). |
| 7 | + |
| 8 | +### `qawolf-api-key` |
| 9 | + |
| 10 | +**Required**. The QA Wolf API key, which you can find on the application's team settings page. |
| 11 | + |
| 12 | +### `input-file-path` |
| 13 | + |
| 14 | +**Required**. The path to the file to be uploaded. Must exist at this location on the file system. |
| 15 | + |
| 16 | +## Outputs |
| 17 | + |
| 18 | +### `destination-file-path` |
| 19 | + |
| 20 | +The location the file will be available at in the playground's file system. |
| 21 | + |
| 22 | +### Usage Example |
| 23 | + |
| 24 | +```yml |
| 25 | +name: Upload Run Input File |
| 26 | +on: workflow_dispatch: |
| 27 | +jobs: |
| 28 | + upload-input-file: |
| 29 | + runs-on: ubuntu-latest |
| 30 | + steps: |
| 31 | + .... |
| 32 | + - name: Upload Run Input |
| 33 | + uses: qawolf/upload-run-inputs-executable-action@v1 |
| 34 | + with: |
| 35 | + qawolf-api-key: "${{ secrets.QAWOLF_API_KEY }}" |
| 36 | + input-file-path: "path/to/file.apk" |
| 37 | + .... |
| 38 | +``` |
| 39 | + |
| 40 | +### Usage within in a Trigger Workflow |
| 41 | + |
| 42 | +The `qawolf/upload-run-inputs-executable-action` will output `destination-file-path` with the location the file will be available at in the playground's file system. To use this in a test workflow you can add this value as a `RUN_INPUT_PATH` environmental variable in the `qawolf/notify-qawolf-on-deploy-action@v1` action. |
| 43 | + |
| 44 | +For official documentation on Triggering test runs refer to [Trigger test runs on deployment](https://qawolf.notion.site/Triggering-test-runs-on-deployment-0f12fb5260de4362a5ebe33d8a2f9538) |
| 45 | + |
| 46 | +Official documentation for the Notify QA Wolf on Deploy Action is located at [Notify QA Wolf on Deploy Action] (https://github.com/marketplace/actions/notify-qa-wolf-on-deploy) |
| 47 | + |
| 48 | +```yml |
| 49 | +name: Deploy and Notify QA Wolf |
| 50 | +on: pull_request |
| 51 | +jobs: |
| 52 | + ... |
| 53 | + notify: |
| 54 | + needs: deploy-preview-environmnent |
| 55 | + name: Trigger QA Wolf PR testing |
| 56 | + runs-on: ubuntu-latest |
| 57 | + steps: |
| 58 | + ... |
| 59 | + # Upload the run input file |
| 60 | + - name: Upload Run Input |
| 61 | + id: upload-run-inputs-executable |
| 62 | + uses: qawolf/upload-run-inputs-executable-action@v1 |
| 63 | + with: |
| 64 | + qawolf-api-key: "${{ secrets.QAWOLF_API_KEY }}" |
| 65 | + input-file-path: "path/to/file.apk" |
| 66 | + - name: Notify QA Wolf of deployment |
| 67 | + uses: qawolf/notify-qawolf-on-deploy-action@v1 |
| 68 | + env: |
| 69 | + ... |
| 70 | + # Use the output in the RUN_INPUT_PATH environmental variable |
| 71 | + RUN_INPUT_PATH: "${{ steps.upload-run-inputs-executable.outputs.destination-file-path }}" |
| 72 | + ... |
| 73 | + with: ... |
| 74 | +``` |
0 commit comments