You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/browser/bb-errors.md
+37-88Lines changed: 37 additions & 88 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,13 +23,17 @@ These are two places to ask for help, but please choose only one. You may get a
23
23
24
24
### What Information is Needed for Help
25
25
26
-
1. Your GitHub username (required):
26
+
1. Your GitHub address (required):
27
27
28
-
* You can also provide a link to your repository like the example, but substitute your username for `USERNAME`
28
+
* You can also provide a link to your repository like the example, but substitute your information
29
29
* If you are building an app other than Loop, replace LoopWorkspace with the app repository name
30
30
31
+
```{.text .copy title="If you use an organization" }
32
+
https://github.com/my-name-org/LoopWorkspace
31
33
```
32
-
https://github.com/USERNAME/LoopWorkspace
34
+
35
+
``` { .text .copy title="If you do not use an organization" }
36
+
https://github.com/my-name/LoopWorkspace
33
37
```
34
38
35
39
1. A brief summary of the step you are on and what isn't working.
@@ -41,20 +45,15 @@ Mentors can go to your public _<span translate="no">GitHub repository</span
41
45
* Do not copy from the log file and post the words
42
46
* Do not take a screenshot of what you think is an error
43
47
44
-
!!! tip "Username, Not Pictures"
48
+
!!! tip "GitHub URL, Not Pictures"
45
49
If you've been around the DIY community for a while, you know the mantra about screenshots. Well, when using a browser to build, **screenshots are close to useless**.
46
50
47
-
All that is needed to assist is your link or as a bare minimum your *GitHub* **username**.
51
+
All that is needed to assist is your link to the *GitHub* repository where you are building.
48
52
49
53
### Most Common Mistakes
50
54
51
55
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).
52
56
53
-
!!! warning "Just updated?"
54
-
If you just updated to version 3.4 from version 3.2.x, you must add a new Identifier.
55
-
56
-
If you missed this step - go do it now. [Update from 3.2.x to 3.4](bb-update.md#update-from-32x-to-34){: target="_blank" }
57
-
58
57
!!! important "Certificate is missing"
59
58
If you get this build error message: `No code signing identity found and can not create a new one because you enabled`, you do not have certificates needed to run the build.
60
59
@@ -68,8 +67,8 @@ These are some of the most common errors to date.
68
67
1. You did not add the `App Group Identifier` to all 4 of the required identifiers in this step: [Add `App Group` to `Identifiers`](prepare-app.md#add-app-group-to-identifiers){: target="_blank" }
69
68
* See [Annotation without Clear Message (*Build*)](#annotation-without-clear-message-build) for an example of this kind of failure
70
69
1. You used a smart editor instead of a text-only editor to save your information
71
-
* It only takes one letter to be changed from lower-case to upper-case by your smart editor to ruin your day
72
-
* The alpha-numeric values used for `GH_PAT`, `FASTLANE_ISSUER_ID` and `FASTLANE_KEY` contain both upper and lower-case characters and all the values are case-sensitive
70
+
* It only takes one letter to be changed from small to capital by your smart editor to ruin your day
71
+
* The alpha-numeric values used for `GH_PAT`, `FASTLANE_ISSUER_ID` and `FASTLANE_KEY` contain both small and capital characters and all the values are case-sensitive
73
72
1. When saving `TEAMID`, you typed what you thought you saw instead of using copy and paste
74
73
1. You skipped running one of the actions
75
74
1. You need to sign a program license agreement or update a credit card at <span translate="no">Apple Developer</span>
@@ -92,7 +91,7 @@ First consider the following results from the <span translate="no">*GitHub*
92
91
93
92
### Annotation with Clear Message
94
93
95
-
Your screen may look similar to the graphic below. The name in parentheses refers to the branch used to develop these wonderful messages. Yours may be (dev) or (main), once 3.4 is released.
94
+
Your screen may look similar to the graphic below. The name in parentheses refers to the branch used to develop these wonderful messages. Yours will almost always be the `main` branch.
96
95
97
96
{width="500"}
98
97
{align="center"}
@@ -117,15 +116,17 @@ This is an example of a message that is not terribly descriptive - which is why
117
116
118
117
### Missing Certificates
119
118
119
+
> Coming soon: when Loop 3.6.0 (or newer) is available, certificates will be automatically renewed if your developer account is up to date, all agreements are signed and you completed the new [Add Variable](prepare-fork.md#add-variable){: target="_blank" } step.
120
+
121
+
> After Loop 3.6.0 is released, the first attempt to build will update the files required for automatic certificate creation. The second attempt to build will use the new files. So if the first attempt with Loop 3.6.0 fails, try again.
122
+
120
123
If your certificates have expired, you will see this error when you try to build. It does not have a clear annotation. The error string starts with: `No code signing identity found and can not create a new one because you enabled`.
121
124
122
125
* See [Renew Certificates](bb-update.md#renew-certificate){: target="_blank" }
123
126
124
-
125
127
{width="800"}
126
128
{align="center"}
127
129
128
-
129
130
### Annotation without Clear Message (*Build*)
130
131
131
132
The GIF below shows a failure of _<span translate="no">*GitHub* Action: 4. Build Loop</span>_ . The nice messages have not been added to this yet - you will have to follow the [Find the Error](#find-the-error) instructions, but now, you are automatically taken to the correct section so there is less of the log to deal with.
@@ -146,25 +147,23 @@ The GIF below shows a failure of _<span translate="no">*GitHub* Action: 4.
146
147
## Find the Error
147
148
148
149
This section is required when you need to search for a string to diagnose and error that does not have a clear annotation.
150
+
149
151
## Misleading Error Message
150
152
151
153
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.
152
154
153
155
* The misleading message tells you that one or more of these: <code>FASTLANE_ISSUER_ID</code>, <code>FASTLANE_KEY_ID</code> or <code>FASTLANE_KEY</code> is not correct
154
-
* Check your *Apple* Developer account for agreements first, before trying to fix those
156
+
* Once `Loop 3.6.0` or newer is available, this should no longer appear unless you have a mistake in one of thsoe
157
+
* Check your *Apple* Developer account for agreements first, before trying to fix those `Secrets`
155
158
* If you previously built successfully - it is almost certainly the agreement
156
159
* It can take 15 minutes to an hour after the agreement is signed before it can be used
157
160
158
161
If you need detailed instructions, click on this [<code>Apple Program License Agreement</code> Help Page](https://support.pushpay.com/s/article/Accepting-the-Apple-Program-License-Agreement){: target="_blank" }.
159
162
160
-
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 expiration date has passed.
161
-
162
-
> One user reported: The expiration date on the credit card used for auto-renew of my developer account was updated and the value in the Apple account did not match the new one. After updating my account with the new expiration date - Browser Build succeeded again.
163
+
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.
163
164
164
165
## Find Your Error
165
166
166
-
> For Version 3.2.3 and earlier - later versions have an improved method for display errors.
167
-
168
167
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.
169
168
170
169
* Paste in a possible error string (copy it exactly); repeat until you find a match
@@ -198,24 +197,13 @@ Click on the top link to view the record of the failed action as shown in the gr
198
197
{align="center"}
199
198
200
199
* Still stuck?
201
-
* Post for help including your ==*GitHub* **username**==
200
+
* Post for help including your ==*GitHub* **URL**== (the link to your repository)
202
201
* With that, mentors can diagnose your problem - or at least make a good guess at what you need to try
203
202
* Please **do NOT post a screenshot**
204
203
205
-
!!! tip "Where to find my *GitHub* username?"
206
-
You can find it:
207
-
208
-
- either in the URL of your fork of `Loopworkspace`, after `github.com` in between the forward slashes (`/`).
209
-
https://github.com/==username==/Loopworkspace
210
-
- or on the [*GitHub* website](https://github.com){: target="_blank" }
211
-
212
-

213
-
{width="200"}
214
-
{align="right"}
215
-
216
-
{width="400"}
217
-
218
-
As your *GitHub* `username` is case-sensitive, use copy and paste.
204
+
!!! tip "Where to find my *GitHub* URL?"
205
+
- Go to your fork of `LoopWorkspace` and highlight the address shown in your browser, for example:
206
+
https://github.com/==my-name-org==/Loopworkspace
219
207
220
208
## Do Not Remove an App
221
209
@@ -252,7 +240,7 @@ For Version 3.4 and later - use [Examine Annotation](#examine-annotation) and re
252
240
253
241
## Action: `Create Certificates` Errors
254
242
255
-
Review [Examine Annotatios](#examine-annotation) for instructions on how to use the error strings.
243
+
Review [Examine Annotation](#examine-annotation) for instructions on how to use the error strings.
256
244
257
245
### Error: Wrong TEAMID in `Secrets`
258
246
@@ -352,8 +340,6 @@ To fix this error:
352
340
353
341
After you have clicked `Update token` you should see the token overview again with the message `Some of the scopes you’ve selected are included in other scopes. Only the minimum set of necessary scopes has been saved. ` (You can dismiss the message using the `X` near the upper right side if it appears).
354
342
355
-
NOTE: for next release or if using the dev branch - you want <code>GH_PAT</code> to have `repo, workflow` scope. So click on the workflow scope now and save yourself a step later.
356
-
357
343
#### Create Certificates
358
344
359
345
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.
@@ -370,7 +356,11 @@ The full error message is:
370
356
371
357
> `Could not create another Distribution certificate, reached the maximum number of available Distribution certificates`
372
358
373
-
These steps are needed to make room for a `Certificate`:
359
+
#### New with `Loop 3.6.0`
360
+
361
+
> 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" }.
362
+
363
+
These steps are needed to make room for a `Certificate` when running versions earlier than 3.6.0:
374
364
375
365
1. Delete an old `Distribution Certificate`
376
366
* *Apple* limits you to two `Distribution Certificates`
@@ -406,7 +396,7 @@ Otherwise, you need to follow the steps to [Reset Match-Secrets](#reset-match-se
406
396
## Action: `Build Loop` Errors
407
397
408
398
!!! warning "Run `Create Certificates` First"
409
-
You must run Action: `Create Certificates` before attempting to run Action: `Build Loop`
399
+
When running a version earlier than `Loop 3.6.0`, you must run Action: `Create Certificates` before attempting to run Action: `Build Loop`
410
400
411
401
If you had to step backward and fix an `Identifier`, you must run `Create Certificates` again.
412
402
@@ -661,58 +651,17 @@ These steps are needed to reset your `Match-Secrets`:
661
651
662
652
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.
663
653
664
-
## Misleading Error Message
665
-
666
-
If there are *Apple Developer* agreements you have not accepted, you will get errors when you try to build the app that indicate your *Apple* <code>Secrets</code> are incorrect.
667
-
668
-
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 expiration date has passed.
669
-
670
-
* The misleading message tells you that one or more of these: <code>FASTLANE_ISSUER_ID</code>, <code>FASTLANE_KEY_ID</code> or <code>FASTLANE_KEY</code> is not correct
671
-
* Check your *Apple* Developer account for agreements first, before trying to fix those
672
-
* If you previously built successfully - it is almost certainly the agreement
673
-
* It can take 15 minutes to an hour after the agreement is signed before it can be used
674
-
675
-
If you need detailed instructions, click on this [<code>Apple Program License Agreement</code> Help Page](https://support.pushpay.com/s/article/Accepting-the-Apple-Program-License-Agreement).
676
654
677
655
## Extra Sections
678
656
679
-
It is unlikely you will need these sections. They are being saved for the transition to version 3.4.x. The Match-Secrets repository is automatically created for you if you don't have one. The instructions below were used when you had to create yours manually.
680
-
681
-
### Create Match-Secrets
682
-
683
-
Open your github.com URL (this is `https://github.com/username`), (`username` is your GitHub account name).
684
-
685
-
Create a new private repository - you can either click on the link below or follow the instructions with the first graphic:
657
+
It is unlikely you will need these sections.
686
658
687
-
* Click on this link: [https://github.com/new](https://github.com/new){: target="_blank" }
688
-
689
-
or
690
-
691
-
* At the top right of the screen, click on the + sign and select `New Repository`
692
-
693
-
{width="200"}
694
-
{align="center"}
695
-
696
-
This shows you a screen similar to the following graphic which has 3 regions highlighted:
697
-
698
-
* In `Repository name`, type `Match-Secrets` (use a hyphen between `Match` and `Secrets`)
699
-
* Be sure to check the box **`Private`** (red circle) to make the repository **private**
700
-
* **Please confirm you selected the `Match-Secrets` repository as private.**
701
-
* Scroll to the bottom of the page and tap on "`Create repository`"
702
-
703
-
{width="600"}
704
-
{align="center"}
705
-
706
-
A screen will appear with a lot of options - do **not** do anything on this screen.
707
-
708
-
* Click on your username (as indicated by the red rectangle) to return to your main *GitHub* URL.
709
-
710
-
{width="600"}
711
-
{align="center"}
659
+
### Delete Identifiers
712
660
713
-
You will not directly interact with your `Match-Secrets` repository.
661
+
These instructions are useful if:
714
662
715
-
### Delete Identifiers
663
+
* You messed up your TEAMID when initially setting up your app and you want to remove identifiers that may be confusing
664
+
* You built an app but no longer want it, and want to clean up the list of identifiers so it is shorter
716
665
717
666
The `Identifier` that is associated with the `Loop` identifier cannot be deleted if it is already in the *App Store* but all others can. If you attempt to delete the `XC` *Loop* identifier, you may be told it cannot be deleted because it is in use in the app store. That's OK. If a `Bundle ID` has ever been associated with an app in the *App Store*, you cannot delete the `Identifier`.
718
667
@@ -731,4 +680,4 @@ The `Identifier` that is associated with the `Loop` identifier cannot be deleted
731
680
732
681
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.
733
682
734
-
After you delete identifiers, you must add them back, configure them and create certificate before you can build again.
683
+
After you delete identifiers, you must add them back before you can build a given app. Configure them and create certificates before you can build again.
0 commit comments