Skip to content
Shorebird

Setup

Configuring Shorebird CI takes less than a minute and requires zero code changes.

  1. From the Web Console select CI from the navigation panel. Screenshot of the Shorebird Web Console showing the CI item in the navigation panel.
  2. Sign in with your GitHub account. Screenshot of the Shorebird Web Console prompting the user to login with their GitHub account.
  3. Install the Shorebird CI GitHub app on the desired GitHub organizations/repositories. Screenshot of the Shorebird Web Console asking to install the Shorebird CI GitHub Application.
  4. Confirm the installation for the desired organizations/repositories. Screenshot of the Shorebird CI GitHub Application install configuration.
  5. Refresh the Web Console and enable the Shorebird CI service for the desired GitHub organizations. Screenshot of the the Shorebird Web Console enabling the Shorebird CI service for a specific organization. Screenshot of the the Shorebird Web Console showing the Shorebird CI service enabled for a specific organization.

Running Shorebird CI

Section titled “Running Shorebird CI”

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

To see more details from these checks you can view the logs for the run