Building Loop with LnL Patches

Loop and Learn provides a customized branch of Loop 3.#.# (main_lnl_patches) that enables people who want specific customizations to use a branch (or customization method) to add them.

This is available with the Build Select script for people using the Mac-Xcode method.

This page describes two methods for using the GitHub (Browser Build) method to build Loop with LnL Patches.

  1. Loop then Customize
  2. LnL Fork

For information about what is included in these patches, see: Loop and Learn: Summary of Loop with LnL Patches.

GitHub Build: Loop then Customize

These instructions enable you to build Loop with LnL Patches using just a browser. No Mac or Xcode needed.

This section uses the standard LoopDocs method and then has you edit a single file using your browser in your fork.

Instructions for how to edit the build_loop.yml file are at Loop and Learn: Code Customization: Standard Patches.

If you’ve never built Loop using GitHub

Follow the instructions in LoopDocs: GitHub Overview and LoopDocs: GitHub First-Time until you successfully build Loop.

You do not need to install this version on a phone – building it is sufficient.

Head over to Loop and Learn: Code Customization: LnL Patches.

If you already built Loop using GitHub and your fork is from LoopKit

Be sure to sync your fork to capture updates, if any. (If you need help with this step, it is documented in LoopDocs: GitHub Update.)

Head over to Loop and Learn: Code Customization: LnL Patches.

If you already built Loop using GitHub and your fork is from loopnlearn

You have your choice. You can delete your fork and make a new one from LoopKit or stay with your existing fork from loopnlearn and follow the directions under GitHub Build: Loop with LnL Patches.

If you delete your fork and start over, you will use all the same 6 Secrets you previously used.

GitHub Build: Loop with LnL Patches

These instructions enable you to build Loop with LnL Patches using just a browser. No Mac or Xcode needed.

This section uses a different source when you create your fork of LoopWorkspace and requires skipping back and forth between LoopDocs and this page.

If you need more details than are provided here, the LoopDocs GitHub First-Time page has step-by-step directions with graphics for doing this for the released version of Loop. Review that and then return here.

UPDATING?: When updating to the next release when your fork is from loopnlearn:

  1. Make sure the main_lnl_patches branch has been updated (this typically happens within one day of the official release)
  2. When you go to your fork, you’ll see an indication that you need to sync your fork
  3. Sync your fork and then choose Action: Build Loop
  4. Once that succeeds, you’ll need to wait for the app to get processed through TestFlight and show up ready for installation on your phone

If you already built Loop using GitHub and your fork is from LoopKit

You have two choices (easier or harder)

Choice 1:

  • Head over to Loop and Learn: Code Customization

Choice 2:

  • Continue in this section
  • This requires deleting your fork from LoopKit and starting over with a fork from loopnlearn

If you decided to stick with this method, your first step is to delete your current fork of LoopWorkspace and start over – but trust us – it will be much easier than the first time.

Delete your fork of LoopWorkspace from your account.

  • Instructions to delete a repository are found at GitHub Docs

You will use the same Secrets again with the new fork from the loopnlearn GitHub account (see below). The secrets are associated with your Apple Developer ID and your GitHub account. Keep them safe in a text-only file – they need to be the same for any repository that uses this method.

Follow the directions below to get your new fork, skipping the parts that you’ve already completed.

If you’ve never built Loop using GitHub

You are probably better off with the other set of instructions: GitHub Build: Loop then Customize.

If you decide to stick with forking from loopnlearn/LoopWorkspace, then follow the instructions in LoopDocs until you complete the section entitled Create Match-Secrets.

Do not follow the directions for creating your fork of LoopWorkspace – come back to this page.

Fork the loopnlearn LoopWorkspace

Click on this link https://github.com/loopnlearn/LoopWorkspace to open the LoopWorkspace repository.

Click on the fork button.

Successful Fork

After you have successfully forked LoopWorkspace from loopnlearn and see that you have the main_lnl_patches branch, return to the Loopdocs instructions at Configure Secrets.

If you have never built Loop with the GitHub method, continue to the end of the LoopDocs instructions because you have some additional steps to accomplish.

If you previously built Loop with the GitHub method, once you’ve added your 6 secrets, run these 4 actions:

  1. Validate Secrets
  2. Add Identifiers
  3. Create Certificate
  4. Build Loop

TestFlight

The final step is to make sure your app is connected to TestFlight so you can install it on your phone. Follow instructions to Set Up Users and Access TestFlight.

 

Look for the TestFlight email – you will have to redeem the invitation the first time it built using GitHub for a given app.

Home

Skip to content