GitHub Build Overview
Build Loop with a Browser¶
The new GitHub build method is available with the release of Loop 3, as well as for development versions.
- Installation on your phone is via TestFlight
- This can be used by those who don't own a Mac but want to Loop
- The GitHub build method can be used even if you do use a Mac - the two methods do not interfere with each other
TestFlight is the only method available for installation to a phone when using the GitHub build method, but it can also be used as a remote build option with the Mac-Xcode build method - see TestFlight from Xcode.
Pros and Cons¶
Advantages of GitHub Build¶
- Mac computer is not required
- Most recent version of Xcode is not required
- No more updating macOS then updating Xcode for certain iOS upgrades
- The time required for the initial setup for GitHub may take less time than one macOS and Xcode version update
- Updates take a few minutes of your time to start and are ready to install on your phone in about an hour
The customization process can be more tedious to set up but then easy to maintain (for personalized customizations).
- Instructions are found at Customize with GitHub
- Frequently used customizations are prepared for you to copy and paste into build_loop.yml
Loop 3 requires iOS 15.1 or higher
The requirements for building and using the Loop app with the GitHub Build Actions method are given below.
- Compatible iPhone/iPod Touch
- Compatible Pump
- Compatible CGM
- RileyLink Compatible Device (not needed for Omnipod DASH)
- Free GitHub account (instructions included in First-Time with GitHub Actions)
- Apple Developer Membership
- Must be a paid developer account
- If building for a family member, review this section:
- If building for a child (age depends on the country), review this section:
First-Time GitHub Builder¶
There are a number of steps that must be completed the first time you use this method.
Deploy and Updates¶
- Instructions to deploy and make updates are found at:
- And of course, an errors page is under construction:
- For those testing the development branch who want to use GitHub build:
What if I get stuck?¶
- Scroll back in the directions and see if you missed a paragraph or step.
- Compare your display with the graphics in LoopDocs.
- Is something different or does yours have an error message?
- If you have an error message, does it guide you to the problem and solution?
- Be aware that GitHub often updates where things are - search for GitHub directions if your display looks different than LoopDocs.
- If you are still stumped - reach out for help: How to Find Help.