Skip to content

Commit 5503fb8

Browse files
committed
Update the Browser Build errors page
1 parent bc52605 commit 5503fb8

File tree

3 files changed

+162
-37
lines changed

3 files changed

+162
-37
lines changed

docs/browser/bb-errors.md

Lines changed: 162 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,24 @@
55

66
If you are updating your build, the process can be confusing and some error messages can be misleading.
77

8-
If you are having trouble, don't hesitate to ask for help.
8+
You are not alone - please reach out.
99

10-
Please do NOT:
10+
If you are having trouble:
1111

12-
* Spend hours in frustration
13-
* Rename or delete a repository
14-
* Delete your GitHub account
15-
* Remove your App from App Store Connect
12+
#### Please DO:
13+
14+
* [Ask a mentor for help](#where-to-get-help-with-browser-build)
15+
* Use the LoopDocs search feature
16+
* Use the zulipchat or Facebook search feature
17+
18+
#### Please do NOT:
19+
20+
* Search in a general internet browser to find your error
21+
* Ask ChatGPT (or other AI) how to fix your error
22+
* Spend hours in frustration
23+
* Rename or delete a repository
24+
* Delete your GitHub account
25+
* Remove your App from App Store Connect
1626

1727
### Where to Get Help with Browser Build
1828

@@ -50,6 +60,90 @@ Mentors can go to your public&nbsp;_<span translate="no">GitHub repository</span
5060
5161
All that is needed to assist is your link to the *GitHub* repository where you are building.
5262
63+
## Quick Reference for Browser Build Errors
64+
65+
Please make this your first stop if you get any kind of an error with Browser Build.
66+
67+
!!! important "Check Upstream and Keep Alive Error"
68+
If you have not manually updated your fork since 21 April 2025 - there is a one-time requirement to do that. Instructions and background for that step are found here:
69+
70+
* [Check Upstream and Keep Alive Error](#check-upstream-and-keep-alive-error)
71+
72+
### Look at the Annotation
73+
74+
If you get an error in an Action. Click on the link and scroll down to view the annonation. An example is shown below. Most errors have a clear annotation telling you what to do. If the annotation is not clear to your, please [ask a mentor for help](#where-to-get-help-with-browser-build).
75+
76+
![graphic with an example validate secret error](img/example-annotation.png){width="800"}
77+
{align="center"}
78+
79+
### Rebuild or New Builder
80+
81+
* If you have successfully built before and this is a rebuild, skip ahead to [Rebuild Errors Quick Reference](#rebuild-errors-quick-reference)
82+
* If you are a new builder, please follow these suggestions
83+
84+
## New Builder: Quick Reference
85+
86+
### New Builder: Validate Secrets Error
87+
88+
This is the first step. If you have not succeeded (&#x2705;) with this action - STOP.
89+
90+
* No other action will work - because all the other actions include Validate Secrets as the first step
91+
* Be sure to [Look at the Annotation](#look-at-the-annotation)
92+
* You can [ask a mentor for help](#where-to-get-help-with-browser-build)
93+
94+
If you want to try to solve it yourself, refer back to these section in the documentation:
95+
96+
* [Collect Secrets](secrets.md){: target="_blank" }
97+
* [Enter the Secrets](prepare-fork.md#enter-the-secrets){: target="_blank" }
98+
99+
### New Builder: Add Identifiers Error
100+
101+
If you succeeded with Validate Secrets, this should also succeed. If it does not, please [ask a mentor for help](#where-to-get-help-with-browser-build).
102+
103+
### New Builder: Create Certificates Error
104+
105+
This is one of the hardest ones to solve. If you are getting this, don't be afraid to [ask a mentor for help](#where-to-get-help-with-browser-build). If you want to solve it yourself, a link is coming your way but first read this:
106+
107+
#### This is NOT Your Error
108+
109+
When you start this action, GitHub starts a cloud computer to run your job for you. It doesn't have any information about you or your secrets - yet.
110+
111+
Early in the log file you will see two phrases in red font:
112+
113+
> There are no local code signing identities found.
114+
115+
> security: SecItemCopyMatching: The specified item could not be found in the keychain.
116+
117+
This is normal. The next steps will set up a keychain for you using your Match-Secrets repository and your MATCH_PASSWORD pass phrase.
118+
119+
#### Where to find the Certificate Solutions
120+
121+
Head over to [Action: Create Certificate Errors](#action-create-certificates-errors) and find your specific error.
122+
123+
### New Builder: Build Errors
124+
125+
The most likely reason to get errors here is a mistake in the [Prepare App](prepare-app.md){: target="_blank" } page.
126+
127+
Common errors are:
128+
129+
* You skipped one of the Identifiers when adding the App Group to it
130+
* The App Group was spelled wrong
131+
* You unchecked a capability on one of the Identifiers (because you watched an old video)
132+
* You did not select the correct identifier when creating your app
133+
* You entered an incorrect TEAMID
134+
135+
All of these solutions are found in [Action: Build Loop Errors](#action-build-loop-errors). The mentors can pick out the exact solution quickly if you [ask a mentor for help](#where-to-get-help-with-browser-build).
136+
137+
An example annotation for skipping one of the Identifiers is shown in the graphic below. The App Group for `Loop-Intent-Extension` was deliberately removed to provoke that error.
138+
139+
![graphic with an example build error](img//example-identifier-build-errors.png){width="800"}
140+
{align="center"}
141+
142+
Ignore the warnings - this does not affect the build.
143+
144+
145+
## Rebuild Errors: Quick Reference
146+
53147
### `Check Upstream and Keep Alive` Error
54148
55149
!!! important "`Check Upstream and Keep Alive` Error"
@@ -70,7 +164,15 @@ Mentors can go to your public&nbsp;_<span translate="no">GitHub repository</span
70164
71165
This affected all the Open-Source apps in our community - Loop, LoopFollow, LoopCaregiver, Trio, iAPS and xDrip4iOS. The developers in our community have restored the ability to build using the Browser Build method. Stay tuned for updates to required actions in the documentation over the next few months, before we hit the 60 day limit.
72166
73-
### Most Common Mistakes
167+
### Rebuild: Create Certificates Error
168+
169+
With `Loop 3.6.0`, these should be a thing of the past - but you must first manually update (sync) your repository in order to get this feature added and you must do this new step [Add Variable](prepare-fork.md#add-variable){: target="_blank" }
170+
171+
### Rebuild: Build Error
172+
173+
After you update to `Loop 3.6.0`, the Create Certificates Action is incorporated into the Build Action. So for rebuilders, if you completed the manual sync and added the new variable, you should not get an error when building.
174+
175+
## Most Common Mistakes
74176
75177
If you get an error when building with a browser, you can use this page to figure out what to do - but don't be afraid to [ask for help](#help-with-errors).
76178
@@ -97,12 +199,6 @@ These are some of the most common errors to date.
97199
* You can delete any branch that starts with the name `alive` and try again
98200
* See [Automatic Creation of `alive branch`](automatic.md#automatic-creation-of-alive-branch){: target="_blank" }
99201
100-
## Error Annotations
101-
102-
Error annotations are available for the *Loop* app released version 3.4 and later. These were contributed by community volunteers along with the improvements to enable automatic updates and automatic builds.
103-
104-
Not all error messages have an annotation yet. In those cases, you will be required to search for the error string as explained in [Find the Error](#find-the-error).
105-
106202
## Examine Annotation
107203
108204
If a&nbsp;<span translate="no">*GitHub* Action</span>&nbsp;fails, you will see a clear notification.
@@ -125,7 +221,9 @@ Notice that&nbsp;<span translate="no">*GitHub* Action: 1. Validate Secrets</span
125221
126222
### Annotation without Clear Message (*Certificates*)
127223
128-
Not all error messages have a clear annotation (yet).
224+
This section is left here for those who have an older version (3.4 or older) in their fork. If that is you, please follow these directions, [Rebuild Errors: Quick Reference](#rebuild-errors-quick-reference) and ignore this section.
225+
226+
Not all error messages have a clear annotation (up through version 3.4.x).
129227
130228
For example, the graphic below shows a failure of&nbsp;<span translate="no">*GitHub* Action: 3. Create Certificates</span>&nbsp;.
131229
@@ -166,7 +264,7 @@ The GIF below shows a failure of&nbsp;_<span translate="no">*GitHub* Action: 4.
166264
167265
This section is required when you need to search for a string to diagnose and error that does not have a clear annotation.
168266
169-
## Misleading Error Message
267+
### Misleading Error Message
170268
171269
If there are *Apple* Developer agreements you have not accepted, you may get errors when you try to Build that indicate your *Apple* <code>Secrets</code> are incorrect even if they are not.
172270
@@ -182,6 +280,8 @@ You can also get this message if the credit card used to purchase the Developer
182280
183281
## Find Your Error
184282
283+
At this point, it may be faster to [ask a mentor for help](#where-to-get-help-with-browser-build). But if you want to dig into the details of the log and find the error yourself, the information is here.
284+
185285
There is a separate section for each step in the process. First, you must follow the [Examine Annotation](#examine-annotation) instructions to view the record of the failed action. Then go to the section for the Action you were trying to complete to look for possible error strings to copy into the search box. For each section there are possible strings to paste to search the log.
186286
187287
* Paste in a possible error string (copy it exactly); repeat until you find a match
@@ -258,9 +358,23 @@ For Version 3.4 and later - use [Examine Annotation](#examine-annotation) and re
258358
259359
## Action: `Create Certificates` Errors
260360
261-
Review [Examine Annotation](#examine-annotation) for instructions on how to use the error strings.
361+
> Reminder - If it is not obvious to you what your error is, please [ask a mentor for help](#where-to-get-help-with-browser-build)
362+
363+
> * you might get to the answer sooner
364+
> * you are less likely to do something that makes it harder for the mentor to help you later
262365
263-
### Error: Wrong TEAMID in `Secrets`
366+
Review [Find the Error](#find-the-error) for instructions on how to use the error strings.
367+
368+
List of certificate errors on this page:
369+
370+
* [Error: No profile for team](#error-no-profile-for-team)
371+
* [Error: Error cloning certificates](#error-error-cloning-certificates)
372+
* [Error: Could not decrypt](#error-could-not-decrypt)
373+
* [Error: Could not create](#error-could-not-create)
374+
375+
### Error: No profile for team
376+
377+
This happens if you entered the wrong TEAMID in `Secrets`.
264378
265379
Copy the words on the line below and paste them into the search function for your action log.
266380
@@ -326,7 +440,9 @@ Follow the [Configure to Use Browser: Create Loop App in App Store Connect](prep
326440
327441
You should be able to continue with the [Configure to Use Browser Steps to `Create Certificates`](certs.md#create-certificates) and then proceed from there with `Build Loop` and keep going.
328442
329-
### Error: Missing Repository Access
443+
### Error: Error cloning certificates
444+
445+
This indicates you do not have the appropriate Repository access.
330446
331447
Copy the words on the line below and paste them into the search function for your action log.
332448
@@ -362,6 +478,22 @@ After you have clicked `Update token` you should see the token overview again wi
362478
363479
You should be able to continue with the [Configure to Use Browser Steps to `Create Certificates`](certs.md#create-certificates) and then proceed from there with `Build Loop` and keep going.
364480
481+
### Error: Could not decrypt
482+
483+
Copy the words on the line below and paste them into the search function for your log file.
484+
485+
> ``` { .text .copy }
486+
> decrypt the repo
487+
> ```
488+
489+
The full error message is:
490+
491+
> `Couldn't decrypt the repo, please make sure you enter the right password`
492+
493+
If you know you entered the incorrect <code>MATCH_PASSWORD</code> in your repository <code>Secrets</code>, go and fix it now and try again.
494+
495+
Otherwise, you need to follow the steps to [Reset Match-Secrets](#reset-match-secrets).
496+
365497
### Error: Could not create
366498
367499
Copy the words on the line below and paste them into the search function for your log file.
@@ -376,9 +508,9 @@ The full error message is:
376508
377509
#### New with `Loop 3.6.0`
378510
379-
> If you just updated to 3.6.0 (once it is released), you might not have added the new variable, `ENABLE_NUKE_CERTS`. Go do that now and then try again. It will take care of renewing your certificates automatically. See [Add Variable](prepare-fork.md#add-variable){: target="_blank" }.
511+
> If you just updated to 3.6.0, you might not have added the new variable, `ENABLE_NUKE_CERTS`. Go do that now and then try again. It will take care of renewing your certificates automatically. See [Add Variable](prepare-fork.md#add-variable){: target="_blank" }.
380512
381-
These steps are needed to make room for a `Certificate` when running versions earlier than 3.6.0:
513+
These steps are only needed to make room for a `Certificate` when running versions earlier than 3.6.0 if you choose not to add the `ENABLE_NUKE_CERTS` variable:
382514
383515
1. Delete an old `Distribution Certificate`
384516
* *Apple* limits you to two `Distribution Certificates`
@@ -395,24 +527,10 @@ These steps are needed to make room for a `Certificate` when running versions ea
395527
!!! question "But what about *TestFlight* builds?"
396528
Previous builds using this method that are already in *TestFlight* are not affected by deleting the `Distribution Certificate`.
397529
398-
### Error: Could not decrypt
399-
400-
Copy the words on the line below and paste them into the search function for your log file.
401-
402-
> ``` { .text .copy }
403-
> decrypt the repo
404-
> ```
405-
406-
The full error message is:
407-
408-
> `Couldn't decrypt the repo, please make sure you enter the right password`
409-
410-
If you know you entered the incorrect <code>MATCH_PASSWORD</code> in your repository <code>Secrets</code>, go and fix it now and try again.
411-
412-
Otherwise, you need to follow the steps to [Reset Match-Secrets](#reset-match-secrets).
413-
414530
## Action: `Build Loop` Errors
415531
532+
This is the section for people who have not successfully built the *Loop* app one time. If you are a repeat builder, please skip ahead to [Repeat Build Loop Errors](#repeat-build-loop-errors).
533+
416534
!!! warning "Run `Create Certificates` First"
417535
When running a version earlier than `Loop 3.6.0`, you must run Action: `Create Certificates` before attempting to run Action: `Build Loop`
418536
@@ -427,6 +545,13 @@ Refer to [Annotation without Clear Message (*Build*)](#annotation-without-clear-
427545
428546
For each section below, copy the phrase into the search function of the log. If you find it, solve that error. If not, move on to the next one.
429547
548+
List of build errors in this section:
549+
550+
* [`Error: Could not find an app on App Store Connect`](#error-could-not-find-an-app-on-app-store-connect)
551+
* [`Error: Provisioning Profile`](#error-provisioning-profile)
552+
* [`Error: A new one cannot be created because you enabled`](#error-a-new-one-cannot-be-created-because-you-enabled)
553+
554+
430555
### `Error: Could not find an app on App Store Connect`
431556
432557
Copy the words on the line below and paste them into the search function for your action log.
@@ -517,7 +642,7 @@ Use the [Examine Annotation](#examine-annotation) instructions to find your erro
517642
518643
### `ERROR: Asset validation failed`
519644
520-
This error indicates your fork needs to be updated. As of 29 April 2024, you are required to use Xcode 15 to build the app.
645+
This error indicates your fork needs to be updated. As of 24 April 2025, you are required to use Xcode 16 to build the app.
521646
522647
There are serveral phrases you can check for. All of them have the same solution.
523648
48.3 KB
Loading
91.8 KB
Loading

0 commit comments

Comments
 (0)