Skip to content

Commit 20e24e3

Browse files
committed
remove old 3.2 to 3.4 section, update Variable addition in more places
1 parent 709dfb2 commit 20e24e3

File tree

3 files changed

+27
-93
lines changed

3 files changed

+27
-93
lines changed

docs/browser/bb-update.md

Lines changed: 9 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66

77
> Regardless of build method, this is an **update** and will install over your existing app; your **settings are maintained including your current CGM and Pump.**
88
9+
**For most, the *Loop* app is configured for automatic build, so you only need to come to this page if the automatic build failed.**
10+
911
???+ info "Time Estimate (click to open/close)"
10-
Build the *Loop* App
12+
Manually update and build the *Loop* App
1113

1214
- 5 min: Check *Apple* account status
1315
- Check if you need to renew certificates (once a year only)
@@ -21,6 +23,7 @@
2123

2224
* 5 min: Clear out expired certificates
2325
* 5 min: Generate new certificates
26+
> When Loop 3.6.0 is released, certificate renewal will be automatic once you [Add Variable](prepare-fork.md#add-variable){: target="_blank" }
2427

2528
One Time: Complete the information for the Digital Service Act Compliance
2629

@@ -32,7 +35,6 @@
3235

3336
Most users will start at [How to Update or Rebuild](#how-to-update-or-rebuild):
3437

35-
* If currently using verion 3.2.3 or earlier, there are manual steps included to update to 3.4
3638
* If currently using verion 3.4.0 or later, builds are automatic but you still need to do some actions:
3739
* Your *Apple Developer* account must be active
3840
* All agreements must be signed for your *Apple Developer* account
@@ -115,6 +117,8 @@ Digital Service Act Compliance
115117

116118
> This is Step 2 of 6 - it is only needed once a year - you should get an email from Apple 30 days before your `Distribution Certificate` expires. (Don't worry if you did not see the email.)
117119
120+
> If you have not added the `Variable` `ENABLE_NUKE_CERTS`, do it now. See [Add Variable](prepare-fork.md#add-variable){: target="_blank" }. Once `Loop 3.6.0` is released, your fork is updated and you set up that variable, you can skip this step - it will be automatic.
121+
118122
**Apps in TestFlight are not affected when a certificate expires or is revoked.**
119123

120124
* Apps installed on the phone continue to run
@@ -222,95 +226,6 @@ The bullets below show typical messages when you are building the `main` branch.
222226

223227
> This is Step 4 of 6 - this is always required.
224228
225-
### Update from 3.2.x to 3.4
226-
227-
For the update from 3.2.x to 3.4, you must do more than "just" build. If you skip this step - the build will fail.
228-
229-
* The `Identifier` for the "`widget`" changed from "`SmallStatusWidget`" to the more descriptive "`LoopWidgetExtension`"
230-
231-
> If you built version 3.3.0 (the `dev branch` before release of version 3.4) or newer, you can skip ahead to [Build the App](#build-the-app).
232-
233-
You will (1) run [`Add Identifiers`](#add-identifiers), (2) [add the `App Group`](#add-app-group-to-new-identifier) to the new identifier, (3) run [`Create Certificates`](#create-certificates) and then (4) run [`Build Loop`](#build-the-app).
234-
235-
#### Add Identifiers
236-
237-
In your fork of LoopWorkspace:
238-
239-
* Run the Action: `Add Identifier`
240-
* Wait for it to succeed
241-
242-
??? tip "Detailed instructions for `Add Identifier` (Click to open/close)"
243-
Refer to the graphic below for the numbered steps:
244-
245-
1. Click on the `Actions` tab of your <code>LoopWorkspace</code> repository
246-
1. On the left side, click on 2. <code>Add Identifiers</code>
247-
1. On the right side, click `Run Workflow` to show a dropdown menu
248-
* You will see your default branch (typically this is `main`)
249-
1. Tap the green button that says `Run workflow`.
250-
251-
![add identifiers using github actions](img/action-02-add-identifiers.svg){width="700"}
252-
{align="center"}
253-
254-
The `Add Identifiers` &nbsp;<span class=notranslate>Action</span>&nbsp; should succeed or fail in a few minutes. Do not continue to the next step until this one succeeds.
255-
256-
* If you see the green check (:octicons-check-circle-fill-16:{: .passed }) continue to the next section
257-
* If you see the red `X` (:octicons-x-circle-fill-16:{: .failed }):
258-
* [Action: Add Identifiers Errors](bb-errors.md#action-add-identifiers-errors){: target="_blank" } tells you what to search for in the file
259-
* Resolve the error and repeat `Add Identifiers`
260-
261-
#### Add `App Group` to New `Identifier`
262-
263-
Open the [Certificates, Identifiers & Profiles: Identifiers List](https://developer.apple.com/account/resources/identifiers/list){: target="_blank" } page.
264-
265-
Click on the "`LoopWidgetExtension`" identifier to open the `Edit Your App ID Configuration` screen.
266-
267-
| `NAME` | `IDENTIFIER` |
268-
|-------|------------|
269-
| `Loop Widget Extension` | `com.TEAMID.loopkit.Loop.LoopWidgetExtension` |
270-
271-
The graphic below has numbered steps that match these directions:
272-
273-
1. Looking at the `App Services` column, scroll down to the `App Groups` row and ensure the check box (under the `Capabilities column`) for `App Groups` is checked
274-
2. If the word `Configure` shows up, tap on it
275-
* This opens the `App Group Assignment` screen
276-
* If it said `Edit` instead of `Configure` - you can click to confirm you have the correct App Group but won't need to continue or save if it is correct
277-
3. Check the box by `Loop App Group` that uses your `TEAMID` in `group.com.TEAMID.loopkit.LoopGroup`
278-
* Note that if you previously built with Xcode, the name may be different, i.e., `XC group com TEAMID loopkit LoopGroup`
279-
4. Tap `Continue`
280-
5. Tap `Save`
281-
282-
![graphic showing selection of the correct App Group](img/update-identifier-loop-3-4.png){width="700"}
283-
{align="center"}
284-
285-
If you did not need to make changes, the `Save` button will not be active.
286-
287-
* Tap on the `< All Identifiers` link at the top left
288-
289-
The full list of Identifiers should be displayed again.
290-
291-
!!! note "Other Identifiers"
292-
All other identifiers should be already set up.
293-
294-
* If they are not, refer to [Configure to Use Browser: Add App Group to Identifiers](prepare-app.md#add-app-group-to-identifiers){: target="_blank" }
295-
296-
#### Create Certificates
297-
298-
You must run the action `Create Certificates` again because the `Identifiers` were updated. Wait for this to succeed before trying to build.
299-
300-
???+ tip "Detailed instructions (Click to open/close)"
301-
Refer to the graphic below for the numbered steps:
302-
303-
1. Click on the "<code>Actions</code>" tab of your <code>LoopWorkspace</code> repository
304-
1. On the left side, click on "`Create Certificates`"
305-
1. On the right side, click "`Run Workflow`" to show a dropdown menu
306-
* You will see your default branch (typically `main`)
307-
1. Tap the green button that says "`Run workflow`".
308-
309-
![create certificates using github actions](img/action-03-create-certs.svg){width="700"}
310-
{align="center"}
311-
312-
1. Wait a minute or two for the action to finish
313-
314229
#### Build the App
315230

316231
Refer to graphic below as you follow the steps to build the *Loop* app.
@@ -328,7 +243,9 @@ Refer to graphic below as you follow the steps to build the *Loop* app.
328243

329244
#### What if the Build Fails
330245

331-
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. ([Updating from 3.2.3 to 3.4.x](#update-from-32x-to-34) requires extra steps described above.)
246+
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.
247+
248+
> 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.
332249
333250
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" }.
334251

docs/browser/other-apps.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ The same technique is used and the same six <code>Secrets</code> are used for ma
1717

1818
If you are coming to this page to update one of the other apps, follow the [How to Update or Rebuild](bb-update.md#how-to-update-or-rebuild){: target="_blank" } instructions provided for the *Loop* app, but substitute the repository name for the app you want to rebuild for all references to&nbsp;*<span translate="no">LoopWorkspace</span>*.
1919

20+
> If you have not added the `Variable` `ENABLE_NUKE_CERTS`, do it now. See [Add Variable](prepare-fork.md#add-variable){: target="_blank" }.
21+
2022
### Multiple Copies of `LoopFollow`
2123

2224
For the convenience of caregivers who use `LoopFollow` to monitor multiple people, updates were added in v2.1.2 to make this more convenient. This works regardless of the build method. (Build with Browser or [Build with *Mac*](https://www.loopandlearn.org/loop-follow#lf-script){: target="_blank" }).
@@ -52,6 +54,18 @@ You will return to this page after reviewing (but not doing) this step [Configur
5254
| <span translate="no">LoopCaregiver</span> | [https://github.com/LoopKit/LoopCaregiver](https://github.com/LoopKit/LoopCaregiver){: target="_blank" } | [LoopDocs: <span translate="no">LoopCaregiver</span>](../nightscout/loop-caregiver.md) |
5355
| <span translate="no">LoopFollow</span> | [https://github.com/loopandlearn/LoopFollow](https://github.com/loopandlearn/LoopFollow){: target="_blank" } | [<span translate="no">LoopFollow</span>](https://www.loopandlearn.org/loop-follow){: target="_blank" }|
5456

57+
??? tips "LoopFollow Builders: Display Name (Click to Open/Close)"
58+
* Would you like the name of your LoopFollow app to be personalized?
59+
* Do you have more than one Looper, so you are using LoopFollow_Second or LoopFollow_Third?
60+
* The 3 LoopFollow repositories enable you to customize the name shown on your phone
61+
62+
In your *GitHub* repository, find the file named: `LoopFollowDisplayNameConfig.xcconfig`
63+
64+
* Open it in your browser
65+
* Follow the directions to change `display_name`
66+
* "Save the file" means commit the change to your `main` branch
67+
* It is recommended that you use LF_name, where name is the customized name - that way you can find it in an alphabetic list of apps
68+
5569
The two repositories below are only if you need to follow a second or third looper. All others should use just the table above. The instructions for the second and third looper are otherwise identical to the first looper. Note that `LoopCaregiver` can follow multiple Loopers; you select the person inside the app.
5670

5771
| Special Case | Fork from this Address |
@@ -100,6 +114,8 @@ Open the text file in which you maintain a copy of your 6 <code>Secrets</code> s
100114

101115
Once all six <code>Secrets</code> are added, proceed to the first Action to validate your secrets.
102116

117+
Be sure to [Add Variable](prepare-fork.md#add-variable){: target="_blank" } to the repository as well as `Secrets` to enable automatic certificate creation.
118+
103119
## Validate <code>Secrets</code>
104120

105121
The first action step is to Validate <code>Secrets</code>. Near the top middle of your Repository fork, click on the `Actions` tab.
@@ -448,6 +464,7 @@ The directions below may be sufficient for some.
448464
* In the left pane, scroll down to find `Secrets and variables` and click on the dropdown symbol and choose `Actions`
449465
* At this point, tap on `New organization secret` and add your 6 secrets
450466
* Then tap on the `Variable` tab and enter your Variable
467+
* For details on adding the variable, see [Add Variable](prepare-fork.md#add-variable){: target="_blank" }
451468

452469
### Build with Organization
453470

docs/browser/prepare-fork.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ If you are someone who already has a lot of forks in your personal account and w
225225

226226
1. Follow the steps to create your organization
227227
* [Create a Free *GitHub* Organization](secrets.md#create-a-free-github-organization){: target="_blank" }
228-
1. Add the `Secrets` and the `Variable` as explained in [Prepare to Enter `Secrets`](#prepare-to-enter-secrets)
228+
1. Add the `Secrets` and the `Variable` to your *GitHub* organization as explained in [Prepare to Enter `Secrets`](#prepare-to-enter-secrets)
229229
1. Fork all the repos you normally use, but this time, set your organization as the owner
230230
1. For each repository in your organization:
231231
* Tap on the Actions tab

0 commit comments

Comments
 (0)