Skip to content

FAQ

Still have a question about Shorebird CI that the docs didn’t cover? You’re in the right place. This page covers the most common questions. If you have a question not answered here or elsewhere in the docs, reach out on Discord or file an issue. The Shorebird team is happy to help.

Why should I use this rather then another solution?

Section titled “Why should I use this rather then another solution?”
  • Designed for Flutter & Dart - With this as our leading principal Shorebird CI has support for Flutter & Dart specific features. This includes automatic monorepo & workspace support, automatic parallelization across multiple package builds, and caching for all critical tooling for fast execution.
  • Zero config - Nothing to think about (or worry about keeping up to date). Shorebird CI just “does the right thing” for Flutter and Dart projects. (We expect we’ll eventually expose a small amount of configuration, but we’re intentionally starting maximally simple.)
  • Fast - On par with GitHub actions (and we know how to make it faster still). Quick boot ups, uses similar (if slightly larger) machine instances, uses namespace.so’s fancy caching mechanism, etc.

Checks typically complete in under a minute even with large repos, including monorepos. This is mostly due to caching of Dart & Flutter and automatic parallelization of packages. Shorebird will continue to invest in this over time as usage grows and the community’s needs around Dart-specific pipelines become clearer.

Shorebird CI starts with a few key checks based on internal needs and what other open source repos are doing. The Checks documentation will continue to be kept up to date with what’s currently available.

If you have a specific check that you are looking for please don’t hesitate to reach out — more checks are always being considered based on community needs.

What GitHub permissions does this require and why?

Section titled “What GitHub permissions does this require and why?”

In order to use Shorebird CI, its GitHub Application requires the following permissions

  • Read access to code, metadata, and pull requests - This allows the application to check out your codebase and run the necessary checks. All code is securely deleted after runs.
  • Read and write access to checks, commit statuses, and workflows - This allows the application to report back on the status checks that are running and display them in the GitHub UI.

Builds happen through Shorebird’s partnership with namespace.so. Namespace uses several custom datacenters throughout the world and you can read more about this in their Documentation Site and Trust Center.

In order to provide a complete service, some of your data needs to be retained.

  • Logs - The only data intentionally retained is your build logs, which are served from the CI section of the web console. Some minimal metadata is also maintained to associate a pull request/commit with a build log.
  • Source Code - A copy of your public source code is retained to speed up repeated builds. There is not currently an explicit retention time on this. Private repositories are currently under development and will have more stringent requirements.

How can I delete my data from the service?

Section titled “How can I delete my data from the service?”

You need to start by uninstalling the app on GitHub. After this no additional information or data will be sent to Shorebird CI.

Public log links are currently retained after an uninstall in order to not break links on existing PRs. If you require those to be deleted as well please reach out via email from the account owners address and it will be handled manually.