xref: /expo/docs/pages/eas-update/debug.mdx (revision e20619ca)
1---
2title: Debug EAS Update
3sidebar_title: Basic
4description: Learn how to debug EAS Update.
5---
6
7import ImageSpotlight from '~/components/plugins/ImageSpotlight';
8import { Terminal } from '~/ui/components/Snippet';
9
10This guide shows how to verify our configuration so that we can find the source of problems like an app not showing a published update. It's important to tell the current state of our app at any given time, so EAS Update was built with this in mind. Once we know which updates are running on which builds, we can make changes so that our apps are in the state we expect.
11
12## Go to the Deployments page
13
14The EAS website has a [Deployments page](https://expo.dev/accounts/[account]/projects/[project]/deployments) that shows the current state of our app. The term _deployment_ refers to a group of builds and their corresponding updates. If we've made builds and updates with EAS, we can see our project's status on the website in the Deployments tab.
15
16<ImageSpotlight
17  alt="Deployments tab"
18  src="/static/images/eas-update/deployments-website-tab.png"
19  style={{ maxWidth: 400 }}
20/>
21
22## Common problems
23
24The following section describes common problems and how to fix them. Below is a diagram of how EAS Update works and the spots that are useful to inspect when finding the root cause of an issue. In the following sections, we'll inspect and verify these spots and more.
25
26<ImageSpotlight alt="Map of debugging spots" src="/static/images/eas-update/debug-map.png" />
27
28### Unexpected channel
29
30<ImageSpotlight
31  alt="Deployment has unexpected channel"
32  src="/static/images/eas-update/deployments-wrong-channel.png"
33  style={{ maxWidth: 600 }}
34/>
35
36If the deployment channel is unexpected, it means our build was not built with the correct channel. To fix this, [configure our channel](/#configure-channel) and rebuild our app.
37
38### Unexpected runtime version
39
40<ImageSpotlight
41  alt="Deployment has unexpected runtime version"
42  src="/static/images/eas-update/deployments-wrong-runtime.png"
43  style={{ maxWidth: 600 }}
44/>
45
46If the deployment runtime version is unexpected, it means our build was not built with the correct runtime version. To fix this, [configure our runtime version](/#configure-runtime-version) and rebuild our app.
47
48### Unexpected branch
49
50<ImageSpotlight
51  alt="Deployment has unexpected branch"
52  src="/static/images/eas-update/deployments-wrong-branch.png"
53  style={{ maxWidth: 600 }}
54/>
55
56If the deployment has an unexpected branch, we need to [map our channel to the correct branch](/#map-channel-to-branch).
57
58### Missing updates
59
60<ImageSpotlight
61  alt="Deployment has no updates"
62  src="/static/images/eas-update/deployments-no-updates.png"
63  style={{ maxWidth: 600 }}
64/>
65
66The displayed deployment does not have any updates. To fix this, [publish an update to the branch](/#publish-update). If an update was already published, check the [Updates page](https://expo.dev/accounts/[account]/projects/[project]/updates) to make sure it matches the runtime version of our build.
67
68### Missing branch
69
70<ImageSpotlight
71  alt="Deployment has no branch"
72  src="/static/images/eas-update/deployments-no-branch.png"
73  style={{ maxWidth: 600 }}
74/>
75
76The displayed deployment has the correct channel, but it is not linked to a branch. To fix this, [map the channel to the correct branch](/#map-channel-to-branch).
77
78### Missing deployment
79
80If our deployment is not displayed, it means our build is not configured properly for EAS Update. To fix this, [configure our channel](/#configure-channel), [configure our runtime version](/#configure-runtime-version) and verify our [general configuration](/debug-advanced/#verifying-app-configuration). We'll need to rebuild our app after making these changes.
81
82## Solutions
83
84### Configure channel
85
86To verify that a build has a specific channel, make sure our build profile in **eas.json** has a channel property:
87
88```json eas.json
89{
90  "build": {
91    "preview": {
92      "distribution": "internal",
93      "channel": "preview"
94    },
95    "production": {
96      "channel": "production"
97    }
98  }
99}
100```
101
102Then, we can run a command like `eas build --profile preview` to create a build with a channel named "preview".
103
104### Configure runtime version
105
106To verify our runtime version, we make sure our app config (**app.json**/**app.config.js**) has a `runtimeVersion` property:
107
108```json app.json
109{
110  "expo": {
111    "runtimeVersion": {
112      "policy": "sdkVersion"
113    }
114  }
115}
116```
117
118By default, it is `{ "policy": "sdkVersion" }`, but we can change our runtime to [use a different policy or a specific version](/eas-update/runtime-versions). Then, we can run a command like `eas build --profile preview` to create a build with the runtime version we expect.
119
120### Map channel to branch
121
122If the channel is not mapped to the branch we expect, we can change the link with:
123
124<Terminal
125  cmd={[
126    '# eas channel:edit [channel-name] --branch [branch-name]',
127    '',
128    '',
129    '# Example',
130    'eas channel:edit production --branch release-1.0',
131  ]}
132/>
133
134If our branch is not listed, we can create a new branch with `eas branch:create`.
135
136### Publish update
137
138To create and publish an update, we can run the following command:
139
140<Terminal cmd={['$ eas update']} />
141
142After publishing, the output will display the branch and the runtime version. This information can help us verify that we're creating an update with the configuration we expect.
143
144## Next steps
145
146Read the [advanced guide](/eas-update/debug-advanced) to debug EAS Update when the basic steps don't resolve your issue.
147