Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/content/docs/account/api-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export SHOREBIRD_TOKEN="<your-api-key>"
shorebird patch android
```

For platform-specific setup, see our CI guides for
For platform-specific setup, see the CI guides for
[GitHub Actions](/code-push/ci/github/), [Codemagic](/code-push/ci/codemagic/),
or the [generic CI guide](/code-push/ci/generic/).

Expand Down Expand Up @@ -73,8 +73,8 @@ action cannot be undone.
## Migrating from `shorebird login:ci`

The `shorebird login:ci` command is deprecated. Existing tokens generated by
`login:ci` will continue to work until September 2026, but we recommend
replacing them with API keys created from the console.
`login:ci` will continue to work until September 2026, but replacing them with
API keys created from the console is recommended.

To migrate:

Expand Down
28 changes: 14 additions & 14 deletions src/content/docs/account/billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ import viewBillingPortal from '~/assets/view_billing_portal.png';
import accountMonthlySpendingLimit from '~/assets/account_monthly_spending_limit.png';
import setSpendingLimitDialog from '~/assets/set_spending_limit_dialog.png';

We believe billing should never be a blocker to using our tools. We aim to meet
our customers where they are, whether that means flexible payment methods,
enterprise invoicing, or custom terms. If you’re building with Flutter, we want
to make it as easy as possible to build with Shorebird too.
Billing should never be a blocker to using Shorebird's tools. Customers are met
where they are, whether that means flexible payment methods, enterprise
invoicing, or custom terms. If you’re building with Flutter, building with
Shorebird should be just as easy.

## Payment provider - Stripe

Shorebird uses Stripe for all billing and payments. We accept any payment method
that Stripe supports. You can view more details in
Shorebird uses Stripe for all billing and payments, and accepts any payment
method that Stripe supports. You can view more details in
[Stripe's Supported Payment Methods documentation](https://docs.stripe.com/payments/payment-methods/overview).

### Billing email
Expand All @@ -42,15 +42,15 @@ which is where invoices are sent.

## Available plans

We provide flexible options to accommodate every team and product, whether it's
an indie/hobby project or a globally launched enterprise application. See our
[pricing page](https://shorebird.dev/pricing) for more information.
Flexible options are provided to accommodate every team and product, whether
it's an indie/hobby project or a globally launched enterprise application. See
the [pricing page](https://shorebird.dev/pricing) for more information.

Most customers can easily get started with our self-service Pro and Business
Most customers can easily get started with the self-service Pro and Business
plans. If you need invoice billing, tax support, alternative payment methods,
custom contract/procurement process, or support for more than 2.5 million
patches per month, please
[reach out to us regarding an Enterprise Plan](https://shorebird.dev/talk-to-sales).
[reach out regarding an Enterprise Plan](https://shorebird.dev/talk-to-sales).

### Organizations & billing

Expand Down Expand Up @@ -79,13 +79,13 @@ Console. These numbers are updated hourly.

### Overage billing

For our monthly plans, we offer optional overage billing. This is turned off by
For monthly plans, optional overage billing is available. This is turned off by
default.

Customers can control their spending limits in the
[Shorebird Console](https://console.shorebird.dev). Your spending limit defaults
to the price of your plan. We'll notify you via email once when you’re close to
your limit, and again when you’ve reached your limit.
to the price of your plan. You'll be notified via email once when you’re close
to your limit, and again when you’ve reached your limit.
Comment on lines +87 to +88

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should mention here that the account owner will be notified. As we have seen people reaching out that they haven't got emails as account owner is generic email

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
to the price of your plan. You'll be notified via email once when you’re close
to your limit, and again when you’ve reached your limit.
to the price of your plan. The account owner be notified via email once when you’re close
to your limit, and again when you’ve reached your limit.


<Image
src={accountMonthlySpendingLimit}
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/account/orgs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ via the account settings page in the
[Shorebird console](https://console.shorebird.dev/account).

If you do not see the plan you're expecting, please reach out to
contact@shorebird.dev, and we'd be happy to help you.
contact@shorebird.dev for help.

## Creating an organization

Expand Down
3 changes: 1 addition & 2 deletions src/content/docs/ci/checks/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ for migration options.
:::

Shorebird CI contains a number of checks built into the system. With each run
all of our checks are automatically ran with no need for setup from you or your
team.
all checks are automatically ran with no need for setup from you or your team.

For details on each check please view the detail pages.
52 changes: 26 additions & 26 deletions src/content/docs/ci/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ for migration options.

:::

Still have a question about Shorebird CI that our docs didn’t cover? You’re in
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. We’re here to help.
file an issue. The Shorebird team is happy to help.

## Product overview

Expand All @@ -44,57 +44,57 @@ CodeMagic, fastlane, etc.) but rather to supplement them.

### How fast is it?

Our checks typically complete in under a minute even with large repos, including
monorepos. This is mostly due to our caching of Dart & Flutter and automatic
parallelization of packages. We will continue to invest in this over time as we
see more usage and understand the communities needs when it comes to Dart
specific pipelines.
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.

### What checks are supported?

We are starting with a few key ones that we see our own need for and what other
open source repo's are doing. We will continue to keep our [Checks](/ci/checks/)
documentation up to date with what we currently have available.
Shorebird CI starts with a few key checks based on internal needs and what other
open source repos are doing. The [Checks](/ci/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. We are always looking to implement more based on community needs.
reach out — more checks are always being considered based on community needs.

## GitHub Integration

### What GitHub permissions does this require and why?

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

- **Read access to code, metadata, and pull requests** - This allows for our
application to checkout your codebase and run the necessary checks. All code
- **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 for our application to report back on the status checks that are
running and display them in the GitHub UI.
allows the application to report back on the status checks that are running
and display them in the GitHub UI.

## Data privacy

### Where do builds happen?

Builds are happening through our partnership with namespace.so. Namespace uses
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](https://namespace.so/docs) and
[Trust Center](https://trust.namespace.so).

### What data do you retain?

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

- **Logs** - The only data we intentionally retain is your build logs, which are
- **Logs** - The only data intentionally retained is your build logs, which are
served from
[the CI section of our web console](https://console.shorebird.dev/ci/). We
also maintain some minimal metadata to associate a pull request/commit with a
[the CI section of the web console](https://console.shorebird.dev/ci/). Some
minimal metadata is also maintained to associate a pull request/commit with a
build log.
- Our build provider [Namespace](https://namespace.so), also does retain logs
in accordance with their [Terms of Use](https://namespace.so/terms).
- **Source Code** - We retain a copy of your public source code to speed up
repeated builds. We do not currently have an explicit retention time on this.
- Shorebird's build provider [Namespace](https://namespace.so) also retains
logs in accordance with their [Terms of Use](https://namespace.so/terms).
- **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.

Expand All @@ -105,6 +105,6 @@ 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 to us
out
[via email](mailto:contact@shorebird.dev?subject=CI%20Data%20Delete%20Request)
from the account owners address and it will be handled manually.
4 changes: 2 additions & 2 deletions src/content/docs/ci/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ for migration options.
Zero-config, production-grade continuous integration for Flutter & Dart.

Shorebird CI automatically runs best practice Flutter & Dart checks on every
pull request. We built it for ourselves and use it in all our repos, and now you
can too.
pull request. The Shorebird team built it for themselves and uses it in all of
Shorebird's repos, and now you can too.

- ✨ Set up takes less than a minute
- 🚀 Fast Checks
Expand Down
36 changes: 18 additions & 18 deletions src/content/docs/code-push/ci/codemagic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@ distributed.

:::note

We will be setting up our workflow using the Codemagic YAML file. The Workflow
Editor is not supported, as it does not allow us to change the build command.
This workflow uses the Codemagic YAML file. The Workflow Editor is not
supported, as it does not allow changing the build command.

If you don't know how to use the Codemagic YAML, please refer to the
[Codemagic YAML documentation](https://docs.codemagic.io/yaml-basic-configuration/yaml-getting-started/).

:::

As a preview, our finished `codemagic.yaml` file will look like this:
As a preview, the finished `codemagic.yaml` file will look like this:

```yaml
definitions:
Expand Down Expand Up @@ -146,15 +146,15 @@ workflows:

You can follow the Codemagic guide
[here](https://docs.codemagic.io/yaml-code-signing/signing-android/#google-play-store-credentials)
to set this up. We put the `GCLOUD_SERVICE_ACCOUNT_CREDENTIALS` variable in a
group named `play_store`.
to set this up. This example places the `GCLOUD_SERVICE_ACCOUNT_CREDENTIALS`
variable in a group named `play_store`.

#### Set up your Android keystore in Codemagic

You can follow the Codemagic guide
[here](https://docs.codemagic.io/yaml-code-signing/signing-android/) to create a
keystore and upload it to Codemagic. We used `android_keystore` as the name of
the uploaded keystore.
keystore and upload it to Codemagic. This example uses `android_keystore` as the
name of the uploaded keystore.

You will also also need to update your `android/app/build.gradle` file to use
this keystore in the Codemagic CI environment:
Expand All @@ -179,7 +179,7 @@ signingConfigs {

### Create shared configuration

At the top of our `codemagic.yaml` file, define shared environment variables and
At the top of the `codemagic.yaml` file, define shared environment variables and
scripts that will be used by multiple workflows. This has been annotated to
explain what each part does.

Expand Down Expand Up @@ -303,8 +303,8 @@ distributed.

:::note

We will be setting up our workflow using the Codemagic YAML file. The Workflow
Editor is not supported, as it does not allow us to change the build command.
This workflow uses the Codemagic YAML file. The Workflow Editor is not
supported, as it does not allow changing the build command.

If you don't know how to use the Codemagic YAML, please refer to the
[Codemagic YAML documentation](https://docs.codemagic.io/yaml-basic-configuration/yaml-getting-started/).
Expand Down Expand Up @@ -337,11 +337,11 @@ support this:
of this file into Codemagic. `cat ios_distribution_private_key | pbcopy` works
well for this.

We put all of these variables into a group named `app_store`.
This example places all of these variables into a group named `app_store`.

### Create a shared configuration

At the top of our `codemagic.yaml` file, define shared environment variables and
At the top of the `codemagic.yaml` file, define shared environment variables and
scripts that will be used by multiple workflows. This has been annotated to
explain what each part does.

Expand Down Expand Up @@ -406,8 +406,8 @@ definitions:
keychain add-certificates
- &use_profiles
# This generates an export_options.plist file that tells Xcode
# how to package our app. We explicitly set
# manageAppVersionAndBuildNumber so that we can control which
# how to package the app. This explicitly sets
# manageAppVersionAndBuildNumber to control which
# version and build number are used for releasing and patching.
name: Set up code signing settings on Xcode project
script: |
Expand All @@ -430,11 +430,11 @@ workflows:
# This needs to run on a Mac instance.
instance_type: mac_mini_m1
integrations:
# "Codemagic" is the name of our App Store Connect API key name.
# "Codemagic" is the name of the App Store Connect API key.
app_store_connect: Codemagic
environment:
<<: *shared_env
# Tell Codemagic that we're signing our app for App Store distribution
# Tell Codemagic that this app is being signed for App Store distribution
# and to use the bundle ID we defined above.
ios_signing:
distribution_type: app_store
Expand Down Expand Up @@ -481,8 +481,8 @@ workflows:
instance_type: mac_mini_m1
environment:
<<: *shared_env
# Tell Codemagic that we're signing our app for App Store distribution
# and to use the bundle ID we defined above.
# Tell Codemagic that this app is being signed for App Store distribution
# and to use the bundle ID defined above.
ios_signing:
distribution_type: app_store
bundle_identifier: '$BUNDLE_ID'
Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/code-push/ci/fastlane.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ This section assumes that you are using fastlane on CI to release your app. If
you are running fastlane locally (on your development machine), you can skip to
the [Using fastlane locally](#using-fastlane-locally).

A working example of this setup can be found in our
A working example of this setup can be found in the
[fastlane_demo](https://github.com/shorebirdtech/fastlane_demo) repository.

To get started, follow
[this guide](https://medium.com/revelo-tech/setting-up-automatic-ios-release-with-fastlane-and-match-on-ci-cd-server-16c3f1d79bc5)
to set up fastlane with certificate management, code signing, and submitting to
the App Store/TestFlight.

You will notice that our demo app's
Notice that the demo app's
[`Fastfile`](https://github.com/shorebirdtech/fastlane_demo/blob/main/ios/fastlane/Fastfile)
has both `deploy` and `release_shorebird` lanes. The `deploy` lane comes from
the guide linked to above. The `release_shorebird` lane is our custom lane that
the guide linked to above. The `release_shorebird` lane is a custom lane that
uses the `shorebird_release` action **in place of** `build_app` to build an ipa,
create a Shorebird release, and submit it to the App Store/TestFlight.

Expand All @@ -59,8 +59,8 @@ installed Shorebird, you can do so by following the

If you are not already using fastlane with your project, navigate to your app's
`ios` directory in your project and run `fastlane init`. You will be prompted to
answer several questions. For this guide, we will choose to manually add lanes
to the `Fastfile`.
answer several questions. For this guide, choose to manually add lanes to the
`Fastfile`.

### Use the Shorebird plugin

Expand Down
Loading
Loading