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
- A Sauce Labs account (Log in or sign up for a free trial license)
- Your Sauce Labs Username and Access Key
- A GitHub Account
- The following permissions in GitHub:
- ability to create and manage workflows
- ability to create and store GitHub secrets
Create GitHub Secrets
The first order of business is to export your Sauce Labs account credentials and store them as GitHub Secrets.
Navigate to your project repository and select the settings icon.
Click the New secret button.
Add the following:
- Value: 'your-sauce-username'
Click Add secret to finish.
Repeat the same steps above for your
Configure the GitHub Action
In your root project directory, create the following directory tree:
.github/workflows. In the
workflows directory create a file called
Add the following to the top of your file:
env at the top of the file enables it globally in this workflow, so all jobs have access to these variables.
Create the Test Job
In the examples below, we illustrate the two different
saucectl run modes, which will determine where your tests will execute:
- Docker mode refers to executing tests locally in a container
- Sauce Cloud mode refers to executing tests on Sauce Cloud (i.e., Sauce Labs infrastructure)
- If you're testing on the Sauce Cloud, 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, please visit the GitHub Action documentation.
- Sauce Cloud
You can reference our example workflows here.
Now when you commit these files, GitHub will detect the new workflow actions and launch
saucectl to run your tests.
To see the output:
Log in to GitHub.
Navigate to your repository page.
Click on Actions.
Your output may look something like this: