Skip to content

Commit e3e124d

Browse files
authored
add explicit instructions to set default to main and build (#1028)
1 parent f0e7399 commit e3e124d

4 files changed

Lines changed: 314 additions & 1 deletion

File tree

docs/browser/bb-update.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,31 @@ Option 2: If you chose to enable Automatic Updates from *TestFlight* for the *Lo
334334

335335
## Other Information
336336

337+
### Restore Default Branch to `main` and Build
338+
339+
If you build using the Browser Build method but have any branch other than `main` selected as your default build, please think twice. Using the `dev` branch is only for people wha are actively testing. If you need something from a feature branch, be sure to switch back to `main` once the feature is added to the released code. (Hint - when this happens, the feature branch is deleted.)
340+
341+
To change your default branch, follow these directions. The example is changing from `dev` to `main`.
342+
343+
Open your LoopWorkspace fork. The graphic below shows what the fork looks like when the `dev` branch is the default. If yours shows `main` at the location labeled with a "1", then simply do a [fresh build](bb-update.md#how-to-update-or-rebuild){: target="_blank" } using the `main` branch and install it on your phone from TestFlight.
344+
345+
![graphic showing fork with dev branch as default](../browser/img/change-branch-check-branch.svg){width="750"}
346+
{align="center"}
347+
348+
If your branch shows as `dev` then click on Settings, as indicated by the rectangle labeled with a "2" in the graphic above.
349+
350+
Follow the numbered sequence in the graphic below:
351+
352+
1. Click on the left/right arrows
353+
2. Select the `main` branch in the drop-down menu
354+
3. Click on "Update"
355+
4. Click on "I understand, update the default branch"
356+
357+
![graphic showing fork with dev branch as default](../browser/img/change-branch-change-default.svg){width="750"}
358+
{align="center"}
359+
360+
Do a [fresh build](../browser/bb-update.md#how-to-update-or-rebuild){: target="_blank" } using the `main` branch and install it on your phone from TestFlight.
361+
337362
### Choose Previous Build
338363

339364
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.

docs/browser/img/change-branch-change-default.svg

Lines changed: 158 additions & 0 deletions
Loading

docs/browser/img/change-branch-check-branch.svg

Lines changed: 113 additions & 0 deletions
Loading

docs/faqs/loop-faqs.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,9 @@ When you get a new iPhone, you can plan ahead. There's a whole FAQs page about t
236236
Hey now...let's be grateful for what we have first. The ability to use the *Loop* app is the result of tremendous amounts of effort, time, and sacrifice by volunteers. Cracking the pumps for any Open-Source Automated Insulin Deliver (OS-AID) system use is a large undertaking. If and when another set of people spend a large amount of time figuring out other pumps, then they could conceivably be added to the *Loop* app. You don't need to let us know that you'd love to see more pumps compatible with Loop; we know that. There is just an awful lot of work that needs to happen and it is neither quick nor easy.
237237

238238
* Tandem pumps are not compatible (yet)
239-
* Omnipod 5 pods are not compatible
239+
* Omnipod 5 pods are not compatible (yet)
240+
* Dana pumps are available using a feature branch
241+
* Medtrum pumps are available using a feature branch
240242
* Newer Medtronic pumps are not compatible
241243

242244
In fact there are several OS-AID systems for iOS which use a common set of pump and CGM repositories. And new ones are being developed.
@@ -245,6 +247,21 @@ This [link](../build/pump.md#pumps-compatible-with-the-loop-app){: target="_blan
245247

246248
- - -
247249

250+
## How do I return to the released version?
251+
252+
Great question.
253+
254+
Sometimes people build the `dev` branch to get a shiny new feature. But you should not stay on the `dev` branch unless you are dedicated to testing new features and following along carefully on [zulipchat](https://loop.zulipchat.com/#narrow/channel/144182-development).
255+
256+
Most people need to build the released version of the *Loop* app found at the `main` branch and let the testing community give new features - or major updates of the *Loop* app - thorough testing before these updates are released in the `main` branch.
257+
258+
As a matter of fact, with version 3.14.1 and newer - you will see a modal alert you must acknowledge when you start up the *Loop* app built from the `dev` branch. Note that the `dev` branch is the only branch that gets this alert. If you built a feature branch, we assume you know you are testing that feature and that you expect frequent updates.
259+
260+
* See this link for [Browser Build Instructions](../browser/bb-update.md#restore-default-branch-to-main-and-build)
261+
* If you use Mac-Xcode, just follow the [standard update instructions](../build/updating.md) to ensure you are ready to download and build the `main` branch
262+
263+
- - -
264+
248265
## Can I have more than one *Loop* app on a phone?
249266

250267
Yes, this is technically possible. You can have multiple *Loop* apps built onto the same iPhone. However, having multiple *Loop* apps on a single phone may lead to unexpected conflicts that can negatively affect your Loop's ability to stay green (keep looping). Additionally, your Pod will only work on one *Loop* app at a time anyways. So for smooth looping, just keep one *Loop* app on any phone for looping use.

0 commit comments

Comments
 (0)