Skip to content

Commit

Permalink
docs: remove ios-alpha references (#177)
Browse files Browse the repository at this point in the history
  • Loading branch information
felangel authored Feb 1, 2024
1 parent fa3144b commit a6d3c29
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 30 deletions.
4 changes: 2 additions & 2 deletions docs/code_push/patch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ shorebird patch android

</TabItem>

<TabItem value="patch-command-ios" label="iOS (alpha)">
<TabItem value="patch-command-ios" label="iOS (beta)">

```
shorebird patch ios-alpha
shorebird patch ios
```

</TabItem>
Expand Down
10 changes: 5 additions & 5 deletions docs/code_push/release.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ In order to start pushing updates, you will need to create a release.

</TabItem>

<TabItem value="release-ios" label="iOS (alpha)">
<TabItem value="release-ios" label="iOS (beta)">

`shorebird release ios-alpha`
`shorebird release ios`

</TabItem>

Expand Down Expand Up @@ -69,10 +69,10 @@ https://support.google.com/googleplay/android-developer/answer/9859152?hl=en

</TabItem>

<TabItem value="release-output-ios" label="iOS (alpha)">
<TabItem value="release-output-ios" label="iOS (beta)">

```
$ shorebird release ios-alpha
$ shorebird release ios
✓ Fetching apps (0.2s)
✓ Building release (59.0s)
✓ Getting release version (40ms)
Expand Down Expand Up @@ -135,7 +135,7 @@ shorebird release android --force
or

```
shorebird release ios-alpha --force
shorebird release ios --force
```

:::
Expand Down
4 changes: 2 additions & 2 deletions docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ A release is a specific version of an [application](#application), identified by

A release can have zero or more [patches](#patch) applied to it.

Releases are created by running `shorebird release [platform]`, where `platform` is `android`, `aar`, or `ios-alpha`.
Releases are created by running `shorebird release [platform]`, where `platform` is `android`, `aar`, or `ios`.

### Patch

A patch is a change to a specific [release](#release), applied as an over-the-air update. For example, a patch could be a bug fix or a new feature. Multiple patches can be published for a given release, although only one patch can be active at a time. Patches are identified by their associated release version and a patch number, which is an auto-incrementing integer.

When your application starts, it checks for available patches and applies the latest one. This patch will be visible the next time your application launches.

Patches are created by running `shorebird patch [platform]`, where `platform` is `android`, `aar`, or `ios-alpha`.
Patches are created by running `shorebird patch [platform]`, where `platform` is `android`, `aar`, or `ios`.

### Artifact

Expand Down
8 changes: 4 additions & 4 deletions docs/guides/code_push_quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ shorebird release android

</TabItem>

<TabItem value="ios" label="iOS (alpha)">
<TabItem value="ios" label="iOS (beta)">

```sh
shorebird release ios-alpha
shorebird release ios
```

</TabItem>
Expand Down Expand Up @@ -142,10 +142,10 @@ shorebird patch android

</TabItem>

<TabItem value="ios" label="iOS (alpha)">
<TabItem value="ios" label="iOS (beta)">

```sh
shorebird patch ios-alpha
shorebird patch ios
```

</TabItem>
Expand Down
12 changes: 6 additions & 6 deletions docs/guides/flavors/ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,14 @@ You can view your apps at [console.shorebird.dev](https://console.shorebird.dev)

## Create a release

Now that we've created our apps on shorebird, we need to create releases (one for each flavor). To create a release, we'll use the `shorebird release ios-alpha` command.
Now that we've created our apps on shorebird, we need to create releases (one for each flavor). To create a release, we'll use the `shorebird release ios` command.

```sh
# Create a release for the internal flavor
shorebird release ios-alpha --flavor internal
shorebird release ios --flavor internal
# Create a release for the stable flavor
shorebird release ios-alpha --flavor stable
shorebird release ios --flavor stable
```

We can verify the releases were created successfully by visiting [Shorebird console](https://console.shorebird.dev/).
Expand Down Expand Up @@ -92,7 +92,7 @@ In addition to previewing the releases locally, you should also [submit the gene

## Creating a patch

Now that we have our internal and stable releases on the Play Store, we can create a patch using `shorebird patch ios-alpha`. For the sake of this example, let's adjust the app theme to use `deepOrange` as the seed color in `lib/main.dart`:
Now that we have our internal and stable releases on the Play Store, we can create a patch using `shorebird patch ios`. For the sake of this example, let's adjust the app theme to use `deepOrange` as the seed color in `lib/main.dart`:

```diff
class MyApp extends StatelessWidget {
Expand Down Expand Up @@ -136,7 +136,7 @@ Typically `shorebird patch` should be used to fix critical bugs.
Now that we've applied the changes, let's patch the `internal` variant:

```sh
shorebird patch ios-alpha --flavor internal
shorebird patch ios --flavor internal
```

We can validate the patch by visiting [Shorebird console](https://console.shorebird.dev/) then select the internal release or re-launching the internal release.
Expand All @@ -154,7 +154,7 @@ If all went well, you should see the patch was applied after re-launching the ap
Once you have validated the patch internally, you can promote the patch to the stable variant via:

```sh
shorebird patch ios-alpha --flavor stable
shorebird patch ios --flavor stable
```

At this point, you have a setup which allows you to push patches to internal testers before promoting them to production 🎉
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/hybrid-app/ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ In the General tab of your app target, ensure that the frameworks have the
Create a Shorebird release for your Flutter module:

```
shorebird release ios-framework-alpha --release-version 1.2.3+1
shorebird release ios-framework --release-version 1.2.3+1
```

The `release-version` parameter needs to match the version of the iOS app
Expand Down Expand Up @@ -108,7 +108,7 @@ _with the same `xcframework` generated by the release command above_.
Make an edit to the code in your Flutter module. Then run:

```
shorebird patch ios-framework-alpha --release-version 1.2.3+1
shorebird patch ios-framework --release-version 1.2.3+1
```

:::note
Expand Down
16 changes: 9 additions & 7 deletions docs/guides/release/ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,12 @@ Update the version in `pubspec.yaml` to `1.0.4+1`:

### Create a Shorebird release

Create a Shorebird release by running the `shorebird release ios-alpha` command:
Create a Shorebird release by running the `shorebird release ios` command:

```
$ shorebird release ios-alpha
[WARN] iOS support is in an alpha state. See https://docs.shorebird.dev/status#ios-alpha for more information.
$ shorebird release ios
[WARN] iOS support is beta. Some apps may run slower after patching.
See https://docs.shorebird.dev/status for more information.
✓ Fetching apps (0.1s)
✓ Building release (56.2s)
✓ Getting release version (37ms)
Expand Down Expand Up @@ -88,7 +89,7 @@ To upload to the App Store, do one of the following:

:::note

If you perform your own codesigning and do not want Shorebird to codesign your app, you can pass the `--no-codesign` flag to the `shorebird release ios-alpha` command. Because only signed code can be run on iOS devices, **releases created this way will not be previewable using the `shorebird preview` command.** You can still download and run these releases through TestFlight.
If you perform your own codesigning and do not want Shorebird to codesign your app, you can pass the `--no-codesign` flag to the `shorebird release ios` command. Because only signed code can be run on iOS devices, **releases created this way will not be previewable using the `shorebird preview` command.** You can still download and run these releases through TestFlight.

:::

Expand Down Expand Up @@ -150,11 +151,12 @@ For the purposes of this guide, we will change the default clock face to `genera

### Create a Shorebird patch

To make this patch available to your users, run `shorebird patch ios-alpha`.
To make this patch available to your users, run `shorebird patch ios`.

```
$ shorebird patch ios-alpha
[WARN] iOS support is in an alpha state. See https://docs.shorebird.dev/status#ios-alpha for more information.
$ shorebird patch ios
[WARN] iOS support is beta. Some apps may run slower after patching.
See https://docs.shorebird.dev/status for more information.
✓ Fetching apps (0.4s)
✓ Building release (61.5s)
✓ Detected release version 1.0.4+1 (44ms)
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/staging-patches.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Now that we've created our apps on shorebird, we need to create releases (one fo
shorebird release android

# Create a release for iOS
shorebird release ios-alpha
shorebird release ios
```

We can verify the releases were created successfully by visiting [Shorebird console](https://console.shorebird.dev).
Expand Down Expand Up @@ -95,7 +95,7 @@ Now that we've applied the changes, let's create a patch:
shorebird patch android --staging

# Stage a patch on iOS
shorebird patch ios-alpha --staging
shorebird patch ios --staging
```

## Preview the release
Expand Down

0 comments on commit a6d3c29

Please sign in to comment.