Skip to content
Merged
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 @@ -11,7 +11,7 @@ API keys let you authenticate with Shorebird from CI systems and other automated
environments. You can create, view, and revoke API keys from the
[Shorebird Console](https://console.shorebird.dev).

## Creating an API Key
## Creating an API key

1. Open **Account → API Keys** in the console.
2. Click **Create API Key**.
Expand All @@ -28,7 +28,7 @@ securely — it cannot be retrieved again.
title="Create Shorebird API Key"
/>

## Using an API Key
## Using an API key

Set the key as the `SHOREBIRD_TOKEN` environment variable in your CI platform.
Shorebird CLI commands will authenticate automatically when this variable is
Expand Down Expand Up @@ -64,7 +64,7 @@ API keys support two permission levels:
manage apps, organizations, members, or billing. Available on Pro and Business
plans.

## Revoking an API Key
## Revoking an API key

To revoke a key, find it in the API Keys list and click **Delete**. Revocation
is immediate — any CI pipeline using that key will fail on its next run. This
Expand Down
12 changes: 6 additions & 6 deletions src/content/docs/account/billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ 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.

## Payment Provider - Stripe
## 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
[Stripe's Supported Payment Methods documentation](https://docs.stripe.com/payments/payment-methods/overview).

### Billing Email
### Billing email

Invoices are sent at the end of each billing period by Stripe. Since they are
sent by Stripe, they do not use your Shorebird account email, but rather the
Expand All @@ -40,7 +40,7 @@ log in, you can change this in Stripe:
This will open Stripe's billing portal, where you can update your Stripe email,
which is where invoices are sent.

## Available Plans
## 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
Expand All @@ -52,7 +52,7 @@ 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).

### Organizations & Billing
### Organizations & billing

Billing is tied to the **organization's owner's account**, not to individual
organizations. When you create an organization, it inherits its plan from your
Expand All @@ -62,7 +62,7 @@ each organization will share the owner's plan.
For more information on how organizations and ownership work, see
[Organizations](/account/orgs#billing--ownership).

## How We Bill
## How we bill

Shorebird charges based on successful patch installs. A “patch install” is a
successful update applied on a customer’s device.
Expand All @@ -77,7 +77,7 @@ You can view your current patch installs in
[your account page](https://console.shorebird.dev/account) on the Shorebird
Console. These numbers are updated hourly.

### Overage Billing
### Overage billing

For our monthly plans, we offer optional overage billing. This is turned off by
default.
Expand Down
12 changes: 6 additions & 6 deletions src/content/docs/account/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The Shorebird CLI provides several commands to help you manage your
authentication state, inspect your account details, and list your apps and
organizations directly from the terminal.

## Authentication Commands
## Authentication commands

### Login

Expand All @@ -35,12 +35,12 @@ from your machine, run:
shorebird logout
```

## Account Management Commands
## Account management commands

The `shorebird account` command provides several subcommands to inspect your
account details, apps, and organizations.

### Who Am I
### Who am I

To see the currently authenticated user's details, run:

Expand All @@ -61,7 +61,7 @@ Overage limit: 10000
This command is useful for verifying which account you are logged into and
checking your current billing plan and patch overage limit.

### List Apps
### List apps

To list all the Shorebird apps that your current account has access to, run:

Expand All @@ -79,7 +79,7 @@ shorebird account apps
The output displays the App ID, display name, latest release version, and latest
patch number (with `-` indicating no release or patch has been published yet).

### List Organizations
### List organizations

To list all the organizations you belong to, run:

Expand All @@ -99,7 +99,7 @@ This output displays the Organization ID, name, organization type (`personal` or

---

## JSON Output for Automation
## JSON output for automation

All `shorebird account` subcommands support the `--json` flag, making them easy
to integrate into scripts and automation workflows.
Expand Down
24 changes: 12 additions & 12 deletions src/content/docs/account/orgs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Organizations are a way to share groups of apps with people. This is useful for
any team collaborating across a company to have access as needed to releases,
patches, and more.

## Account Requirements
## Account requirements

Shorebird's paid plans unlock features for collaborating with your peers.
Shorebird's free plan users can upgrade to a paid plan to access these features
Expand All @@ -27,7 +27,7 @@ via the account settings page in the
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.

## Creating an Organization
## Creating an organization

To create an organization, visit the Shorebird console and click the account
dropdown in the top left corner. From there, click the "+" button next to
Expand All @@ -47,13 +47,13 @@ the name.
alt="Screenshot of how to get to Organization settings in the Shorebird Console"
/>

## Managing Apps
## Managing apps

Organizations can have multiple apps associated with them. You can either
transfer existing apps to an organization or create new apps within the
organization directly.

### Create a New App
### Create a new app

To create a new app within an organization, select the organization when running
`shorebird init`:
Expand All @@ -63,7 +63,7 @@ To create a new app within an organization, select the organization when running
alt="Screenshot of doing `shorebird init` command and selecting an organization"
/>

### Transfer an App
### Transfer an app

To transfer an existing app to an organization, visit the app's settings and
click the "Transfer app" button. You can then select the organization you want
Expand All @@ -74,9 +74,9 @@ to transfer the app to from the dropdown.
alt="Screenshot of dialog for transferring app to a different org in the Shorebird Console"
/>

## Managing Members
## Managing members

### Add a Member
### Add a member

To add one or more members to your organization, visit the organization's
settings and click the "Add member" button.
Expand All @@ -94,13 +94,13 @@ same organization settings page.
alt="Screenshot of successfully adding a member to an Organization in the Shorebird Console"
/>

### Remove a Member
### Remove a member

You can easily remove a member from an organization via the organization's
settings page. Locate the member you wish to remove, click the Trash icon, and
confirm the action.

## Member Roles
## Member roles

Organization roles apply to all apps within the organization and can be managed
via the organization settings page in the Shorebird console. The roles available
Expand All @@ -126,7 +126,7 @@ Hands-on role for engineers actively building and shipping apps. Can create
releases and patches, promote patches, and manage day-to-day development
workflows without administrative access.

### App Manager
### App manager

Responsible for managing application lifecycle and release strategy. Has all
Developer capabilities plus elevated control over app-level configuration,
Expand All @@ -143,7 +143,7 @@ excluding billing and plan changes.
Full control over the organization. Can manage billing and plans, ownership
settings, and all platform capabilities. Intended for primary account holders.

## Billing & Ownership
## Billing & ownership

Each organization has a single owner. An organization's plan is determined by
its [owner's](#owner) subscription. Their Shorebird subscription is what sets
Expand All @@ -153,7 +153,7 @@ To manage billing, the organization owner can visit the
[billing settings](https://console.shorebird.dev/account) in the Shorebird
console. See [Billing](/account/billing) for more details.

## Managing Per App Collaborators
## Managing per app collaborators

Per-app collaborators can also be added and managed via the Shorebird console.
The same management and permissions structure of organizations applies to
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/ci/checks/analyze.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ None. As long as your repository has Dart code detected this check will run.
If you have an `analysis_options.yaml` file with customizations, they are
recognized during this check.

## Available Statuses
## Available statuses

### Pass

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/ci/checks/check-spelling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ more information on this please consult the
[Getting Started in CSpell Docs](https://cspell.org/docs/getting-started#1-create-a-configuration-file)
for details.

## Available Statuses
## Available statuses

### Pass

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/ci/checks/format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ None. As long as your repository has Dart code detected this check will run.
If you have an `analysis_options.yaml` file with customizations, they are
recognized during this check.

## Available Statuses
## Available statuses

### Pass

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/ci/checks/run-tests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ they are passing.
None. As long as your repository has Dart or Flutter tests detected this check
will run.

## Available Statuses
## Available statuses

### Pass

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/ci/checks/upload-coverage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ more information on this please consult the
[Codecov YAML documentation](https://docs.codecov.com/docs/codecov-yaml) for
details.

## Available Statuses
## Available statuses

### Pass

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/ci/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ 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.

## Product Overview
## Product overview

### Why should I use this rather then another solution?

Expand Down Expand Up @@ -73,7 +73,7 @@ permissions
allows for our application to report back on the status checks that are
running and display them in the GitHub UI.

## Data Privacy
## Data privacy

### Where do builds happen?

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/ci/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ can too.
></iframe>
</div>

## Requirements for Use
## Requirements for use

Shorebird CI will work on any repository that contains at least one Flutter or
Dart project, including monorepos.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/code-push/ci/codemagic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ on how to integrate with Shorebird.

:::

# Codemagic Workflow Integration
# Codemagic workflow integration

This guide will help you integrate Shorebird into your Codemagic Workflow using
the
Expand Down Expand Up @@ -177,7 +177,7 @@ signingConfigs {
}
```

### Create Shared Configuration
### Create shared configuration

At the top of our `codemagic.yaml` file, define shared environment variables and
scripts that will be used by multiple workflows. This has been annotated to
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/code-push/ci/fastlane.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Follow the setup instructions on the fastlane website to install fastlane
([ios](https://docs.fastlane.tools/getting-started/ios/setup/),
[android](https://docs.fastlane.tools/getting-started/android/setup/)).

## Using fastlane on CI
## Using Fastlane on CI

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
Expand Down Expand Up @@ -47,7 +47,7 @@ To patch your app, you can use the `shorebird_patch` action. You can see an
example of this in the `patch_shorebird` lane in the
[`Fastfile`](https://github.com/shorebirdtech/fastlane_demo/blob/main/ios/fastlane/Fastfile#L92-L98).

## Using fastlane locally
## Using Fastlane locally

### Setup

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/code-push/ci/generic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ a patch is a set of changes to apply to a Release.
you're trying to patch. `shorebird` will look up the exact version of Flutter
used to build the release and use that exact version to build the patch.

## CI Best Practices
## CI best practices

When integrating Shorebird into a continuous integration pipeline, we recommend
following these best practices to ensure reliable and efficient builds:
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/code-push/ci/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Refer to the [getting started](/) instructions for more information.

:::

## Quick Start
## Quick start

To integrate Shorebird into your CI, use the `setup-shorebird` action. The
`setup-shorebird` action downloads Shorebird and adds it to the system path.
Expand Down Expand Up @@ -88,7 +88,7 @@ secret: <THE GENERATED SHOREBIRD_TOKEN>
Now we can use the `SHOREBIRD_TOKEN` in our GitHub workflow to perform
authenticated functions such as creating patches 🎉

## Create Releases
## Create releases

The simplest way to create a release is using the official Shorebird GitHub
Actions:
Expand Down Expand Up @@ -152,7 +152,7 @@ The `shorebird-release` action also outputs the release version:

:::

## Create Patches
## Create patches

```yaml
name: Shorebird Patch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ into your Flutter app:

https://docs.flutter.dev/cookbook/maintenance/error-reporting

# Getting Symbols from the Console
# Getting symbols from the console

Shorebird's console provides links to download the symbols for both for your
built app and the Flutter engine in the "Artifacts" tab of the release page.
Expand Down
Loading
Loading