GitHub Action
Setup mabl CLI
GitHub action to configure the
the mabl-cli
command-line client. It
installs and configures the CLI with a mabl API key, if one is provided. Note
that API keys should be stored as GitHub secrets.
This action requires Node.js 10+ be installed as part of your workflow.
The mabl-cli will be installed into that Node.js runtime.
See below for an example of how to install Node.js.
version
{string} {optional} The version of the CLI to install. Defaults to the latest version if not specified.workspace-id
{string} {optional} A workspace id to configure. If provided, all future calls to the CLI will use this workspace by default.
-
MABL_API_KEY
{string} {optional} If provided, this action will authenticate with the mabl CLI using theMABL_API_KEY
. This is required if you also pass in aworkspace-id
.The
MABL_API_KEY
should be stored as a GitHub secret and passed as in the example below. Never store yourMABL_API_KEY
as plain text in your workflow YAML.
- Requires Node.js 10+ be installed as a prior step. This is most easily done with
the
actions/setup-node@v2
action.
on: [push]
name: mabl
jobs:
test:
name: Mabl Tests
runs-on: ubuntu-latest
steps:
- uses: actions/setup-node@v2
with:
node-version: '12.x'
- uses: mablhq/setup-mabl-cli@v1
with:
version: 1.2.32
workspace-id: V2pvHBJ-rprn1n3S4ELs3A-w
env:
MABL_API_KEY: ${{ secrets.MABL_API_KEY }}
- name: Download screenshots for test
run: mabl test-runs export ar5vXBJ-rpan1nSs445s3A-jr -f screenshots.zip
- name: Upload screenshots
uses: actions/upload-artifact@v2
with:
name: screenshots
path: screenshots.zip
See here for details on contributing to this action.
The Dockerfile and associated scripts and documentation in this project are released under the MIT License.