Widgetbook Cloud Builds

When you create a new commit in Git, a new version of your code is created. With Widgetbook Builds developers can host a Widgetbook for a Git commit and make it easily accessible for the whole team on Widgetbook Cloud. If set up with CI/CD, you can have a build for each commit, for each pull-request and for each branch.

Tutorial video

Pushing a new build

To create a Widgetbook Build, follow these steps inside your Widgetbook project:

1. Run widgetbook_generator to generate metadata about your use-cases and components

   dart run build_runner build -d
   

2. Build the Widgetbook for the web

   # Default target (i.e. `lib/main.dart`)
   flutter build web
   
   # Custom target
   flutter build web -t lib/main.widgetbook.dart
   

3. Install the Widgetbook CLI

   dart pub global activate widgetbook_cli
   

4. Get your API key from the Widgetbook Cloud's project settings page.

5. Push the build to Widgetbook Cloud

   widgetbook cloud build push --api-key PROJECT_API_KEY