Skip to content

Commit caed870

Browse files
committed
more reorganization for Browser Build errors page
1 parent aefc22f commit caed870

File tree

1 file changed

+43
-54
lines changed

1 file changed

+43
-54
lines changed

docs/browser/bb-errors.md

Lines changed: 43 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ If you are having trouble:
1111

1212
#### Please DO:
1313

14-
* [Ask a mentor for help](#where-to-get-help-with-browser-build)
1514
* Use the LoopDocs search feature
1615
* Use the zulipchat or Facebook search feature
16+
* [Ask a mentor for help](#where-to-get-help-with-browser-build)
1717

1818
#### Please do NOT:
1919

@@ -64,30 +64,36 @@ Mentors can go to your public&nbsp;_<span translate="no">GitHub repository</span
6464
6565
Please make this your first stop if you get any kind of an error with Browser Build.
6666
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:
67+
### Link Styles
68+
69+
If you notice an arrow pointing up and to the right beside the link:
70+
71+
* This means a new tab or window (depending on your browser configuration) is opened when you click on the link
72+
* Your original place in the docs is in the original tab, so you can return to your same position in the docs
6973
70-
* [Check Upstream and Keep Alive Error](#check-upstream-and-keep-alive-error)
74+
If there is no upright arrow by a link, then the location is on the same page:
75+
76+
* Once you have read that section, hit the back arrow in your browser to return to your original location
7177
7278
### Look at the Annotation
7379
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).
80+
If you get an error in an Action. Click on the link and scroll down to view the annotation. 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).
7581
7682
![graphic with an example validate secret error](img/example-annotation.png){width="800"}
7783
{align="center"}
7884
7985
### Rebuild or New Builder
8086
8187
* 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
88+
* If you are a new builder, please continue reading
8389
8490
## New Builder: Quick Reference
8591
8692
### New Builder: Validate Secrets Error
8793
8894
This is the first step. If you have not succeeded (&#x2705;) with this action - STOP.
8995
90-
* No other action will work - because all the other actions include Validate Secrets as the first step
96+
* No other action will work - because all the other actions repeat Validate Secrets as the first step of the action
9197
* Be sure to [Look at the Annotation](#look-at-the-annotation)
9298
* You can [ask a mentor for help](#where-to-get-help-with-browser-build)
9399
@@ -168,10 +174,16 @@ Ignore the warnings - this does not affect the build.
168174
169175
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" }
170176
177+
> Caveat - your Apple Developer account must be in good standing with a valid credit card attached and all agreements signed.
178+
171179
### Rebuild: Build Error
172180
173181
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.
174182
183+
> Caveat - your Apple Developer account must be in good standing with a valid credit card attached and all agreements signed.
184+
185+
There are, however, a few intermittent errors that can happen when *GitHub* and *Apple* don't communicate for some reason or there is a problem with the *TestFlight* upload. Check out [Action: `Build Loop` Errors when Updating](#action-build-loop-errors-when-updating).
186+
175187
## Most Common Mistakes
176188
177189
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).
@@ -280,7 +292,7 @@ If you need detailed instructions, click on this [<code>Apple Program License Ag
280292
281293
You can also get this message if the credit card used to purchase the Developer account is not current, e.g., no longer valid or credit card expiration date, as entered at *Apple*, has passed.
282294
283-
## Find Your Error
295+
### Find Your Error
284296
285297
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.
286298
@@ -295,36 +307,10 @@ Error annotations are available for the *Loop* app version 3.4 and later for som
295307
1. [Action: `Add Identifiers` Errors](#action-add-identifiers-errors)
296308
1. [Action: `Create Certificates` Errors](#action-create-certificates-errors)
297309
1. [Action: `Build Loop` Errors](#action-build-loop-errors) before a successful build
298-
1. [Repeat `Build Loop` Errors](#repeat-build-loop-errors) after a successful build
310+
1. [Action: `Build Loop` Errors when Updating](#action-build-loop-errors-when-updating) after a successful build
299311
300312
If you discover a new error, please reach out to help us update the documentation.
301313
302-
## Still Stuck?
303-
304-
It doesn't matter which action you are running; after the action completes, you will either see a green check mark <font color="green">:material-checkbox-marked-circle:</font> for **success** or a red x mark <font color="red">:fontawesome-solid-circle-xmark:</font> for **failure**. The graphic below shows an example for the `Add Identifiers` action.
305-
306-
![graphic showing a success and a failure for a GitHub Add Identifiers action](img/action-result.svg){width="700"}
307-
{align="center"}
308-
309-
If you click on the *action* name, it opens a secondary screen as shown below.
310-
311-
![graphic showing a success and a failure for a GitHub Add Identifiers action](img/action-result-secondary.svg){width="500"}
312-
{align="center"}
313-
314-
Click on the top link to view the record of the failed action as shown in the graphic below. You will be pasting strings into the search box (highlighted with a green rectangle) to look for a documented error. Please read the instructions below the graphic.
315-
316-
![graphic with failure details for a GitHub Add Identifier action](img/action-result-failure.svg){width="700"}
317-
{align="center"}
318-
319-
* Still stuck?
320-
* Post for help including your ==*GitHub* **URL**== (the link to your repository)
321-
* With that, mentors can diagnose your problem - or at least make a good guess at what you need to try
322-
* Please **do NOT post a screenshot**
323-
324-
!!! tip "Where to find my *GitHub* URL?"
325-
- Go to your fork of `LoopWorkspace` and highlight the address shown in your browser, for example:
326-
https://github.com/==my-name-org==/Loopworkspace
327-
328314
## Do Not Remove an App
329315
330316
Please do not remove an existing app if you have trouble building a different app. Your build error is not caused by any existing app.
@@ -339,16 +325,7 @@ Please do not remove an existing app if you have trouble building a different ap
339325
1. When trying to restore your app, Apple doesn't allow you to change just the name of the app and will not allow you to restore it because someone else has that name, even though your bundle ID is different
340326
1. After spending time on the phone with Apple, user's only option was to purchase a new Apple Developer account so they can get a new TEAMID (see steps below) or doing a custom change to the Loop code to modify the bundle ID (no instructions are provided for this - easy to do it wrong)
341327
342-
### New Developer ID with Same GitHub Account
343-
344-
You can use the same GitHub account with a new developer ID. Here are the steps:
345-
346-
1. Update the 4 secrets that are associated with the Apple Account for each repository on the GitHub used for browser build:
347-
* TEAMID
348-
* FASTLANE_ISSUER_ID
349-
* FASTLANE_KEY_ID
350-
* FASTLANE_KEY
351-
1. Once the Secrets are updated, start at the [Identifiers](identifiers.md){:target="_blank"} page and work through the process for each app
328+
## Instructions to Diagnose Your Errors
352329
353330
## Action: `Validate Secrets` Errors
354331
@@ -531,7 +508,7 @@ These steps are only needed to make room for a `Certificate` when running versio
531508
532509
## Action: `Build Loop` Errors
533510
534-
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).
511+
This section is for people who have not successfully built the *Loop* app one time. If you are a repeat builder, please skip ahead to [Action: `Build Loop` Errors when Updating](#action-build-loop-errors-when-updating).
535512
536513
!!! warning "Run `Create Certificates` First"
537514
When running a version earlier than `Loop 3.6.0`, you must run Action: `Create Certificates` before attempting to run Action: `Build Loop`
@@ -636,15 +613,15 @@ Once you have created an app in the *App Store* that is not based on your `TEAMI
636613
637614
At this point, get your correct `TEAMID`, fix your Secrets file to have the correct `TEAMID` and then return to [First-Time: Configure Secrets](prepare-fork.md#configure-secrets). This time you will be updating `TEAMID` in the secret list.
638615
639-
## Repeat `Build Loop` Errors
616+
## Action: `Build Loop` Errors when Updating
640617
641618
This section is only for people who have successfully built using *GitHub Build Actions*.
642619
643620
Use the [Examine Annotation](#examine-annotation) instructions to find your error message.
644621
645622
### `ERROR: Asset validation failed`
646623
647-
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.
624+
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. This is provided with `Loop 3.6.0` and newer versions.
648625
649626
There are serveral phrases you can check for. All of them have the same solution.
650627
@@ -765,7 +742,11 @@ Assuming you have successfully built using the Browser-Build / *GitHub* method b
765742
![graphic showing failure to install certificate](img/github-error-cert-failed.png){width="500"}
766743
{align="center"}
767744
768-
## Reset `Match-Secrets`
745+
## Extra Sections
746+
747+
It is unlikely you will need these sections.
748+
749+
### Reset `Match-Secrets`
769750
770751
This is not the first thing to try, but sometimes it is the best approach.
771752
@@ -793,11 +774,6 @@ These steps are needed to reset your `Match-Secrets`:
793774
794775
If you already have the other apps configured and then you delete `Match-Secrets` and add a new one, you will need to run `Create Certificates` for each app before the next time you build each app - go ahead and do that now so you don't forget.
795776
796-
797-
## Extra Sections
798-
799-
It is unlikely you will need these sections.
800-
801777
### Delete Identifiers
802778
803779
These instructions are useful if:
@@ -823,3 +799,16 @@ The `Identifier` that is associated with the `Loop` identifier cannot be deleted
823799
If coming here because you enter the wrong `TEAMID` in `Secrets` - return to [Rerun Steps with Correct TEAMID](#rerun-steps-with-correct-teamid) when you've deleted as many identifiers as you can.
824800
825801
After you delete identifiers, you must add them back before you can build a given app. Configure them and build again.
802+
803+
### New Developer ID with Same GitHub Account
804+
805+
You can use the same GitHub account with a new developer ID. This is an uncommon scenario, but if you lost access to the developer ID you used to use, you can modify your *GitHub* account to use a new one. Remember - this will be a new app, requiring you to enter your settings fresh and add your pump again. (New pod required if using Omnipod.)
806+
807+
Here are the steps:
808+
809+
1. Update the 4 secrets that are associated with the Apple Account for each repository on the GitHub used for browser build:
810+
* TEAMID
811+
* FASTLANE_ISSUER_ID
812+
* FASTLANE_KEY_ID
813+
* FASTLANE_KEY
814+
1. Once the Secrets are updated, start at the [Identifiers](identifiers.md){:target="_blank"} page and work through the process for each app

0 commit comments

Comments
 (0)