Skip to content

Commit 36b49fe

Browse files
authored
Merge pull request #909 from marionbarker/working-docs
Update the Browser Build errors page
2 parents 377ce75 + 86c97e3 commit 36b49fe

File tree

8 files changed

+229
-108
lines changed

8 files changed

+229
-108
lines changed

docs/browser/bb-errors.md

Lines changed: 198 additions & 82 deletions
Large diffs are not rendered by default.

docs/browser/certs.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@ Once you see the green check mark by `Create Certificates`, the next step is to
3838

3939
### Failure
4040

41-
If this action fails, head over to the errors page. Review these links, identify and fix your error or ask for help.
42-
43-
* [How to Ask for Help](bb-errors.md#help-with-errors){: target="_blank" }
44-
* [Most Common Mistakes](bb-errors.md#most-common-mistakes){: target="_blank" }
45-
* [Create Certificates Errors](bb-errors.md#action-create-certificates-errors){: target="_blank" }.
41+
* If you see the red `X` (:octicons-x-circle-fill-16:{: .failed }):
42+
* Use the Browser Build Errors page to resolve the error, then repeat the Action
43+
* [Quick Reference for Browser Build Errors](bb-errors.md#quick-reference-for-browser-build-errors){: target="_blank" }

docs/browser/identifiers.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,8 @@ The `Validate Secrets` &nbsp;<span class=notranslate>Action</span>&nbsp; should
5454

5555
* If you see the green check (:octicons-check-circle-fill-16:{: .passed }) continue to the next section
5656
* If you see the red `X` (:octicons-x-circle-fill-16:{: .failed }):
57-
* [Examine Annotation](bb-errors.md#examine-annotation){: target="_blank" } tells how to view the file needed to diagnose your problem.
58-
* [Action: Validate Secrets Errors](bb-errors.md#action-validate-secrets-errors){: target="_blank" } tells you what to search for in the file
59-
* Resolve the error and repeat the Action: [Validate Secrets](#validate-secrets)
57+
* Use the Browser Build Errors page to resolve the error, then repeat the Action
58+
* [Quick Reference for Browser Build Errors](bb-errors.md#quick-reference-for-browser-build-errors){: target="_blank" }
6059

6160
!!! important "Ask For Help Early"
6261
Please if you are having trouble - [ask for help early by clicking on this link](bb-errors.md#help-with-errors){: target="_blank" }.
@@ -96,9 +95,8 @@ The `Add Identifiers` &nbsp;<span class=notranslate>Action</span>&nbsp; should s
9695

9796
* If you see the green check (:octicons-check-circle-fill-16:{: .passed }) continue to the next section
9897
* If you see the red `X` (:octicons-x-circle-fill-16:{: .failed }):
99-
* [Examine Annotation](bb-errors.md#examine-annotation){: target="_blank" } tells how to view the file needed to diagnose your problem.
100-
* [Action: Add Identifiers Errors](bb-errors.md#action-add-identifiers-errors){: target="_blank" } tells you what to search for in the file
101-
* Resolve the error and repeat the Action: [Add Identifiers](#add-identifiers)
98+
* Use the Browser Build Errors page to resolve the error, then repeat the Action
99+
* [Quick Reference for Browser Build Errors](bb-errors.md#quick-reference-for-browser-build-errors){: target="_blank" }
102100

103101
!!! important "Ask For Help Early"
104102
Please if you are having trouble - [ask for help early by clicking on this link](bb-errors.md#help-with-errors){: target="_blank" }.

docs/browser/img/add-variable.png

156 KB
Loading
48.3 KB
Loading
Loading

docs/browser/other-apps.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,8 @@ The `Validate Secrets` &nbsp;<span class=notranslate>Action</span>&nbsp; should
143143

144144
* If you see the green check (:octicons-check-circle-fill-16:{: .passed }) continue to the next section
145145
* If you see the red `X` (:octicons-x-circle-fill-16:{: .failed }):
146-
* [Examine Annotation](bb-errors.md#examine-annotation){: target="_blank" } tells how to view the file needed to diagnose your problem.
147-
* [Action: Validate <code>Secrets</code> Errors](bb-errors.md#action-validate-secrets-errors){: target="_blank" } tells you what to search for in the file
148-
* Resolve the error and repeat the Action: [Validate <code>Secrets</code>](#validate-secrets)
146+
* Use the Browser Build Errors page to resolve the error, then repeat the Action
147+
* [Quick Reference for Browser Build Errors](bb-errors.md#quick-reference-for-browser-build-errors){: target="_blank" }
149148

150149
## Add Identifiers
151150

@@ -171,9 +170,8 @@ The `Add Identifier` &nbsp;<span class=notranslate>Action</span>&nbsp; should su
171170

172171
* If you see the green check (:octicons-check-circle-fill-16:{: .passed }) continue to the next section
173172
* If you see the red `X` (:octicons-x-circle-fill-16:{: .failed }):
174-
* [Examine Annotation](bb-errors.md#examine-annotation){: target="_blank" } tells how to view the file needed to diagnose your problem
175-
* [Action: Add Identifiers Errors](bb-errors.md#action-add-identifiers-errors){: target="_blank" } tells you what to search for in the file
176-
* Resolve the error and repeat the Action: [Add Identifiers](identifiers.md#add-identifiers)
173+
* Use the Browser Build Errors page to resolve the error, then repeat the Action
174+
* [Quick Reference for Browser Build Errors](bb-errors.md#quick-reference-for-browser-build-errors){: target="_blank" }
177175

178176
## Review App Identifier
179177

@@ -351,8 +349,10 @@ Refer to the graphic below for the numbered steps:
351349
{align="center"}
352350

353351
1. Wait a minute or two for the action to finish
354-
* If this action fails, head over to [Action: Create Certificates Errors](bb-errors.md#action-create-certificates-errors)
355-
* Once you've resolved the error, repeat the Actions [Add Identifiers](identifiers.md#add-identifiers) and then Create Certificates. (The Add Identifiers might not be required but it is fast and should be done as a matter of routine.)
352+
* If you see the green check (:octicons-check-circle-fill-16:{: .passed }) continue to the next section
353+
* If you see the red `X` (:octicons-x-circle-fill-16:{: .failed }):
354+
* Use the Browser Build Errors page to resolve the error, then repeat the Action
355+
* [Quick Reference for Browser Build Errors](bb-errors.md#quick-reference-for-browser-build-errors){: target="_blank" }
356356

357357
## Build App
358358

@@ -387,12 +387,12 @@ Refer to the graphic below for the first four steps:
387387
{align="center"}
388388

389389
1. Wait a few minutes to make sure there is not an early failure
390-
* If this action fails, head over to [Action: Build Loop Errors](bb-errors.md#action-build-loop-errors)
391-
* Once you've resolved the error, it's a good idea to repeat all three steps in this order:
392-
* [Add Identifiers](identifiers.md#add-identifiers)
393-
* Create Certificates
394-
* Build Loop
395-
1. If the process appears to be happening without an error, go do something else for a while. The build should take about 20-30 minutes.
390+
* If you see the red `X` (:octicons-x-circle-fill-16:{: .failed }):
391+
* Use the Browser Build Errors page to resolve the error, then repeat the Action
392+
* [Quick Reference for Browser Build Errors](bb-errors.md#quick-reference-for-browser-build-errors){: target="_blank" }
393+
1. If the process appears to be happening without an error, go do something else for a while. The build should take less than half an hour (these tend to build faster than the *Loop* app.
394+
* When you see the green check (:octicons-check-circle-fill-16:{: .passed }) continue
395+
* If there is a late-appearing error, then use [Quick Reference for Browser Build Errors](bb-errors.md#quick-reference-for-browser-build-errors){: target="_blank" }
396396
1. Your app should eventually appear on [App Store Connect](https://appstoreconnect.apple.com/apps){: target="_blank" }.
397397

398398
### Build Errors

docs/browser/prepare-fork.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,11 +205,20 @@ This is a new step required with `Loop 3.6.0` and newer versions. It provides au
205205
ENABLE_NUKE_CERTS
206206
```
207207

208-
What did you just do?
208+
What will this accomplish?
209209

210210
* Certificates will be automatically updated if you have configured this `Variable`
211211
* With `Loop 3.6.0` and newer versions, as long as your *Apple* developers license is valid and all agreements are signed: **you can skip the steps to create or renew your certificates**!
212212

213+
Not sure how to get to the Variables screen. Review the two graphics.
214+
215+
This graphic shows how to access Variables for a repository (similar steps required for an organization).
216+
217+
![steps to add a variable](img/add-variable.png){width="600"}
218+
{align="center"}
219+
220+
This graphic shows how to add the `ENABLE_NUKE_CERTS` to an organization. Be sure that Repository access is set to `Public repositories`. When adding this to a repository, that option is not shown.
221+
213222
![enable nuke certs](img/gh-nuke-certs.png){width="700"}
214223
{align="center"}
215224

0 commit comments

Comments
 (0)