Skip to content

Commit 5a106c9

Browse files
authored
Merge pull request #853 from marionbarker/bb_reorg
Reorganize the Browser Build Section of LoopDocs
2 parents 9ebb1af + bd0bbbb commit 5a106c9

File tree

147 files changed

+1574
-1671
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

147 files changed

+1574
-1671
lines changed

docs/gh-actions/automatic.md renamed to docs/browser/automatic.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Overview
22

3-
The instructions on the [Configure to Use Browser](gh-first-time.md) page will, unless you make a change, automatically update and build for you.
3+
The instructions provided for building with a browser include settings to automatically update and build for you.
44

55
This keeps the most recent version of the *Loop* app available in *TestFlight* for you to install when you are ready.
66

@@ -12,12 +12,12 @@ These events are automatically scheduled:
1212

1313
If you do not want this automatic schedule, you can modify it.
1414

15-
Regardless of your choice, please [Disable Automatic Installation from *TestFlight*](gh-deploy.md#disable-automatic-install-from-testflight){: target="_blank" }. You should be alert any time your *Loop* app is updated. Check that all settings are maintained and pay attention to make sure the app behavior is nominal.
15+
Regardless of your choice, please [Disable Automatic Installation from *TestFlight*](phone-install.md#disable-automatic-install-from-testflight){: target="_blank" }. You should be alert any time your *Loop* app is updated. Check that all settings are maintained and pay attention to make sure the app behavior is nominal.
1616

1717
You still need to **take these actions** to ensure a recent build of the *Loop* app is available in *TestFlight* for you to install on your phone when you choose:
1818

1919
* Keep your *Apple Developer* account up to date with agreements signed
20-
* [Renew Certificate](gh-update.md#renew-certificate){: target="_blank" } once a year
20+
* [Renew Certificate](bb-update.md#renew-certificate){: target="_blank" } once a year
2121

2222
### Successful Weekly Action
2323

@@ -148,11 +148,11 @@ If you choose not to have automatic building enabled, be sure the `GH_PAT` has `
148148
What if I decide I don't want the automatic building feature?
149149

150150
* If you are using the released version of Loop, please leave automatic building running
151-
* Please read [TestFlight Automatic Updates](gh-deploy.md#automatic-update-build-install) on how to configure TestFlight so you choose when the updated app gets installed on your phone
151+
* Please read [TestFlight Automatic Updates](phone-install.md#automatic-update-build-install) on how to configure TestFlight so you choose when the updated app gets installed on your phone
152152
* Otherwise, you may see the dreaded "Loop Beta has expired" message, have a Loop that won't open and not have a version ready to go in TestFlight that you can install within a few seconds
153153

154154
* If you are taking a break from Loop and want to stop monthly Build emails, consider disabling actions for the `Build Loop` action for your app.
155155
* [GitHub Directions to Disable and Enable a Workflow](https://docs.github.com/en/actions/using-workflows/disabling-and-enabling-a-workflow#disabling-a-workflow){: target="_blank" }
156156
* It is the Build action that kicks off the update and build steps, so simply disabling the one action is sufficient
157157

158-
* If you are done with Loop, you can delete the whole repository; but you should be sure about this because you'll need to start over with [Configure to Use Browser](gh-first-time.md) to restore ability to build Loop with GitHub.
158+
* If you are done with Loop, you can delete the whole repository; but you should be sure about this because you'll need to start over with [Configure to use Browser](bb-overview.md#configure-to-use-browser) to restore ability to build Loop with GitHub.

docs/gh-actions/gh-errors.md renamed to docs/browser/bb-errors.md

Lines changed: 42 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,19 @@ But first - try to diagnose it yourself using this page.
2323
!!! warning "Just updated?"
2424
If you just updated to version 3.4 from version 3.2.x, you must add a new Identifier.
2525

26-
If you missed this step - go do it now. [Update from 3.2.x to 3.4](gh-update.md#update-from-32x-to-34){: target="_blank" }
26+
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" }
2727

2828
!!! important "Certificate is missing"
2929
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.
3030

31-
* See [Renew Certificates](gh-update.md#renew-certificate){: target="_blank" }
31+
* See [Renew Certificates](bb-update.md#renew-certificate){: target="_blank" }
3232

3333
These are some of the most common errors to date.
3434

3535
1. You made a spelling error when adding <code>Secrets</code>
3636
* Each secret must be spelled exactly the way it is presented in the instructions
3737
* If you are using an automatic translation, please keep an original page open too and copy from it to make sure there are no spelling errors in the secret name
38-
1. You did not add the `App Group Identifier` to all 4 of the required identifiers in this step: [Add `App Group` to `Identifiers`](gh-first-time.md#add-app-group-to-identifiers){: target="_blank" }
38+
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" }
3939
* See [Annotation without Clear Message (*Build*)](#annotation-without-clear-message-build) for an example of this kind of failure
4040
1. You used a smart editor instead of a text-only editor to save your information
4141
* It only takes one letter to be changed from lower-case to upper-case by your smart editor to ruin your day
@@ -90,7 +90,7 @@ This is an example of a message that is not terribly descriptive - which is why
9090

9191
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`.
9292

93-
* See [Renew Certificates](gh-update.md#renew-certificate){: target="_blank" }
93+
* See [Renew Certificates](bb-update.md#renew-certificate){: target="_blank" }
9494

9595

9696
![graphic showing missing distribution certificate](img/missing-distribution-certificate.png){width="800"}
@@ -215,22 +215,20 @@ If that phrase is found, then:
215215
* You have already created a *Loop* App in the *App Store* with that incorrect `TEAMID`
216216
* This is true if you completed the steps after running Action: `Add Identifiers` and before Action: `Create Certificates`
217217
218-
Follow these steps:
218+
Click on this link to [Delete Identifiers](#delete-identifiers).
219219
220-
!!! tip "Open each link below in a separate tab"
221-
It is best to open each link below in a separate tab so you can return to this list and keep using the links in each step.
220+
- Delete all the other identifiers first, then try to delete the *Loop* identifier with the wrong <code>TEAMID</code>
221+
- It is fine to just ignore identifiers with the wrong <code>TEAMID</code>, but do not use them
222222
223-
1. Delete all the identifiers that you can, following the steps in [Configure to Use Browser: Delete Identifiers](gh-first-time.md#delete-identifiers)
224-
- Delete all the other identifiers first, then try to delete the *Loop* identifier with the wrong <code>TEAMID</code>
225-
- It is fine to just ignore identifiers with the wrong <code>TEAMID</code>, but do not use them
223+
#### Rerun Steps with correct TEAMID
226224
227225
1. Enter your `TEAMID` correctly in the repository `Secrets`
228226
- Make sure you use copy and paste from your [Apple Developer Membership](https://developer.apple.com/account/#!/membership){: target="_blank" } page for that `TEAMID`.
229-
- Follow the update instructions here (this example is for `GH_PAT`, you'll do the same but for `TEAMID`) [Update Secrets](gh-update.md#update-secrets)
227+
- Follow the update instructions here (this example is for `GH_PAT`, you'll do the same but for `TEAMID`) [Update Secrets](bb-update.md#update-secrets)
230228
231-
1. Run Action: [Configure to Use Browser: `Add Identifiers`](gh-first-time.md#add-identifiers) again
229+
1. Run Action: [Configure to Use Browser: `Add Identifiers`](identifiers.md#add-identifiers) again
232230
233-
1. Follow all the steps in this section with the **correct** `TEAMID` [Configure to Use Browser: Configure Identifiers for Loop](gh-first-time.md#configure-identifiers-for-loop) but when you get to the [Configure to Use Browser: Create Loop App in App Store Connect](gh-first-time.md#create-loop-app-in-app-store-connect), you need to return to this page and follow the instructions below to remove the app and add a new one.
231+
1. Follow all the steps in this section with the **correct** `TEAMID` [Configure to Use Browser: Configure Identifiers for Loop](prepare-app.md#configure-identifiers-for-loop) but when you get to the [Configure to Use Browser: Create Loop App in App Store Connect](prepare-app.md#create-loop-app-in-app-store-connect), you need to return to this page and follow the instructions below to remove the app and add a new one.
234232
235233
The first time through, you created an app with a `Bundle ID` that does NOT include your `TEAMID`.
236234
@@ -258,15 +256,15 @@ That *App* with the wrong `Bundle ID` remains in the *App store* but it is hidde
258256
259257
Now click on the `Add Apps` button or the :heavy_plus_sign: (plus sign) if you have other apps in the *App Store*.
260258
261-
Follow the [Configure to Use Browser: Create Loop App in App Store Connect](gh-first-time.md#create-loop-app-in-app-store-connect) directions with these additions:
259+
Follow the [Configure to Use Browser: Create Loop App in App Store Connect](prepare-app.md#create-loop-app-in-app-store-connect) directions with these additions:
262260
263261
* You must come up with a new name for your *Loop* App
264262
* Triple-check that the `Bundle ID` you choose is for *Loop* and contains your `TEAMID`, it should look like: `com.TEAMID.loopkit.Loop`
265263
* You must come up with a new `SKU` for your *Loop* App (try `1234`, if you used `123` before)
266264
267265
#### Create Certificates
268266
269-
You should be able to continue with the [Configure to Use Browser Steps to `Create Certificates`](gh-first-time.md#create-certificates) and then proceed from there with `Build Loop` and keep going.
267+
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.
270268
271269
### Error: Missing Repository Access
272270
@@ -289,7 +287,7 @@ If you see this phrase, the `fastlane` package that is utilized during the `3. C
289287
To fix this error:
290288
291289
- Open this link: [https://github.com/settings/tokens/](https://github.com/settings/tokens/){: target="_blank" }
292-
- Here you will see your personal access token (`Fastlane Access Token`) that was created during [Configure to Use Browser: Setup *GitHub*: Create `GitHub Personal Access Token`](../gh-actions/gh-first-time.md#create-github-personal-access-token)
290+
- Here you will see your personal access token (`Fastlane Access Token`) that was created during [Configure to Use Browser: Setup *GitHub*: Create `GitHub Personal Access Token`](../browser/secrets.md#create-github-personal-access-token)
293291
- Note that `Tokens (classic)` is highlighted in the menu on the left
294292
- Click on the token name (should be bold, blue **`Fastlane Access Token`** ) to open its detail page
295293
- None of the checkboxes under **`Select Scopes`** will be checked – this is what's causing the issue.
@@ -304,7 +302,7 @@ NOTE: for next release or if using the dev branch - you want <code>GH_PAT</code>
304302
305303
#### Create Certificates
306304
307-
You should be able to continue with the [Configure to Use Browser Steps to `Create Certificates`](gh-first-time.md#create-certificates) and then proceed from there with `Build Loop` and keep going.
305+
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.
308306
309307
### Error: Could not create
310308
@@ -377,7 +375,7 @@ Copy the words on the line below and paste them into the search function for you
377375
378376
If that phrase is found, then:
379377
380-
* Make sure you completed the [Create Loop App in App Store Connect](gh-first-time.md#create-loop-app-in-app-store-connect) Step
378+
* Make sure you completed the [Create Loop App in App Store Connect](prepare-app.md#create-loop-app-in-app-store-connect) Step
381379
* Once you've resolved that step, run these *Actions* again:
382380
* `Create Certificates`
383381
* `Build Loop`
@@ -410,7 +408,7 @@ For example, you might see:
410408
* `error: Provisioning profile "match AppStore com.***.loopkit.Loop.statuswidget`
411409
* `error: Provisioning profile "match AppStore com.***.loopkit.Loop.Loop-Intent-Extension`
412410
413-
Return to [First-Time: Identifiers for the `Loop` app](gh-first-time.md#identifiers-for-the-loop-app) and make sure you followed all the steps.
411+
Return to [First-Time: Identifiers for the `Loop` app](prepare-app.md#identifiers-for-the-loop-app) and make sure you followed all the steps.
414412
415413
You must create certificates again before you can build *Loop*:
416414
@@ -438,7 +436,7 @@ If that phrase is found with lines similar to the following:
438436
[31m- 'AppStore_com.NOT_YOUR_TEAMID.loopkit.Loop.LoopWatch.watchkitextension.mobileprovision'
439437
```
440438
441-
This tells you, the `Bundle ID` you selected in [First-Time: Create Loop App in App Store Connect](gh-first-time.md#create-loop-app-in-app-store-connect) does NOT have your `TEAMID` embedded in the name.
439+
This tells you, the `Bundle ID` you selected in [First-Time: Create Loop App in App Store Connect](prepare-app.md#create-loop-app-in-app-store-connect) does NOT have your `TEAMID` embedded in the name.
442440
443441
Once you have created an app in the *App Store* that is not based on your `TEAMID`, you cannot delete it, but you can Remove it (i.e. hide it so that it is no longer visible on this page and you don't accidentally click on it).
444442
@@ -450,7 +448,7 @@ Once you have created an app in the *App Store* that is not based on your `TEAMI
450448
* Tap on `Remove App`
451449
* New dialog window appears, select `Remove`
452450
453-
At this point, get your correct `TEAMID`, fix your Secrets file to have the correct `TEAMID` and then return to [First-Time: Configure Secrets](gh-first-time.md#configure-secrets). This time you will be updating `TEAMID` in the repository secret list.
451+
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 repository secret list.
454452
455453
## Repeat `Build Loop` Errors
456454
@@ -474,7 +472,7 @@ Copy the words on the line below and paste them into the search function for you
474472
> Could not download/upload from App Store Connect
475473
> ```
476474
477-
Solution: Update your fork. See instructions on the Update page: [Update `Fork`](gh-update.md#update-fork){: target="_blank" }
475+
Solution: Update your fork. See instructions on the Update page: [Update `Fork`](bb-update.md#update-fork){: target="_blank" }
478476
479477
### Intermittent TestFlight Upload Number Error
480478
@@ -587,7 +585,7 @@ This is not the first thing to try, but sometimes it is the best approach.
587585
588586
There might be several reasons to do this:
589587
590-
* You lost your <code>MATCH_PASSWORD</code> and want to build one of the [Other Apps](gh-other-apps.md)
588+
* You lost your <code>MATCH_PASSWORD</code> and want to build one of the [Other Apps](other-apps.md)
591589
* You thought you entered the correct <code>MATCH_PASSWORD</code> but you are getting [Error: Could not decrypt](#error-could-not-decrypt)
592590
* You are having trouble renewing your certificates after using Browser Build for a year
593591
@@ -659,3 +657,24 @@ A screen will appear with a lot of options - do **not** do anything on this scre
659657
{align="center"}
660658
661659
You will not directly interact with your `Match-Secrets` repository.
660+
661+
### Delete Identifiers
662+
663+
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`.
664+
665+
* Open this link: [Certificates, Identifiers & Profiles: Identifiers List](https://developer.apple.com/account/resources/identifiers/list){: target="_blank" } on the *Apple Developer* site.
666+
* Use the graphic below as a guide to removing identifiers
667+
* Keep repeating the steps until you've removed all the identifiers you can (or want to) delete
668+
* It is OK to delete an identifier even if it does have your correct `TEAMID`
669+
* If you try to delete the `Loop` identifier with your `TEAMID`, it will refuse, don't worry, just keep going
670+
* Note - this graphic indicates where on this page you can find your `TEAMID`
671+
* If you notice an identifier with a value embedded in it that does not have your `TEAMID`, then delete it if you can and [Update <code>Secrets</code>](bb-update.md#update-secrets){: target="_blank"} with your correct `TEAMID`
672+
* If you try to delete a Loop identifier that does not have your `TEAMID`, but you already added to the *App Store*, it will refuse, don't worry, just keep going
673+
* Delete all the other identifiers first that have the same incorrect `TEAMID` and then try to delete the Loop identifier with the incorrect `TEAMID`
674+
675+
![steps to delete a given identifier](img/delete-identifiers.svg){width="700"}
676+
{align="center"}
677+
678+
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.
679+
680+
After you delete identifiers, you must add them back, configure them and create certificate before you can build again.

0 commit comments

Comments
 (0)