Skip to content

Commit 96ffa55

Browse files
committed
more updates about versions and dev branch
1 parent 2f6e34e commit 96ffa55

File tree

4 files changed

+78
-108
lines changed

4 files changed

+78
-108
lines changed

docs/build/build-dev-mac.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
## `BuildLoopDev` Script
1313

14+
> With the modification of how the `dev` branch is handled starting with v3.7.x, the build scripts will be updated. In the interim, choose the tip of dev when using the existing scripts. The concept of the lightly tested commit is not longer valid and the SHA is not being updated.
15+
1416
There is a script to assist in building the `dev branch`. It gives you the option to choose the tip of the `dev branch` or to build a lightly tested commit. If you have not used the [Build Select Script](../build/build-app.md#build-select-script) to build Loop previously, you may want to review that page. The command below can be pasted into the terminal of your Mac. Read the directions in the script.
1517

1618
``` { .bash .copy title="Copy and Paste to start the BuildLoopDev script" }
@@ -43,14 +45,8 @@ You may prefer to use commands to fetch and pull the latest code without making
4345

4446
## Loop-dev Version
4547

46-
The version of code that shows up under the Loop Settings screen does not change when the `dev branch` is modified.
47-
48-
If you need help with your app, the mentors need more information. Please issue a Loop Report when asking for help. Refer to [Support](../loop-3/settings.md#support) for how to issue a Loop Report. If you want to keep track yourself, refer to [Identify Loop-dev Version](#identify-loop-dev-version)
49-
50-
* [`Loop` Version Numbering](../version/releases.md#loop-version-numbering)
51-
52-
### Identify Loop-dev Version
48+
Starting with v3.7.x, the version of code that shows up under the Loop Settings screen increments with each formal change to the `dev` branch using the pull request process. That increment might be an update to match a hotfix to `main` or might be from a new feature brought just into the `dev` branch.
5349

54-
The version of code that shows up under the Loop Settings screen will remain fixed until Loop-dev is released. In order to identify which version of dev you have on your phone, you need the commit.
50+
If you need help with your app, the mentors need to know you are running a `dev` branch and the specific version that shows on your settings screen. For more information about version numbers:
5551

56-
The commit is identified by a 7-digit alphanumeric code. That code was also appended to the folder name of the downloaded code under Downloads/BuildLoop as shown in the graphic above. You can use finder to view the folder name after the script completes. It also appears in the Loop Report, refer to [Support](../loop-3/settings.md#support) for instructions on issuing a Loop Report. After you issue the Loop Report, look at the workspaceGitRevision number near the beginning of the report.
52+
* [`Loop` Version Numbering](../version/releases.md#loop-version-numbering){: target="_blank" }

docs/version/build-dev.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,15 @@ There are several methods to build Loop-dev. First review the general informatio
88

99
## Update Frequently
1010

11-
While Loop-dev is under active development, you should monitor zulipchat and update frequently. Sometimes the `dev` branch is quiet for a month or more and other times it gets updated daily. Please pay attention.
11+
While Loop-dev is under active development, you should monitor zulipchat and update frequently. Sometimes the `dev` branch is quiet for months at a time and other times there are more frequent changes. Please pay attention.
1212

1313
Checking for updates every week is a good idea. Also - subscribe to all the streams on [Loop Zulipchat](https://loop.zulipchat.com) to make sure you don't miss critical information.
1414

1515
## Loop-dev Version
1616

17-
The version of code that shows up under the Loop Settings screen does not change when the `dev branch` is modified.
17+
The version of code that shows up under the Loop Settings screen is incremented whenever the `dev branch` is modified, as explained in [Loop Version Numbering](releases.md#loop-version-numbering){: target="_blank" }.
1818

19-
If you need help with your app, the mentors need more information. Please issue a Loop Report when asking for help. Refer to [Support](../loop-3/settings.md#support) for how to issue a Loop Report. If you want to keep track yourself, refer to [Identify Loop-dev Version](#identify-loop-dev-version)
20-
21-
* [`Loop` Version Numbering](releases.md#loop-version-numbering)
22-
23-
### Identify Loop-dev Version
24-
25-
The version of code that shows up under the Loop Settings screen will remain fixed until Loop-dev is released. In order to identify which version of dev you have on your phone, you need the commit.
26-
27-
The commit is identified by a 7-digit alphanumeric code. That code was also appended to the folder name of the downloaded code under Downloads/BuildLoop as shown in the graphic above. You can use finder to view the folder name after the script completes. It also appears in the Loop Report, refer to [Support](../loop-3/settings.md#support) for instructions on issuing a Loop Report. After you issue the Loop Report, look at the workspaceGitRevision number near the beginning of the report.
19+
If you need help with your app, the mentors need to know you are running a `dev` branch and the specific version that shows on your settings screen.
2820

2921
## Build `Loop` `dev`
3022

docs/version/development.md

Lines changed: 19 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,17 @@ Please read this entire page before using any version of *Loop* other than the r
1414

1515
This section provides an overview of changes to `dev` compared to `Loop 3.6.x`.
1616

17-
The following features are found only in dev at this time.
18-
19-
* Added support for Dana-i and DanaRS-v3 pump models
20-
* Updated some localization (strings translated to different languages)
21-
* Cleaned up some code
22-
* Fixed a bolus problem with iOS 26
23-
* Discarded some unneeded files
24-
* Updated to Xcode 16.4 for browser build and CircleCI quality testing
17+
The following features are found only in dev at this time. Any updates added to `main` were also added to `dev`.
18+
19+
* v3.7.5
20+
* Added support for Dana-i and DanaRS-v3 pump models
21+
* v3.7.6
22+
* Updated some localization (strings translated to different languages)
23+
* Added scripts to make localization more streamlined
24+
* Cleaned up some code
25+
* Fixed a bolus problem with iOS 26
26+
* Discarded some unneeded files
27+
* Updated to Xcode 16.4 for browser build and CircleCI quality testing
2528

2629
Please check this channel in zulipchat for notifications when an update to the `dev` branch is expected so you will be prepared. Do this **before** you install a `dev` build from TestFlight.
2730

@@ -33,7 +36,7 @@ Check [Version History](releases.md#loop-3-version-history) for minor updates fo
3336

3437
## Updates from 3.2 to 3.4
3538

36-
Most features, originally in the Updates in `dev` section before the release of version 3.4, have been inserted into the appropriate part of the *LoopDocs* website (indicated by the up-right arrow after the link). A few items are still in this section.
39+
Features new with v3.4, originally in the Updates in `dev` section before the release, have been inserted into the appropriate part of the *LoopDocs* website (indicated by the up-right arrow after the link). The links below are left to assist people in finding the features.
3740

3841
* [Support for Libre Sensors](../loop-3/add-cgm.md#libre){: target="_blank" }
3942
* [Pump or CGM Simulator on Phone](simulator.md#pump-or-cgm-simulator-on-phone){: target="_blank" }
@@ -42,47 +45,8 @@ Most features, originally in the Updates in `dev` section before the release of
4245
* [<span translate="no">Integral Retrospective Correction</span>](../loop-3/features.md#integral-retrospective-correction-irc){: target="_blank" }
4346
* [Favorite Foods](../loop-3/settings.md#favorite-foods){: target="_blank" }
4447
* [<span translate="no">TestFlight Expiration Warning</span>](../operation/features/notifications.md#loop-app-expiration-notification){: target="_blank" }
45-
* [<span translate="no">GitHub Browser Build</span> Updates](#github-browser-build-updates)
46-
* [Miscellaneous Code Fixes](#miscellaneous-code-fixes)
4748

48-
### <span translate="no">GitHub Browser Build</span>&nbsp; Updates
49-
50-
The `dev` branch has several updates merged that make it easier to find errors in configuration and that make the &nbsp;<span translate="no">GitHub Browser Build</span>&nbsp; automatic.
51-
52-
Note that the automatic build feature is opt-out. In other words, unless you take specific steps, the &nbsp;<span translate="no">GitHub Browser Build</span>&nbsp; for&nbsp;_<span translate="no">Loop</span>_&nbsp;will:
53-
54-
* Automatically build a new version once a month, with automatic update included
55-
* Automatically update your fork of LoopWorkspace once a week if updates are available
56-
57-
It is suggested that all users of the released code (main branch), maintain this automatic schedule so they are never without a valid and up-to-date&nbsp;_<span translate="no">Loop</span>_&nbsp;in their *TestFlight* app.
58-
59-
In addition to the easier to read error messages found with these updates, these additional simplifications include:
60-
61-
* Actions are broken into logical components, each of which provides an easy to understand error message if it fails which includes a suggested fix
62-
* A new builder no longer needs to create the &nbsp;<span translate="no">Match-Secrets repository</span>
63-
* If it does not exist, one is created for you
64-
* Only the App Group ID must be added to the Identifiers; all other App services are automatically added
65-
* For new builders and current 3.2.3 users updating to the next release
66-
* The branches with `alive` in the name required to enable automatic update and building are created automatically
67-
* Make sure your GitHub repository is in sync with the LoopKit/LoopWorkspace repository
68-
69-
These sections are still useful for version 3.5.0 `dev` users:
70-
71-
* [Browser Build for dev](../browser/build-dev-browser.md): How to use &nbsp;<span translate="no">GitHub Browser Build</span>&nbsp; for `dev` branch
72-
* [Browser Build: One-Time Changes](../browser/build-dev-browser.md#one-time-changes): New steps and dates at which the new steps were added
73-
74-
### Miscellaneous Code Fixes
75-
76-
#### G7 Sensors: Duplicate CGM Values
77-
78-
Fixed with [PR 16: Fix parsing of age field of message](https://github.com/LoopKit/G7SensorKit/pull/16)
79-
80-
* Most sensors report the time with very little offset between time of arrival and time of sensing
81-
* If the time discrepancy is large, the error (using one byte instead of two for age of the reading) could cause CGM values to appear as duplicate readings in Loop
82-
83-
#### Remote Services Update
84-
85-
The code that feeds Loop data to remote services like Tidepool and Nightscout have been improved to be more robust.
49+
- - -
8650

8751
## What are Git Branches?
8852

@@ -103,7 +67,10 @@ The information in this video is still generally useful with the last half focus
10367

10468
*Loop* developers own an account in *GitHub* called [LoopKit](https://github.com/LoopKit). Within that account, the developers have several <code>repositories</code> that support *Loop* in particular. A repository&#8203; is like a book...let's think of it like a cookbook for now. Within the `LoopKit` account, there are `repositories` for Loop&#8203; itself, *LoopDocs*, and various other supporting "frameworks" that are <span>helper &#8203;repositories&#8203; for *Loop*</span> to build correctly. For example, Loop&#39;s &#8203;repository&#8203; has a lot of info about the app itself; the outward-facing things that you interact with. How information is put to you and taken in from you...that's in *Loop* <code>repository</code> code. But, there's more than just a user interface for Loop. *Loop* has to do a lot of complex work like Bluetooth communications, algorithm math, pump communications, etc. The *Loop* app has help from frameworks to do those other parts. `CGMBLEkit`&nbsp; for some of the transmitter parts of *Loop*, `RileyLink_ios` for the pump managers (talking to the pumps and decoding their information), `LoopKit` for the algorithm about carbs and insulin curves, etc.
10569

106-
When you build *Loop*, in the background, *Loop* pulls those other frameworks (7 in total) into the build process using `Carthage`. `Carthage`&nbsp; is like a personal shopper. You give it a shopping list (the cart file in *Loop* code is that shopping list) and it goes and fetches that for you during the build process. Sometimes your computer has an old shopping list...and that can cause build errors. Hence the `carthage update` fix in the Build Errors page...that command updates the shopping list to get the right versions of those frameworks.
70+
When you build *Loop*, you actually start with LoopWorkspace which points to all the other repositories needed for a complete *Loop* app.
71+
72+
> Note - this graphic is outdated - you download the *LoopWorkspace* repository and use the workspace to get the right version of the *Loop* repository and the other necessary code.
73+
10774

10875
![img/loopkit.png](img/loopkit.png){width="650"}
10976
{align="center"}
@@ -118,7 +85,7 @@ After much testing and tweaking, eventually, the recipes get the flavors right (
11885

11986
## What's going on in the `dev` branch?
12087

121-
The `dev` branch, currently v3.5.0, is where the next version of *Loop* is being developed and tested.
88+
The `dev` branch is where the next version of *Loop* is being developed and tested.
12289

12390
If you choose to build *Loop* using a `dev` branch, you need to be aware that the `dev` branch may update code frequently and unannounced in the traditional sense that most users in the *Looped* group or *Instagram* would see. Developers are not helped by people being in a `dev` branch if those users mistakenly think of it as a stable `main` branch with lots of detailed docs to go with it. People should only use a `dev` branch build if they EDUCATE themselves on the expectations and how to properly manage `dev` information and updates. People using the `dev` branch should also have regular access to a computer to be able to rebuild quickly if a new bug/fix is identified.
12491

@@ -159,10 +126,6 @@ You can choose to watch the `repository` so that you get emails when new `Issues
159126
![img/watching.png](img/watching.png){width="650"}
160127
{align="center"}
161128

162-
### Keep checking `Looped` group
163-
164-
Keep watching [`The Looped Group`](https://www.facebook.com/groups/TheLoopedGroup) on *Facebook*. Major concerns/issues are brought up there...so it doesn't hurt to scroll through and see what's going on there.
165-
166129
### Become familiar with your data sources
167130

168131
Another useful thing if you'll be on `dev` branches undergoing a lot of active change...know how *Loop* works and where to look for additional information about what you are seeing. For example, if you see an IOB value that looks odd, you should know to look at the insulin deliveries stored in the *Health* app.
@@ -184,7 +147,7 @@ This 6-minute long, classic Katie DiSimone video shows how to [capture debugging
184147

185148
If you're a developer looking for direct links to the **code and documentation** in *GitHub*:
186149

187-
* [`Loop`](https://github.com/LoopKit/Loop)
150+
* [`LoopWorkspace`](https://github.com/LoopKit/LoopWorkspace)
188151
* [`LoopDocs`](https://github.com/LoopKit/Loopdocs)
189152

190153
For more information on **how to contribute code to the *Loop* project**, please review:

0 commit comments

Comments
 (0)