Skip to content

Commit 2478393

Browse files
committed
update to include information about the feature branches
1 parent e1c4376 commit 2478393

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

docs/version/development.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,48 @@ This section provides an overview of changes to `dev` compared to `Loop 3.8.x`.
1616

1717
Please check the [development channel in zulipchat](https://loop.zulipchat.com/#narrow/channel/144182-development) 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.
1818

19-
There are no differences between `dev` and `main` at this time.
19+
There are no differences between `dev` and `main` at this time. However, there are some feature branches.
20+
21+
| <div style="width:140px"> branch | version # | comments |
22+
|:--|:--|:--|
23+
| main | 3.8.2 | release |
24+
| dev | 3.9.2 | identical to main except version number |
25+
| feat/pod-keep-alive | 3.9.3 | - identical to 3.8.2 & 3.9.2 except uses the OmniBLE pod-keep-alive branch to support users of iPhone 16 phones with InPlay BLE (-Atlas) DASH pods<br>- this really should have kept the 3.9.2 version number<br>- SHA for OmniBLE is `8c47404` |
26+
| release/3.8.1 | 3.8.1 | - copy of the main release at version 3.8.1 that included Dana support<br>- this branch is meant to support people already using Dana with v3.8.1 who understand how to manage the issues with that version<br>- SHA for DanaKit is `3e606b8` |
27+
| feat/dev-dana-medtrum | 3.9.1 | - identical to dev when it was at 3.9.1, with addition of experimental support for Dana and Medtrum pumps<br>- this branch will be updated as updates are available for DanaKit and MedtrumKit<br>- this branch has newer version of the Dana pump manager than release/3.8.1 but new bolus recording issues were observed with this update<br>- when an updated version of dev is merged into this branch, the version number will be similarly incremented<br>- SHA for DanaKit is `0875c1e`<br>- SHA for MedtrumKit is `a85496e` |
28+
29+
### Version Number Plan
30+
31+
Please see [`Loop` Version Numbering](releases.md#loop-version-numbering) for the current method for version numbering for the `main` and `dev` branches.
32+
33+
The idea of having a feature branch is not new for the *Loop* app but hasn't been used for a few years. At this point, we have two feature branches.
34+
35+
Moving forward, the version number in the feature branch will match the `dev` branch version number.
36+
37+
* In other words, a diff between `dev` and the feature branch is just the updates added to support the feature starting with that version of `dev`
38+
* As appropriate, `dev` will be merged into the feature branch and at that time, the version number for the feature branch will also be bumped
39+
* Updates to the feature branch to support the feature will not be updated with a new version number associated with the features
40+
* When updates for the feature are added, the SHA for that submodule will be reported and can be found by examining the LoopWorkspace repository for that feature branch
41+
42+
> The version number for the `feat/pod-keep-alive` does not match the planned pattern for numbering feature branches; it should have been left at 3.9.2.
43+
44+
45+
### Feature Branch: Pod Keep Alive Feature
46+
47+
For more information about using the `feat/pod-keep-alive` branch with an iPhone 16 and InPlay BLE DASH pods, please refer to the README file for the OmniBLE `pod-keep-alive` branch:
48+
49+
* [Workaround for InPlay Pods](https://github.com/LoopKit/OmniBLE/tree/8c4740468949cf6ca787e232f885a535b2bb3e8f?tab=readme-ov-file#omnible)
50+
51+
52+
### Feature Branch: Medtrum and Dana Support
53+
54+
The Medtrum and Dana pump managers were originally tested with the Trio app. We know that pump managers that work for Loop also work for Trio, however, the converse is not necessarily true.
55+
56+
There are differences in the way Loop and Trio manage insulin delivery. An eventual goal is to make the apps use the same protocols.
57+
58+
* Loop uses the concept of a mutable dose
59+
* a mutable dose has been requested and is treated as if it completed as requested but until it is marked isMutable=false, it if not treated as final
60+
* Trio has its own method for dealing with doses that are initiated but might later change
2061

2162
## Older updates
2263

0 commit comments

Comments
 (0)