Introduction

Guides

Security

Access builds from GitHub commit statuses

Widgetbook Cloud links builds to GitHub commit statuses so accessing Widgetbook builds integrates seamingless with your GitHub workflow.

Widgetbook builds are accessed via commit statuses

Prerequisites

Linking builds to GitHub commit statuses requires API access to your GitHub repository. By connecting a Widgetbook project to a GitHub repository you allow Widgetbook Cloud to write commit statuses of your repository and add Widgetbook build links to commits. Once you've connected your project, build linking via commit statuses is automatically enabled.

Commit statuses are only created for new builds after the project is connected to a GitHub repository. If you've uploaded builds before connecting the project, commit statuses are not created for these builds.

How it works

  • Upload a build

    Upload a build as described in the upload build guide.

  • Navigate to your repository

    While the build processes or after the build finished successfully, navigate to your GitHub repository.

  • Locate the commit status

    Locate the commit status indicator for the commit. The commit status indicator is a green checkmark, a yellow dot, or a red cross next to the commit message.

  • Build commit status

    Locate the commit status called Widgetbook Build in the checks list and press the Details button.

  • Inspect the build

    Once you clicked the Details button, you are redirected to the build details page in Widgetbook Cloud.