Status badges and the Sauce Labs browser matrix widget help you keep track of the status of your latest test runs. All you have to do is add either markdown or HTML code to your GitHub README or project site that references your Sauce Labs username and access key, and annotate your jobs with the REST or WebDriver API.
Status Badges and the Browser Matrix
There are three status badges that correspond to the three states of a finished test: Passing, Failed, and Unknown.
|Unknown - used for security reasons when a test doesn't have a status of Passing or Failed|
With the browser matrix, you can keep track of the test status of your project for various browser/platform/operating system combinations.
Setting Up Status Badges for Test Results
Copy this markdown code into your GitHub README.
Alternatively, you can use this HTML code on your project site.
Multiple Projects, Multiple Accounts
If you just have one project, you can use your main Sauce account name. If you have multiple projects, you will want to create a sub-account for each project.
Run your tests.
Make sure to set a build number, a pass/fail status, and a public, share, or public restricted visibility for every test that runs with the test configuration API.
You'll know that these are set correctly if your tests have a status of Pass or Failed instead of Finished on your dashboard, and that a build number is also displayed.
Setting Up the Browser Matrix Widget
Copy this markdown code into your project's GitHub README.
Alternatively, you can add this HTML to your project site.
Status Images for Private Accounts
If you want to display the build status of a private Sauce account, you need to provide a Hash-based Message Authentication Code (HMAC) token generated from your username and access key.
This example shows how to generate an HMAC token using Python:
Once you have the token, append it to the badge URL: