Skip to content

Setup

Getting setup and running with Shorebird CI is quick and easy.

  1. Go to the Shorebird CI GitHub Application in the GitHub Marketplace.

    Screenshot of the Shorebird CI GitHub Marketplace listing.
  2. Click the “Install” button

  3. Confirm the install and setup the correct permissions

    • We recommend choosing specific repositories, unless all your repos are Flutter/Dart. Screenshot of the Shorebird CI GitHub App install configuration

When you open a pull request, or push a new commit to an existing pull request, Shorebird CI will automatically run for you. It will detect if there are any Dart or Flutter packages and automatically starts running the available checks.

Screenshot of the Shorebird CI GitHub App checks passing during a pull request