Skip to content

Commit 94a2649

Browse files
committed
restore the update from 3.2.x instructions for folks coming from Mac-Build
1 parent 70c6793 commit 94a2649

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed

docs/browser/bb-update.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,97 @@ Digital Service Act Compliance
117117
118118
Open your *GitHub* account and select your <code>LoopWorkspace repository</code> from your repositories list.
119119

120+
### Update from 3.2.x to 3.4
121+
122+
This should only be necessary if you are changing from an older, Mac-Xcode build of version 3.2.x to a Browser Build of 3.6.x. Most people are updating from 3.4.x to 3.6.x and should skip ahead to [Special Instructions for 3.6.0](#special-instructions-for-360).
123+
124+
For the update from 3.2.x to 3.6, you must do more than "just" build. If you skip this step - the build will fail.
125+
126+
* The `Identifier` for the "`widget`" changed from "`SmallStatusWidget`" to the more descriptive "`LoopWidgetExtension`"
127+
128+
> If you built version 3.3.0 (the `dev branch` before release of version 3.4) or newer, you can skip ahead to [Special Instructions for 3.6.0](#special-instructions-for-360).
129+
130+
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).
131+
132+
#### Add Identifiers
133+
134+
In your fork of LoopWorkspace:
135+
136+
* Run the Action: `Add Identifier`
137+
* Wait for it to succeed
138+
139+
??? tip "Detailed instructions for `Add Identifier` (Click to open/close)"
140+
Refer to the graphic below for the numbered steps:
141+
142+
1. Click on the `Actions` tab of your <code>LoopWorkspace</code> repository
143+
1. On the left side, click on 2. <code>Add Identifiers</code>
144+
1. On the right side, click `Run Workflow` to show a dropdown menu
145+
* You will see your default branch (typically this is `main`)
146+
1. Tap the green button that says `Run workflow`.
147+
148+
![add identifiers using github actions](img/action-02-add-identifiers.svg){width="700"}
149+
{align="center"}
150+
151+
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.
152+
153+
* If you see the green check (:octicons-check-circle-fill-16:{: .passed }) continue to the next section
154+
* If you see the red `X` (:octicons-x-circle-fill-16:{: .failed }):
155+
* [Action: Add Identifiers Errors](bb-errors.md#action-add-identifiers-errors){: target="_blank" } tells you what to search for in the file
156+
* Resolve the error and repeat `Add Identifiers`
157+
158+
#### Add `App Group` to New `Identifier`
159+
160+
Open the [Certificates, Identifiers & Profiles: Identifiers List](https://developer.apple.com/account/resources/identifiers/list){: target="_blank" } page.
161+
162+
Click on the "`LoopWidgetExtension`" identifier to open the `Edit Your App ID Configuration` screen.
163+
164+
| `NAME` | `IDENTIFIER` |
165+
|-------|------------|
166+
| `Loop Widget Extension` | `com.TEAMID.loopkit.Loop.LoopWidgetExtension` |
167+
168+
The graphic below has numbered steps that match these directions:
169+
170+
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
171+
2. If the word `Configure` shows up, tap on it
172+
* This opens the `App Group Assignment` screen
173+
* 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
174+
3. Check the box by `Loop App Group` that uses your `TEAMID` in `group.com.TEAMID.loopkit.LoopGroup`
175+
* Note that if you previously built with Xcode, the name may be different, i.e., `XC group com TEAMID loopkit LoopGroup`
176+
4. Tap `Continue`
177+
5. Tap `Save`
178+
179+
![graphic showing selection of the correct App Group](img/update-identifier-loop-3-4.png){width="700"}
180+
{align="center"}
181+
182+
If you did not need to make changes, the `Save` button will not be active.
183+
184+
* Tap on the `< All Identifiers` link at the top left
185+
186+
The full list of Identifiers should be displayed again.
187+
188+
!!! note "Other Identifiers"
189+
All other identifiers should be already set up.
190+
191+
* 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" }
192+
193+
#### Create Certificates
194+
195+
You must run the action `Create Certificates` again because the `Identifiers` were updated. Wait for this to succeed before trying to build.
196+
197+
???+ tip "Detailed instructions (Click to open/close)"
198+
Refer to the graphic below for the numbered steps:
199+
200+
1. Click on the "<code>Actions</code>" tab of your <code>LoopWorkspace</code> repository
201+
1. On the left side, click on "`Create Certificates`"
202+
1. On the right side, click "`Run Workflow`" to show a dropdown menu
203+
* You will see your default branch (typically `main`)
204+
1. Tap the green button that says "`Run workflow`".
205+
206+
![create certificates using github actions](img/action-03-create-certs.svg){width="700"}
207+
{align="center"}
208+
209+
1. Wait a minute or two for the action to finish
210+
120211
### Special Instructions for 3.6.0
121212

122213
When updating to version 3.6.0, there are two "extra" things to do.

0 commit comments

Comments
 (0)