Skip to content

Commit 80f1b0e

Browse files
authored
Update patch install troubleshooting instructions (#322)
1 parent b5455be commit 80f1b0e

File tree

1 file changed

+29
-39
lines changed

1 file changed

+29
-39
lines changed

src/content/docs/troubleshooting.mdx

Lines changed: 29 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,34 @@ Find help for issues with Shorebird.
77

88
## I created a patch, but it's not showing up in my app
99

10-
There are several reasons this might be happening. Start by running your release
11-
on a device or Android emulator using the `shorebird preview` command to see the
12-
log output.
10+
Your first step in debugging should be to check your app's logs. Instructions
11+
for this can be found at https://shorebird.dev/blog/viewing-logs/.
1312

14-
Common causes of this problem are:
13+
You should see logs prefixed with `[shorebird]`. If you do not see `[shorebird]`
14+
in your logs, the app you are running was not built using `shorebird release`
15+
and cannot receive patches. You will need to redistribute your app using a
16+
binary created by `shorebird release`.
17+
18+
If you do see Shorebird in your logs, you'll want to look for a a line that
19+
includes the patch check request being made. It looks like:
20+
21+
```
22+
Sending patch check request: PatchCheckRequest {
23+
app_id: "<your app id>",
24+
channel: "stable",
25+
release_version: "1.0.3+16", <-- this is the release version
26+
patch_number: <some patch number>,
27+
platform: "android",
28+
arch: "aarch64"
29+
}
30+
```
31+
32+
If the release version is the version you expect to see, check the [Shorebird
33+
Console](https://console.shorebird.dev) to ensure that this release exists for
34+
the given app id and that it has a patch. Please contact us on Discord if such
35+
a patch exists and is not being applied.
36+
37+
Common issues:
1538

1639
### The patch was created for a different release version than the one running on your device/emulator.
1740

@@ -33,8 +56,8 @@ You will see `Shorebird updater: no active patch` in your device logs.
3356
#### How to fix it
3457

3558
Ensure that the version of your app on your device/emulator matches the version
36-
of the patch you created. You can see what release version your app is running
37-
by looking in the device logs for:
59+
of the release you patched. You can see what release version your app is running
60+
by looking in the device logs for a patch check request:
3861

3962
```
4063
Sending patch check request: PatchCheckRequest {
@@ -49,39 +72,6 @@ Sending patch check request: PatchCheckRequest {
4972

5073
Only patches created for this release version will be compatible with your app.
5174

52-
### The build uploaded to the Play Store/App Store is not the build Shorebird is using for patches.
53-
54-
If you uploaded an .aab or .xcarchive created using `shorebird build` or
55-
`shorebird patch`, it will not be patchable. You **must** upload the build
56-
created by `shorebird release`.
57-
58-
#### How to tell if this is the problem
59-
60-
You see `Update rejected: hash mismatch` in your device logs. Note: this is not
61-
the only thing that can cause a hash mismatch error.
62-
63-
#### How to fix it.
64-
65-
Unfortunately, you will need to create a new release using `shorebird release`.
66-
67-
### The app you're running on your device/emulator was not built using one of the `shorebird release` commands.
68-
69-
#### How to tell if this is the problem
70-
71-
If you are running your app using `shorebird preview`, this is not the problem.
72-
73-
If you have installed the app on your device/emulator a different way, check
74-
your device logs for output from Shorebird. If you don't see anything like
75-
`Starting Shorebird update` or `Sending patch check request`, you are not
76-
running a Shorebird-built app.
77-
78-
To check your Android device logs, run `adb logcat` in your terminal. You can
79-
filter the output to only show Flutter logs by running `adb logcat | grep flutter`.
80-
81-
#### How to fix it
82-
83-
Use `shorebird preview`.
84-
8575
## I installed Shorebird, and now I can't run my app in VS Code
8676

8777
If you see error output like the following when using the Run or Debug button in

0 commit comments

Comments
 (0)