Update Submodules to LoopKit

[marionbarker]

Describe the bug

When initially preparing Trio, some submodules had open PR to LoopKit that we wanted to incorporate into Trio before they were merged into LoopKit.

When these PR, sometimes with updates, are merged into LoopKit, we need to update the index for Trio to use the correct SHA that is associated with LoopKit (not loopandlearn) GitHub username - see Additional Context, later in this Issue description.

To Determine which Submodules need to be updated

Open the nightscout/Trio repository on GitHub For each submodule, right click and open in a new tab

• If there is a yellow banner with these words This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository., that submodule should be updated to use the LoopKit Username SHA as soon as it is available.

Additional context

The .gitmodules file points to the original repository where the code for a specific submodule is obtained. When cloning from GitHub, any SHA of any fork from the original submodule repository can be pulled in from the SHA included in the Trio workspace index without modifying the .gitmodules file.

• When a developer, or user, wants to perform an update for their local clone that includes an update to a submodule, the use of a SHA from a fork requires an additional step
• Option 1:
  • Download a fresh clone to update if the initial attempt to update gives an error
• Option 2:
  • For the submodule where the error message says that SHA cannot be found, cd into the submodule
  • Check git remote -v, if origin does not show up, add both LoopKit as origin and loopandlearn as a remote for that submodule and then git fetch --all and cd ..
  • Try git submodule update or git pull --recurse again

Example 1:

• loopandlearn/G7SensorKit repository is forked from LoopKit/G7SensorKit repository
• make a modification in the loopandlearn/G7SensorKit repository and create a Pull Request (PR) to LoopKit
• Trio workspace index points to the loopandlearn version
• PR is merged into LoopKit
  • Modify the SHA in the index for Trio workspace to point to the LoopKit SHA (same code, different SHA)

Example 2:

• loopandlearn/CGMBLEKit repository is forked from LoopKit/CGMBLEKit repository
• make a modification in the loopandlearn/CGMBLEKit repository and create a Pull Request (PR) to LoopKit
• Trio workspace index points to the loopandlearn version
• A modification is requested to the PR, this modification is made (no change made to Trio)
• PR is merged into LoopKit
  • Modify the SHA in the index for Trio workspace to point to the LoopKit SHA (different code, different SHA)

Keeping Track

The next comment will be used as a living document to indicate which submodules require an update and then connecting the PR that updates that submodule, as soon as it become available.

This Issue should remain open so long as any submodules in the Trio workspace index are pointing to loopandlearn instead of LoopKit.

[marionbarker]

Table of submodules and their current status

Last Updated on 17 June 2024 (the update is a work in progress until this parenthetical comment is removed).

With the merge of PR #303, remove the column that indicates which GitHub username is the source of the SHA used by Trio.

Modify the PR column. If there is a "#" sign, i.e., a link, the PR is open and the SHA is value before the PR is merged. The numbers without the "#" represent the history of Trio PR that affected that repo.

Add more columns (17 June 2024) to clarify what changes are found in GitHub loopandlearn with respect to LoopKit The meaning is:

• "Open PR" means that one or more open PR found in LoopKit is merged into trio
• "Trio Diff" means that one or more custom commits were added to trio branch
• "Trans" means that translations were merged into the trio branch (from the Trio crowdin project)

The "y" is after the PR making the change is merged, the wip indicates a PR is open.

Update Date	Submodule	PR	Comments	SHA	Open PR	Trio Diff	Trans
20 May 2024	CGMBLEKit	-	need to update trio branch to have changes included in dev_rc branch	a92e975	y	-	-
20 May 2024	G7SensorKit	225	needs more updates trio branch is ahead of Loopkit but not all changes have been added to Trio yet	b5e992e	y	-	-
20 May 2024	LibreTransmitter	-	Up to date, trio branch matches LoopKit main branch No open PR, Need to update to use appName	c01eba6	-	-	-
20 May 2024	LoopKit	-	trio branch ahead of SHA used by Trio-alpha trio branch has support included for DanaKit	2f535b3	y	-	-
20 May 2024	MinimedKit	-	need to update trio branch to have changes included in main_rc branch	4a6df31	y	-	-
08 Jun 2024	OmniBLE	281	Up to date trio branch matches LoopKit dev branch	85fc3c6	-	-	-
08 Jun 2024	OmniKit	281	Up to date trio branch matches LoopKit main branch	a80e38b	-	-	-
20 May 2024	RileyLinkKit	-	Up to date trio branch matches LoopKit dev branch	a0e419d	-	-	-
20 May 2024	TidepoolService	-	need to update trio branch to have changes included in dev_rc branch	a2ccad7	y	-	-
20 May 2024	dexcom-share-client-swift	-	Up to date trio branch matches LoopKit dev branch	21d8657	-	-	-
15 Jun 2024	DanaKit	296, 300	Up to date trio branch matches bastiaanv dev branch still in Trio feat/dana, not part of alpha yet	N/A	n/a	n/a	n/a

Change Log

Log of Updates:

08 June 2024: PR #281

• Fixes to OmniBLE/Kit: update handling of resume after suspend, improve logic to prevent 0x31 Fault
• Enhancement for OmniBLE parser used by developers

  15 June 2024: PR #303

• Now that .gitmodules point to loopandlearn for all repositories, update this comment
• Remove column about which GitHub user name is used
• Add column with current SHA

Submodules for Trio google sheet is used as a working document for updates to Trio submodules