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-update.md
+31-67Lines changed: 31 additions & 67 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,12 +46,11 @@
46
46
- **"What if I'm using a new/different developer account?"** If you aren't building with the same developer account used when your existing app was built, then you will be installing a brand new (second) Loop app on your phone. Your existing pod won't work with the new app, so you might want to time this transition when you are due to change pods. Delete the old app once you get the new one all set up.
47
47
- **Do I need a computer?** No.
48
48
- **Can I do this on my phone?** Yes, especially after you update your *GitHub* token to `No Expiration`.
49
-
- **Did the directions change?** Yes. We now recommend you select a *GitHub* Personal Access Token that never expires and supports automatic update and rebuild when that feature is released. It simplifies the build every 90-day process significantly.
50
49
- **How do I set my *GitHub*`Personal Access Token` to never expire and to support the automatic rebuild feature?** See this section [Regenerate Token](#regenerate-token).
51
50
- **What happens to my existing builds when I change my *GitHub* Personal Access Token?** Nothing. The <code>GH_PAT</code> only affect future builds. Previous build are available for the full 90 days.
52
51
- **Is there anything I have to do once a year?** Yes. Once a year you need to get a new `Distribution Certificate`. These only last one year. See this section [Renew Certificate](#renew-certificate)
53
52
54
-
## When to Update or Rebuild
53
+
###When to Update or Rebuild
55
54
56
55
Under ordinary circumstances, you do not *have to* rebuild or update your *Loop* app until *TestFlight* forces you to (90 days). However, there is no harm in building more frequently.
57
56
@@ -60,7 +59,7 @@ Under ordinary circumstances, you do not *have to* rebuild or update your *Loop*
60
59
* You can use *TestFlight* to quickly install the app if you loose or break your phone and need to replace it
61
60
* You can use *TestFlight* to quickly install the app if someone accidentally deletes the app from your phone
62
61
63
-
## How to Update or Rebuild
62
+
###How to Update or Rebuild
64
63
65
64
!!! abstract "Summary of Update Steps"
66
65
1. [Accept Agreements](#accept-agreements)
@@ -203,7 +202,7 @@ Open your *GitHub* account and select your <code>LoopWorkspace repository</code>
203
202
!!! question "Building a different branch"
204
203
Do I need to do anything special to build a different branch?
205
204
206
-
Yes: please follow instructions at [Build Development Version](#build-development-version)
205
+
Yes: the update steps are the same, but review information on this page: [Build Loop dev with Browser](build-dev-browser.md){: target="_blank" }
207
206
208
207
## Build the *Loop* App
209
208
@@ -318,7 +317,7 @@ Refer to graphic below as you follow the steps to build the *Loop* app.
318
317
319
318
If a new release is announced at [Current Release](../version/releases.md#current-release), look to see if there are instructions about extra steps required with the release. (The release after 3.2.3 will certainly have extra instructions.)
320
319
321
-
If you are using the dev branch, head over to [Build Development Version](#build-development-version) for information.
320
+
If you are using the dev branch, the update steps are the same, but review information on this page: [Build Loop dev with Browser](build-dev-browser.md){: target="_blank" }.
322
321
323
322
Otherwise, head over to [Errors with Browser](bb-errors.md).
324
323
@@ -365,7 +364,6 @@ Option 1: If you chose to [Disable Automatic Install from *TestFlight*](../brows
365
364
{width="300"}
366
365
{align="center"}
367
366
368
-
369
367
### Automatic Update Enabled
370
368
371
369
> We strongly recommend you toggle off Automatic Updates to allow you to be in full control over when the app is updated. This is even more important if you're using automatic builds from GitHub for version 3.3 or later.
@@ -375,7 +373,9 @@ Option 2: If you chose to enable Automatic Updates from *TestFlight* for the *Lo
375
373
* In this case, when you look at the *TestFlight* app on your phone, the app should have installed automatically
376
374
* Refer to the GIF above, the message will say `Open` instead of `Install`
377
375
378
-
## Choose Previous Build
376
+
## Other Information
377
+
378
+
### Choose Previous Build
379
379
380
380
If you are a typical user who just builds a single version for yourself or your child, you do not need to read this section.
381
381
@@ -384,38 +384,6 @@ This section provides detailed instructions if you want to choose a previous bui
384
384
* You are supporting multiple family members and may build different versions for each
385
385
* You want to test a different `branch` or set of customizations; you can install a previous build once you are done with the test
386
386
387
-
This section covers two topics.
388
-
389
-
1. Optional: [Add Test Details](#add-test-details) to the TestFlight build
390
-
2.[Select a Previous Build](#select-a-previous-build)
391
-
392
-
### Add Test Details
393
-
394
-
About half an hour after the build action completes, the new build will appear in the TestFlight screen at this link: [App Store Connect / Apps](https://appstoreconnect.apple.com/apps){: target="_blank" }
395
-
396
-
* Log in if needed
397
-
* Select your *Loop* app
398
-
* Click on the `TestFlight` tab to see a screen similar to the graphic below
399
-
400
-
{width="700"}
401
-
{align="center"}
402
-
403
-
Select the build to which you wish to add testing notes. When you tap on that icon, it opens a screen similar to that in the next graphic.
404
-
405
-
{width="700"}
406
-
{align="center"}
407
-
408
-
Click inside the box under **Test Details**. Insert the text you want to see on the phone before you install this version of the app. Tap the <code>Save</code> button at upper right and then <code>< iOS Builds</code> at upper left.
409
-
410
-
In this example, the branch and commit number are included followed by an indication that this version includes the customizations preferred by this person. Your test details can be as simple as "Use this for Charlie".
411
-
412
-
!!! tip "Commit Number"
413
-
If your build includes customizations, your commit number will not match what the developer expects to see if you need to ask for help.
414
-
415
-
Use this section [Customization and SHA-1](edit-browser.md#customization-and-sha-1) to determine the SHA-1 before customization.
416
-
417
-
### Select a Previous Build
418
-
419
387
First open the *TestFlight* app on your phone and select the *Loop* app.
420
388
421
389
Near the bottom of the screen is a row labeled previous builds.
@@ -425,36 +393,11 @@ Near the bottom of the screen is a row labeled previous builds.
425
393
* Typically you choose the most recent build for that version and click Install and then Open after installation completes
426
394
* All your settings should remain
427
395
428
-
The following graphic shows the view seen in the *TestFlight* app on the phone. By adding test details (as explained in the previous section), the desired build is clear. For most people - they will just use the most recent build. This procedure is useful for those who build often or who support multiple family members.
396
+
The following graphic shows the view seen in the *TestFlight* app on the phone. If you choose to [Add Test Details to *TestFlight*](#add-test-details-to-testflight), you can have notes show up to help you decide which version to load.
429
397
430
398
{width="300"}
431
399
{align="center"}
432
400
433
-
## *TestFlight* Expiration Warning
434
-
435
-
For version 3.3.0 and newer, the usual [*Loop* app expiration notification system](../operation/features/notifications.md#loop-app-expiration-notification) alerts the user when the app is within 20 days of expiration. In addition to that modal alert, the user can examine the bottom of the Settings screen at any time to see the expected expiration date and time.
436
-
437
-
{width="300"}
438
-
{align="center"}
439
-
440
-
## *GitHub*`Personal Access Token`
441
-
442
-
Your *GitHub*`Personal Access Token` should be configured:
443
-
444
-
*`Never expire`
445
-
*`repo, workflow` permission scope
446
-
447
-
Refer to [Modify Automatic Building](automatic.md#modify-automatic-building) if you don't want to accept the default recommendation to automatically update and build.
448
-
449
-
If you are not logged in to *GitHub* and have not logged in recently, then you may see the authentication screen when doing the steps below.
450
-
451
-
Authenticate if requested by clicking on the green `Send SMS` button or entering your password.
452
-
453
-
{width="300"}
454
-
{align="center"}
455
-
456
-
Once you are authenticated, you will have access to view your personal access token.
457
-
458
401
### Modify `Personal Access Token`
459
402
460
403
If your `Personal Access Token` has not expired but does not have the correct permission, you should modify it. Do not regenerate it.
@@ -537,6 +480,27 @@ Refer to the GIF for help. There are 3 frames.
537
480
538
481
Scroll all the way to the top of the screen and tap on your LoopWorkspace link. Then follow the [How to Update or Rebuild](#how-to-update-or-rebuild) instructions to start a new build.
539
482
540
-
## Build Development Version
483
+
### Add Test Details to *TestFlight*
484
+
485
+
About half an hour after the build action completes, the new build will appear in the TestFlight screen at this link: [App Store Connect / Apps](https://appstoreconnect.apple.com/apps){: target="_blank" }
486
+
487
+
* Log in if needed
488
+
* Select your *Loop* app
489
+
* Click on the `TestFlight` tab to see a screen similar to the graphic below
490
+
491
+
{width="700"}
492
+
{align="center"}
493
+
494
+
Select the build to which you wish to add testing notes. When you tap on that icon, it opens a screen similar to that in the next graphic.
495
+
496
+
{width="700"}
497
+
{align="center"}
498
+
499
+
Click inside the box under **Test Details**. Insert the text you want to see on the phone before you install this version of the app. Tap the <code>Save</code> button at upper right and then <code>< iOS Builds</code> at upper left.
500
+
501
+
In this example, the branch and commit number are included followed by an indication that this version includes the customizations preferred by this person. Your test details can be as simple as "Use this for Charlie".
502
+
503
+
!!! tip "Commit Number"
504
+
If your build includes customizations, your commit number will not match what the developer expects to see if you need to ask for help.
541
505
542
-
The information to build a development (`dev` or any other branch) has been moved to a new page: [Build dev with Browser](build-dev-browser.md)
506
+
Use this section [Customization and SHA-1](edit-browser.md#customization-and-sha-1) to determine the SHA-1 before customization.
0 commit comments