Skip to main content

saucectl with GitHub Actions

These examples can apply to virtually any GitHub deployment, provided that you already have some existing automated tests, and are either the maintainer or an admin of the target repository.

What You'll Need

Create GitHub Secrets

  1. Export your Sauce Labs account credentials and store them as GitHub Secrets.

  2. Follow the GitHub Docs to create the secrets for your repository, and add the following:

    Your Sauce Username:

    • Value: 'your-sauce-username'

    Your Sauce Access Key:

    • Value: 'your-sauce-access-key'

Configure the GitHub Action

In your root project directory, create the following directory tree: .github/workflows. In the workflows directory create a file called actions.yml.

Add the following to the top of your file:


Setting env at the top of the file enables it globally in this workflow, so all jobs have access to these variables.

GITHUB_TOKEN: ${{ github.token }}

See full example on GitHub

Create the Test Job

In the examples below, we illustrate how saucectl executes tests on Sauce Cloud (i.e., Sauce Labs infrastructure). You will likely require a tunnel back to where your app is running. A tunnel enables the remote browser to access your local network. For this, you'll need to use Sauce Connect.


For more detailed information on setting event-driven actions and jobs, visit the GitHub Action documentation.

runs-on: ubuntu-latest
- name: Checkout
uses: actions/checkout@v4

- name: Saucectl RUN
uses: saucelabs/saucectl-run-action@v4
working-directory: v1

See full example on GitHub


You can reference our example workflows in the saucectl Cypress example repository.

Now when you commit these files, GitHub will detect the new workflow actions and launch saucectl to run your tests.

To see the output:

  1. Log in to GitHub.

  2. Navigate to your repository page.

  3. Click Actions.

    GitHub Actions

Your output may look something like this:

GitHub Workflow