Skip to content

Commit ef03e60

Browse files
authored
Update LoopDocs for release v3.14.9 (#1068)
* update releases page for v3.14.9 * update version graphic for v3.14.9 * update development page for v3.14.9, wip * update omnipod page under setup * update omnipod-faqs page * fix minor typo * update phone to required v3.14.9 or newer because of bugs in v3.14.8 * update pump page to v3.14.9 or newer because of bugs in v3.14.8 * more updates for v3.14.9; use 3 Plus for the 15-day wear version, matching Abbott * update for build_loop_auto.yml file * update for macOS 27 and drop macOS 15 * update graphics and computer page * update for newer operating systems and minimum hardware requirements * add Xcode 27 explicity request for Downloads access * update v3.14.9 notes on releases page * remove some unused graphics * Update Omnipod selection label and graphic * fix typos, update dates, etc. * wording change about compatibility
1 parent 7d94758 commit ef03e60

28 files changed

Lines changed: 284 additions & 3586 deletions

‎docs/browser/bb-errors.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,6 @@ All of these solutions are found in [Action: Build Loop Errors](#action-build-lo
153153
154154
An example annotation for skipping adding the App Group one of the Identifiers is shown in the graphic below. The App Group for `Loop-Intent-Extension` was deliberately removed to provoke that error.
155155
156-
> Unfortunatley, the automatic annotation seen here is no longer provided by the tool we use. We may get it added back later. In the meantime, you will need to search for the phrase `::error` in the log file. We'll explain that in the detailed howto section.
157-
158156
![graphic with an example build error](img/example-identifier-build-errors.png){width="800"}
159157
{align="center"}
160158
@@ -164,11 +162,15 @@ An example annotation for skipping adding the App Group one of the Identifiers i
164162
165163
The automatic build actions should occur every Sunday.
166164
167-
If your build action is disabled, you need to manually enable the action at your repository as shown in the graphic below and then launch a manual build.
165+
* If your build action is disabled, you need to manually enable the action at your repository as shown in the graphic below and then launch a manual build
166+
* Once you update to 3.14.7 or newer, you should have a new action called Build Loop Auto that restores automatic building
167+
* You can ignore the action labeled Build Loop Manual; it is left for historical reasons to enable users to keep a record of customizations they may have used in earlier versions and may be removed later.
168+
169+
The figure below is also left for historical reasons, but should not be required.
168170
169171
![fix a disabled build state](img/build-disabled-fix.png )
170172
171-
If you see this message, then follow the instructions here [https://loopkit.github.io/loopdocs/browser/automatic/#disable-automatic-actions] but select (rather than unselect) the workflow scope in order to enable automated builds.
173+
If you previously disabled building manually, then follow the instructions [here](automatic.md#disable-automatic-actions) but select (rather than unselect) the workflow scope in order to enable automated builds.
172174
173175
174176
### Rebuild: Create Certificates Error

‎docs/browser/bb-update.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
99
**For most, the *Loop* app is configured for automatic build, so you only need to come to this page if the automatic build failed.**
1010

11-
**WARNING: starting May 2025, [Manual Action for Automatic Build](automatic.md#manual-action-for-automatic-build){: target="_blank" } may be required - be sure to check monthly to see if you need to start a build manually.**
11+
**Be sure to update to the latest version of Loop - automatic build was restored for v3.14.7 and newer**
1212

1313
???+ info "Time Estimate (click to open/close)"
1414
Manually update and build the *Loop* App
@@ -257,9 +257,9 @@ The bullets below show typical messages when you are building the `main` branch.
257257
Refer to graphic below as you follow the steps to build the *Loop* app. The numbers highlighted in the graphic correspond to numbers in parentheses in the bullet list below:
258258

259259
* (1) Click on the `Actions` tab
260-
* (2) Select the `4. Build Loop` workflow on the left
260+
* (2) Select the `4. Build Loop Auto` workflow on the left
261261
* If using a mobile browser, be sure to use landscape mode to more closely match how *GitHub* looks on a computer.
262-
* If you notice your build action is disabled, you must (3) click on `Enable workflow`
262+
* If you only see `4. Build Loop` and the action is disabled, update to the latest version of `main` and return to actions, you will no longer need to do step (3) from the graphic
263263
* (4) Look on the right and click `Run workflow` to see the dropdown
264264
* (5) Click on the green `Run workflow` button in the dropdown
265265
* Wait ~25 min for the build to complete successfully
@@ -272,7 +272,9 @@ Refer to graphic below as you follow the steps to build the *Loop* app. The numb
272272

273273
If a new release is announced at [Current Release](../version/releases.md#current-release){: target="_blank" }, look to see if there are instructions about extra steps required with the release.
274274

275-
> When `Loop 3.6.0` is released, if you customized your Loop app, you may need to discard your customization and manually sync your `fork`. Check out the [Ahead and Behind](#ahead-and-behind) instructions.
275+
> When `Loop 3.14.7` was released, you needed to transfer any desired customizations from the `buld_loop.yml` file to the `build_loop_auto.yml` file. This is a one-time action, only needed for the *Loop* app. See [Automatic Build](automatic.md#automatic-build){: target="_blank" }.
276+
277+
> Check out the [Ahead and Behind](#ahead-and-behind) instructions.
276278
277279
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" }.
278280

‎docs/browser/build-yml.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
??? abstract "Section Summary (click to open/close)"
1010
1. Click on the "Actions" tab of your LoopWorkspace repository.
11-
1. On the left side, select "4. Build Loop".
11+
1. On the left side, select "4. Build Loop Auto".
1212
1. On the right side, click "Run Workflow", and tap the green `Run workflow` button.
1313
1. You have some time now. Go enjoy a coffee. The build should take about 20-30 minutes.
1414
1. You should get several emails
@@ -20,7 +20,7 @@
2020
Refer to the graphic below for the first four steps:
2121

2222
1. Click on the "`Actions`" tab of your <code>LoopWorkspace</code> repository.
23-
1. On the left side, click on "4. `Build Loop`".
23+
1. On the left side, click on "4. `Build Loop Auto`".
2424
1. On the right side, click "`Run Workflow`" to show a dropdown menu
2525
* You will see your default branch (typically `main`)
2626
* You can select a different branch, but typically, you run the default

‎docs/browser/custom-browser.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ The *Loop and Learn* team commits to maintaining these prepared customizations a
2222
Please read the documentation for these on the [Loop and Learn: Customization Select Page](https://www.loopandlearn.org/custom-code):
2323

2424
* [List of Customizations Available](https://www.loopandlearn.org/custom-code#custom-list)
25-
* When building using a browser you will be modifying one of the special files that enable the *GitHub* action to build the *Loop* app. This file is called the build_loop.yml file and can be located at your `fork` of your `LoopWorkspace` repository. There are several sections you need to review on the *Loop and Learn* page:
25+
* When building using a browser you will be modifying one of the special files that enable the *GitHub* action to build the *Loop* app. This file is called the build_loop_auto.yml file and can be located at your `fork` of your `LoopWorkspace` repository. There are several sections you need to review on the *Loop and Learn* page:
2626
* You will copy a template that you paste into that file and then edit it to keep just the customizations you want
27-
* [Overview](https://www.loopandlearn.org/custom-code-browser-build/){: target="_blank" } of how to modify the build_loop.yml file
27+
* [Overview](https://www.loopandlearn.org/custom-code-browser-build/){: target="_blank" } of how to modify the build_loop_auto.yml file
2828
* [Template for `main`](https://www.loopandlearn.org/custom-code-browser-build/#template-main){: target="_blank" }
2929
* [Template for `dev`](https://www.loopandlearn.org/custom-code-browser-build/#template-dev){: target="_blank" }
3030

‎docs/browser/edit-browser.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
!!! info "Time Estimate"
3737
* About half an hour to an hour per Module
3838
* Typically 1 or 2 Modules
39-
* Ten minutes to add patch lines to your build_loop.yml file
39+
* Ten minutes to add patch lines to your build_loop_auto.yml file
4040
* One minute to start the build
4141
* An hour before the build shows up on your phone in *TestFlight*
4242

@@ -242,7 +242,7 @@ There are 4 frames shown in this GIF; the frame number is noted at the bottom ri
242242

243243
* Frame 3 displays a green `Compare & pull request` button that would make a `Pull Request` to a `LoopKit/repository` - **do NOT click that button**
244244

245-
* Frame 4 shows how to obtain the really-long alphanumeric string (SHA-1) needed to modify your build_loop.yml file
245+
* Frame 4 shows how to obtain the really-long alphanumeric string (SHA-1) needed to modify your build_loop_auto.yml file
246246

247247
![GitHub screen while creating a customization](img/browser-customize.gif){width="750"}
248248
{align="center"}
@@ -308,15 +308,15 @@ SHA-1 = 5e9f4f407ff5544663f496d2e3a5ed8aa4f32a68
308308

309309
Warning - that is not a valid SHA-1 for this change. Do not try to copy it and use it. You must make your own personalized changes.
310310

311-
Later on, you will create the actual command needed to insert into build_loop.yml so you can add this customization when your build the app.
311+
Later on, you will create the actual command needed to insert into build_loop_auto.yml so you can add this customization when your build the app.
312312

313313
Repeat this process until you've done all your customizations for this Module and then move on to the next Module.
314314

315315
## Prepare the Customizations
316316

317-
There are two ways to use this customization. Keep reading for the method in which you edit the build_loop.yml file. If you are feeling adventurous, check out [How to use the `patches` Folder](#how-to-use-the-patches-folder){: target="_blank" }.
317+
There are two ways to use this customization. Keep reading for the method in which you edit the build_loop_auto.yml file. If you are feeling adventurous, check out [How to use the `patches` Folder](#how-to-use-the-patches-folder){: target="_blank" }.
318318

319-
Once you prepare the commands, then you will edit the build_loop.yml file of your <code>fork</code> of&nbsp;<span translate="no">LoopWorkspace</span>.
319+
Once you prepare the commands, then you will edit the build_loop_auto.yml file of your <code>fork</code> of&nbsp;<span translate="no">LoopWorkspace</span>.
320320

321321
!!! warning "Ensure your <code>fork</code> is from&nbsp;<span translate="no">LoopKit/LoopWorkspace</span>"
322322
If your&nbsp;<span translate="no">LoopWorkspace fork</span>&nbsp;did not come from&nbsp;<span translate="no">LoopKit/LoopWorkspace</span>, then delete your existing <code>fork</code> and make a new one. See [Already Have&nbsp;<span translate="no">LoopWorkspace</span>?](prepare-fork.md#already-have-loopworkspace){: target="_blank" }.
@@ -327,7 +327,7 @@ For each customization you want to include, create a pair of lines consisting of
327327

328328
### Prepare customization lines
329329

330-
Save the customization lines in your text file for later use in the build_loop.yml file.
330+
Save the customization lines in your text file for later use in the build_loop_auto.yml file.
331331

332332
``` { .sh .copy title="Customization Template:" }
333333
# Module: File: code customization description
@@ -347,17 +347,17 @@ To view the exact code change associated with that patch, open a browser at the
347347

348348
## Update&nbsp;<span translate="no">LoopWorkspace</span>
349349

350-
With the release of 3.4.x, there are two ways to use this customization. Keep reading for the method in which you edit the build_loop.yml file. If you are feeling adventurous, check out [How to use the `patches` Folder](#how-to-use-the-patches-folder){: target="_blank" }.
350+
With the release of 3.4.x, there are two ways to use this customization. Keep reading for the method in which you edit the build_loop_auto.yml file. If you are feeling adventurous, check out [How to use the `patches` Folder](#how-to-use-the-patches-folder){: target="_blank" }.
351351

352-
The final step is to update your&nbsp;<span translate="no">LoopWorkspace fork</span>&nbsp;to apply these customizations by adding those customization lines into the build_loop.yml file.
352+
The final step is to update your&nbsp;<span translate="no">LoopWorkspace fork</span>&nbsp;to apply these customizations by adding those customization lines into the build_loop_auto.yml file.
353353

354354
Return to your&nbsp;<span translate="no">GitHub fork for LoopWorkspace</span>&nbsp;and make sure to sync it if needed.
355355

356356
* Find the folder .github/workflows and click on it
357-
* Find the file build_loop.yml and click on it
357+
* Find the file build_loop_auto.yml and click on it
358358
* Click on the pencil (so you can edit this file)
359359

360-
### Add Personal Customizations to build_loop.yml
360+
### Add Personal Customizations to build_loop_auto.yml
361361

362362
Open the text file in which you saved the customization lines.
363363

@@ -378,15 +378,15 @@ It is best to leave a blank line between customizations.
378378

379379
**You must have a blank line** after the last customization and before the `# Patch Fastlane Match to not print tables` line or the build will fail.
380380

381-
**Once you are done with all the edits for build_loop.yml you will commit the changes to your <code>fork</code> directly.**
381+
**Once you are done with all the edits for build_loop_auto.yml you will commit the changes to your <code>fork</code> directly.**
382382

383-
* Once you have finished the edits for build_loop.yml
383+
* Once you have finished the edits for build_loop_auto.yml
384384
* Click on&nbsp;<span translate="no">Commit changes</span> (upper right)
385-
* Click in the larger box below&nbsp;<span translate="no">"Update build_loop.yml"</span>&nbsp;and summarize the customizations you added
385+
* Click in the larger box below&nbsp;<span translate="no">"Update build_loop_auto.yml"</span>&nbsp;and summarize the customizations you added
386386
* Click on the option to&nbsp;<span translate="no">"Commit directly to your branch"</span>
387387
* **NOTE: for&nbsp;<span translate="no">LoopWorkspace fork</span>&nbsp;- commit directly to your default branch**
388388
* Click on&nbsp;<span translate="no">Commit changes</span>
389-
* You can make as many changes to build_loop.yml in your <code>fork</code> as you want
389+
* You can make as many changes to build_loop_auto.yml in your <code>fork</code> as you want
390390

391391
When you are ready, it's time to build with your customizations.
392392

@@ -408,7 +408,7 @@ The rest of this page has additional information most people can skip.
408408

409409
### How to Use the `patches` Folder
410410

411-
With `Loop 3.4.0` and newer, you can add patches to your `GitHub-Username/LoopWorkspace` fork in the `patches` folder. Those patches will then be automatically added to your build every time without needing to modify the build_loop.yml file.
411+
With `Loop 3.4.0` and newer, you can add patches to your `GitHub-Username/LoopWorkspace` fork in the `patches` folder. Those patches will then be automatically added to your build every time without needing to modify the build_loop_auto.yml file.
412412

413413
Refer to [Prepare customization lines](#prepare-customization-lines){: target="_blank" }:
414414

‎docs/browser/intro-summary.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@
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: 4. Build Loop`](build-yml.md#build-the-loop-app){: target="_blank" }
51+
* [`Action: 4 Build Loop Auto`](build-yml.md#build-the-loop-app){: target="_blank" }
5252
* Yes we can count, but Action 3 is included in Action 4
53+
* Only the *Loop* app has the word "Auto" added - that's for historical reasons; if you are using these instructions to build another app, you will not see the word "Auto" included in the name, but it will build automatically
5354
* Phone: [Install the *Loop* app using the *TestFlight* app](phone-install.md){: target="_blank" }
5455

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

‎docs/browser/phone-install.md‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,20 +65,13 @@ If you already have the&nbsp;_<span translate="no">Loop</span>_&nbsp;app on the
6565

6666
## Automatic Update, Build, Install
6767

68-
The instructions on the [Configure to Use Browser](intro-summary.md){: target="_blank" } pages will automatically take the following actions for released versions 3.4.0 and later:
68+
The instructions on the [Configure to Use Browser](intro-summary.md){: target="_blank" } pages will automatically take the following actions for released versions 3.14.7 and later. There was a period, from May 2025 until September 2026, before adding the new file `build_loop_auto.yml` when automatic building did not work. If you have customizations in the older file `build_loop.yml`, simply copy them to `build_loop_auto.yml` to get the customizations and automatic builds once per month or when the code updates.
6969

7070
* Update the version of your&nbsp;<span translate="no">fork</span>&nbsp;within a week of a new release release
7171
* Automatically create a new build and upload it to *TestFlight*
7272
* This is only for the `default` branch, typically `main`
7373
* Build the app at least once a month and upload it to *TestFlight*
7474

75-
!!! important "You Get No Warning if Repository Build Action is Disabled"
76-
Alert - this issue is new as of May 2025. Your build action might be disabled by *GitHub*, which means you need to enable it manually.
77-
78-
If your build action is disabled, no build actually happens, no warning email is sent and a green checkmark (&#x2705;) appears beside a very short build action in which the actual build was skipped.
79-
80-
* Refer to [Manual Action for Automatic Build](automatic.md#manual-action-for-automatic-build){: target="_blank" }
81-
8275
Unless you make the recommended one-time change to [Disable Automatic Install from *TestFlight*](#disable-automatic-install-from-testflight), the default setting for each app found in *TestFlight* is to:
8376

8477
* Install each new build from *TestFlight* on the phone as soon as it is detected

‎docs/build/cgm.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@
1010

1111
- *Dexcom* G5, G6 or ONE CGM systems
1212
* *Dexcom* ONE (based off G6 sensor) is available in some countries, but will be discontinued soon
13+
* The *Anubis* Transmitters for the *Dexcom* G6 family are supported
1314
- *Dexcom* G7 or ONE+ CGM systems
1415
* *Dexcom* ONE+ (based off G7 sensor) is available in some countries
16+
* The *Stelo* variant is supported with `next-dev` branch
1517
- Some *Libre* sensors
18+
* The *Libre 3 / 3 Plus* are supported with `next-dev` branch
1619
- Eversense E3 and 365 sensors
1720

1821
!!! question "FAQs"
@@ -62,8 +65,8 @@ With Loop 3.4 and newer versions, some *Libre* CGM are supported.
6265
* These *Libre* CGM are not supported within the *Loop* app
6366
* American (Canada, US, South American) *Libre* 2
6467
* *Libre* 3
65-
* Coming soon *Libre* 3/3+ support is available in [next-dev branch](../version/development.md#updates-in-dev) for experienced users
66-
* See [CGM Customization](../faqs/cgm-faqs.md#cgm-customization){: target="_blank" }
68+
* Coming soon *Libre* 3/3 Plus support is available in [next-dev branch](../version/development.md#updates-in-dev){: target="_blank"} for experienced users
69+
* See also [CGM Customization](../faqs/cgm-faqs.md#cgm-customization){: target="_blank" }
6770

6871
## *Eversense* E3 and 365 CGM
6972
![img/eversense.png](img/eversense.png){width="150"}

0 commit comments

Comments
 (0)