Skip to content

Commit af04d1a

Browse files
authored
Merge pull request #974 from marionbarker/release_3.10.0
LoopDocs for Release 3.10.0
2 parents c05bc4a + a4f0d20 commit af04d1a

16 files changed

+615
-221
lines changed

docs/browser/automatic.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,23 @@ The instructions provided for building with a browser include settings to automa
44

55
## Manual Action for Automatic Build
66

7-
!!! important "Automatic Build Requires Manual Action"
7+
!!! warning "Browser Build for *Loop* Disabled?"
8+
We do not know why, but GitHub is disabling the Build Loop Action for LoopWorkspace even though the repository is not stale.
9+
10+
If this is happening to you, see [What Manual Action is Required?](#what-manual-action-is-required).
11+
12+
* The automatic build actions should occur every Sunday
13+
* The automatic build using the same code works for all OS-AID apps except for *Loop*
14+
* See this [GitHub Discussion topic for details](https://github.com/orgs/community/discussions/181236)
15+
16+
??? tip "Stale Repositoriy Always Requires Manual Action (Click to Open Close)"
817
*GitHub* automatically **disables actions** that run according to a schedule if the repository in question is **inactive**.
918

1019
What does that mean?
1120

1221
* **inactive** means stable code (no new commit within the last 60 days)
1322
* **disables actions** means the Build Action shows up as disabled
1423

15-
!!! warning "Browser Build Disabled"
16-
We do not know why, but GitHub is disabling the Build Loop Action for LoopWorkspace even though the repository is not stale.
17-
18-
* The automatic build actions should occur every Sunday
19-
* The automatic build using the same code works for all OS-AID apps except for *Loop*
20-
* See this [GitHub Discussion topic for details](https://github.com/orgs/community/discussions/181236)
21-
2224
### What Manual Action is Required?
2325

2426
For any repository that shows the build action disabled, you should enable the action and do a manual build.
@@ -27,6 +29,7 @@ For any repository that shows the build action disabled, you should enable the a
2729
* Check that *TestFlight* has a new build of the *Loop* (or other) app
2830
* If not, go to your repository to see if the build action is disabled
2931
* If necessary, enable the build action at your repository as shown in the graphic below and then launch a manual build
32+
* If you are building any branch other than the default branch for your `fork`, don't forget to select that branch as part of Step 5 in the graphic below
3033

3134
![fix a disabled build state](img/build-disabled-fix.png )
3235

docs/browser/bb-errors.md

Lines changed: 95 additions & 49 deletions
Large diffs are not rendered by default.

docs/browser/bb-overview.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@
1111

1212
**Choose Browser Build if:**
1313

14-
* You don't have a Mac or prefer not to use one
15-
* You want automatic monthly builds (after initial setup)
16-
* You're comfortable following step-by-step instructions with multiple accounts (Apple, GitHub)
17-
* You can dedicate 2-4 hours for first-time setup (spread over several days)
14+
- [x] You don't have a Mac or prefer not to use one
15+
- [x] You want automatic monthly builds (after initial setup)
16+
- [x] You're comfortable following step-by-step instructions with multiple accounts (Apple, GitHub)
17+
- [x] You can dedicate 2-4 hours for first-time setup (spread over several days)
1818

1919
**Choose Mac Build if:**
2020

21-
* You already have an up-to-date Mac and are comfortable with Xcode
22-
* You prefer building locally without cloud services
23-
* See [Build with Mac](../build/overview.md){: target="_blank" } for Mac requirements
21+
- [x] You already have an up-to-date Mac and are comfortable with Xcode
22+
- [x] You prefer building locally without cloud services
23+
- [x] See [Build with Mac](../build/overview.md){: target="_blank" } for Mac requirements
2424

2525
## Requirements
2626

@@ -143,13 +143,19 @@ For advanced users who want cutting-edge features before official release:
143143

144144
| Feature | Browser Build | Mac Build |
145145
|---------|--------------|-----------|
146-
| **Computer Required** | Any device with browser | Mac with recent macOS |
146+
| **Device Required** | Any device with browser | Mac with recent macOS |
147147
| **Xcode Required** | No (GitHub provides) | Yes (must update regularly) |
148148
| **Initial Setup Time** | 2-4 hours over several days | 1-2 hours (if Mac is ready) |
149-
| **Monthly Updates** | Automatic | Manual via Xcode |
150-
| **Build Time** | ~1 hour (in cloud) | ~30 minutes (local) |
149+
| **Monthly Updates** | Automatic or<br>Five minutes with [Manual Actions](automatic.md#manual-action-for-automatic-build){: target="_blank"}<br>Build uploaded to TestFlight| Manual via Xcode |
150+
| **Build Time** | ~30 minutes (in cloud) | ~30 minutes (local) |
151151
| **App Expiration** | 90 days (TestFlight) | 1 year |
152152
| **Customization** | Supported | Supported |
153153

154+
**Build Frequently** Please check monthly to see if there is a newer version of the *Loop* app.
155+
156+
* Sometimes there is a new feature
157+
* Sometimes there is a required update to support the latest phone iOS
158+
* Even though a *Mac* lets you go a year between builds, you should build at least once a quarter
159+
154160
Both methods produce the identical Loop app. Choose based on your available hardware and preferences.
155161

-33.7 KB
Loading

docs/browser/intro-summary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@
4848
* [Create your version of *Loop* in `App Store` (personal use only, not for distribution)](prepare-app.md#create-loop-app-in-app-store-connect){: target="_blank" }
4949
* [Set up `Internal TestFlight Group for the App`](tf-users.md#testflight-overview){: target="_blank" }
5050
* *GitHub*:
51-
* Action: 3. Create Certificates is included in Build Action with `Loop 3.6.0`
5251
* [`Action: 4. Build Loop`](build-yml.md#build-the-loop-app){: target="_blank" }
52+
* Yes we can count, but Action 3 is included in Action 4
5353
* Phone: [Install the *Loop* app using the *TestFlight* app](phone-install.md){: target="_blank" }
5454

5555
???+ question "FAQs (click to open/close)"

docs/build/phone.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,13 @@
2222

2323
The *Loop* app requires an *Apple* device and uses the *Apple Health* app to store and retrieve your blood glucose and insulin data and to store your carbohydrate records. Older iPads do not support *Apple Health* which used to be required, and is still strongly recommended, for the *Loop* app. It may be possible to run Loop with newer iPads and newer *iOS*, but this has not been tested.
2424

25-
You need a minimum version of the mobile operating software, called the *iOS*, to be installed on your iPhone.
25+
You need a minimum version of the mobile operating software, called the *iOS*, to be installed on your iPhone. It is **strongly advised your phone hardware support and be updated to the most recent iOS**. This is for security and feature compatibility for *Loop* and companion apps.
2626

27-
* As of v3.8.x, you must use iPhone devices with *iOS* 16.1 or newer
28-
* The next release will require *iOS* 17 or newer
29-
* All phones that support *iOS* 17, also support 18 and 26
27+
!!! Danger "Update Older Phones!"
28+
Some CGM vendors are limiting which iOS versions, and therefore which phones, are supported by their apps.
29+
30+
The Compatible Device list in LoopDocs is updated to reflect that. Devices that cannot be updated to the latest iOS version are treated as incompatible.
3031

31-
* The developers maintain support for the current and one-level earlier *iOS*
32-
3332
### Compatible Device
3433

3534
All the devices listed below are currently compatible with Loop. They are separated by the available *iOS* for the phone.
@@ -59,31 +58,18 @@ These phones are compatible with *iOS* 17, 18 and 26
5958
- iPhone SE (3rd generation or later model; 2022 first release)
6059
- iPhone SE (2nd generation; 2020 first release)
6160

62-
### Older Devices
63-
64-
If you are currently using an *iOS* 16 device, plan to replace it soon. The next version of the *Loop* app will require *iOS* 17 or newer.
65-
66-
These phones are limited to *iOS* 16.
67-
68-
- iPhone X, without an extra letter
69-
- iPhone 8, all variants
70-
7161
### Not Supported
7262

73-
These phones are limited to *iOS* 15 and are no longer supported by the developers.
63+
**The [Older Devices](#older-devices) listed below are no longer supported by some CGM vendors and should be considered incompatible**
7464

75-
**Warning**: several features of the *Loop* app do not work with *iOS* 15 devices:
65+
* **Please update your phone hardware and iOS as soon as possible**
7666

77-
* The Widget does not display properly
78-
* The Mixpanel Service is not available
79-
* Some screens show up in different languages than the one selected for v3.8.0 and newer
67+
### Older Devices
8068

81-
Other features of the *Loop* app do work, but please find a newer phone soon.
69+
These phones are limited to *iOS* 16. No longer supported by *Dexcom*. Update ASAP.
8270

83-
- iPhone 7, all variants
84-
- iPhone 6s or 6s Plus, note the `s`
85-
- iPhone SE (1st generation; 2016 first release)
86-
- iPod Touch, 7th generation
71+
- iPhone X, without an extra letter
72+
- iPhone 8, all variants
8773

8874
## Find Your *iOS*
8975

@@ -132,8 +118,14 @@ Please read: [The *Loop* Phone Must be on Automatic Time](../faqs/time-faqs.md#t
132118

133119
**Please be proactive - install updates as soon as the all-clear is given for using the *Loop* app with that *iOS* update.**
134120

135-
If a limitation on your *Mac* prevents you from updating your phone to the latest *iOS*, consider using [Build with Browser](../browser/bb-overview.md).
121+
If a limitation on your *Mac* prevents you from updating your phone to the latest *iOS*, switch to using [Build with Browser](../browser/bb-overview.md).
122+
123+
!!! Important "Update While Awake and Aware"
124+
The suggestion is to turn off automatic install of updates so you can be awake and aware when you do an iOS update. Otherwise, it happens in the middle of the night.
125+
126+
For major updates, for example iOS 18 to iOS 26, we suggest you hold off until the initial bugs get worked out. In other words when iOS 26.1 was released, the OK was given for everyone to update to iOS 26. Often, that includes an update to the Loop app to accommodate changes in the phone operating system.
136127

128+
For minor updates, for example iOS 26.1 to iOS 26.2, update at your earliest convenience.
137129

138130
### Why Turn off Automatic Updates?
139131

0 commit comments

Comments
 (0)