LoopFollow Browser Build

Overview¶

This page is for users who have configured an organization with their build credentials.

• If you don't know what that means, please review the entire Browser Build section in LoopDocs starting with Browser Build Overview

Multiple Copies of LoopFollow¶

For the convenience of caregivers who follow more than one person, you can build up to three instances of LoopFollow.

Customize LoopFollow¶

If you choose, you can:

• Customize the name of the app that appears on your phone
• Display the custom name in the main LoopFollow screen

Prerequisites¶

• This page is only for users who have built using Browser Build method before and who have configured an organization that already contains their Secrets.

Summary of Steps to Build LoopFollow¶

Detailed directions are found in the next sections, this is the summary of what you will do:

1. Fork the repository to your organization (link)
2. Add Identifiers (link)
3. Create a LoopFollow App Group (link)
   • New with LoopFollow version 6.0 and newer
4. Add the App Group to the Identifiers (link)
5. Create the App in App Store Connect and configure TestFlight users (link)
6. Configure TestFlight users for the LoopFollow app (link)
7. Build LoopFollow (link)

Fork LoopFollow¶

You start by opening a browser using the URL from the table below. Most people only need the LoopFollow app to follow one person. If you need to follow more than one person, then repeat the steps for each of the URL in the table. If you need to follow more than three people, reach out to the developers for help.

• Click on the link to open the repository in your browser
• Follow the directions to Create the Fork

Table of App Repositories¶

Create the Fork¶

1. At the upper right side of the screen, click on the word Fork

   

2. Refer to the GIF below:

   • You will see the display shown in the GIF below where you will choose your organization as the owner
     • This GIF is copied from LoopDocs, your screen will show loopandlearn/LoopFollow instead of LoopKit/LoopWorkspace
   • The repository name is already filled in
     • It is best not to rename the repository to something else
     • It can be confusing if you need to reach out to a mentor for help
     • However, if you have 3 people you follow it's fine to use names like:
       • LoopFollow_Mary
       • LoopFollow_Second_Joe
       • LoopFollow_Third_Tom
   • Leave the selection that says "Copy the main branch only" checked
   • Click on the green Create fork button

   

Successful Fork¶

After creating the  fork, your screen should be similar to the next graphic.

• Note that your URL is https://github.com/my-name-org/LoopFollow
• The comment on the second row indicates where the  fork  came from (that is a clickable link)
• The branch selected is main
• The message says "This branch is up to date with loopandlearn/LoopFollow:main"

Add Identifiers¶

Near the top middle of your Repository fork, click on the "Actions" tab.

• If this is the first Action you run with this repository you'll be informed that Workflows aren't being run on this forked repository
  • Tap on the green button that says: I understand my workflows, go ahead and enable them

Refer to the graphic below for the numbered steps:

1. Click on the "Actions" tab of your repository
2. On the left side, click on "Add Identifiers"
3. On the right side, click "Run Workflow" to show a dropdown menu
   • You will see your default branch (main)
   • You can select a different branch, but typically, you run the default

4. Tap the green button that says "Run workflow"

   

The Add Identifier  Action  should succeed or fail in a few minutes.

• If you see the green check () continue to the next section
• If you see the red X ():
  • Use the Browser Build Errors page to resolve the error, then repeat the Action
  • Quick Reference for Browser Build Errors

Create App Group¶

The LoopFollow App Group already exists if you previously built the LoopFollow app using Xcode with this Apple Developer ID. In that case, skip ahead to Optional: App Group Description Modification to update the description.

If you have never built the LoopFollow app with Xcode using your TEAMID, you need to create an App Group associated with your TEAMID.

1. Open this link: Register an App Group on the Apple Developer site.
2. For Description, use LoopFollow App Group
3. For Identifier, enter group.com.TEAMID.LoopFollow, substituting your Team ID for TEAMID
   • You must replace TEAMID with your 10-digit Apple Developer ID - do not just copy the App Group Identifier above
   • A mistake here means you will not be able to build the LoopFollow app until you fix it
4. Click Continue and then Register.

If you are building Second or Third versions, use the Name (Description) found in the App Groups table.

If this is successful, then skip ahead to Add App Group

If you get an error saying An Application Group with Identifier 'group.com.TEAMID.LoopFollow' is not available. Please enter a different string, that means you already have the LoopFollow App Group assigned to your account. Continue with the next section.

Optional: App Group Description Modification¶

This step is not required, but if you previously built using a Mac with Xcode, it is a good idea to update the Name associated with the Identifier for the LoopFollow App Group. Then what you see on your display will match the directions as you continue.

Add App Group¶

You will need to add the LoopFollow App Group to the App Group capability for each Identifier.

Identifiers for the LoopFollow app¶

For each identifier in the table below, click on the Identifer and then add the LoopFollow App Group to the App Group capability.

If you are building Second or Third versions, use the Name (Description) found in the Identifiers table.

The example graphic below has numbered steps that match these directions. The columns from left to right are Capabilities, App Services and Capability Requests. The check box under Capabilities will already be checked for you.:

1. Looking at the App Services column, scroll down to the App Groups row and ensure the check box (under the Capabilities column) for App Groups is checked
2. If the word Configure shows up, tap on it
   • This opens the App Group Assignment screen
   • If it said Edit instead of Configure - you can click to confirm you have the correct App Group but won't need to continue or save if it is correct
3. Check the box by LoopFollow App Group that uses your TEAMID in group.com.TEAMID.LoopFollow
   • Note that if you previously built with Xcode, the name may be different, i.e., XC group com TEAMID LoopFollow
4. Tap Continue
5. Tap Save
6. Tap Confirm

If you did not need to make changes, the Save button will not be active.

• Tap on the < All Identifiers link at the top left

The full list of Identifiers should be displayed again.

Repeat until the 2 Identifiers have the LoopFollow App Group configured.

• If you miss an identifier, the Create Certificates step will succeed but Build LoopFollow will fail.

LoopFollow Second and Third¶

If you build LoopFollow Second or Third, each has their own identifiers and their own App Group. Refer to the table below to see how the App Group and Identifiers for LoopFollow are modified when building the Second or Third version of the app.

App Groups¶

Identifiers¶

Create App in App Store Connect¶

You must create an App in App Store Connect if you don't already have one.

Examine the table below for the bundle ID associated with your app.

If you build from a second or third repository for LoopFollow, the Bundle ID will have .Second or .Third at the end.

1. Open this link: App Store Connect / Apps to view your apps; log in if needed.

2. If this App already exists, you can continue to the build step

3. Click the Add Apps button or the blue "plus" icon and select New App as shown in the graphic below

   

4. The New App dialog box opens and should appear similar to the graphic below. Before you fill anything out, make sure your Bundle ID is available in the dropdown menu. If you do not see the Bundle ID for your app; you should ask a mentor for help.

   • Select "iOS". For LoopFollow you can also select "macOS" if you own a Mac with macOS 11 or later.
   • Enter a name: this will have to be unique
     • You could start with "App Name ABC" where ABC are your initials
     • If that is already taken, you can add a number, for example, "App Name ABC 123"
     • This name is what you see on the App Store Connect list and in the TestFlight app
     • Once installed on your phone, you will see the actual app name
     • You can Change the App Store Connect Name later if you want
   • Select your primary language.
   • Choose the bundle ID for your app
   • SKU can be anything; for example "123" but must be unique across all your apps, so try 1234 or 12345 depending on how many apps you build with this method
   • Select "Full Access".

   

5. Click Create but do not fill out the next form. That is for submitting to the app store and you will not be doing that.

You are done with the create app step.

You will use this same browser location to complete the next step. Tap on the TestFlight tab at the top of the page.

Add Users to TestFlight for App¶

If you are not already on your app page because you just created it, use this link to get there: App Store Connect / Apps. Find your app and click on it and then select the TestFlight tab at the top of the page.

You need to configure a TestFlight Internal Testing Group for each app you build and invite the users (including yourself).

• Each person added to the Internal Testing Group gets an invitation to join the group for this app
• Then after each successful build of the app, group members will get a notification when the new build is transferred to TestFlight and is available for use
• They open the TestFlight app on their phone to install the new build

If you need detailed instruction, visit Configure to Use Browser: TestFlight Users Overview.

Build App¶

Display Name Customization for LoopFollow¶

If you build LoopFollow for one, two or three loopers, you may choose to customize your fork or forks to insert a custom display name.

• Find and click on the file LoopFollowDisplayNameConfig.xcconfig
• Tap the pencil icon so you can edit the file
• The last line says display_name = LoopFollow (or LoopFollow_Second or LoopFollow_Third)
• Insert your custom name so the last line says display_name = LF custom name
• Click on commit changes and choose to commit directly into the main branch

Continue to build as instructed below. After you install the app on your phone, iPad or Mac via TestFlight, that custom name is what is displayed. The prefix LF is suggested to make it easier to find the custom named LoopFollow app in the list of apps, but is not required.

Build Action¶

1. Click on the Actions tab of your LoopFollow repository
2. On the left side, click on 4. Build LoopFollow
3. On the right side, click Run Workflow to show a dropdown menu
4. Tap the green button that says Run workflow.

Once this completes, be sure to update from TestFlight to get the updated version of LoopFollow on your phone.

Repeat the build and install from TestFlight steps if you use LoopFollow_Second or LoopFollow_Third.

Your app should eventually appear on App Store Connect.

Build Errors¶

Refer to the Browser Build: Build Errors to find your error.

Please do not remove an existing app if you have trouble building a new one. Your build error is not caused by any existing app.

Install on Phone¶

The LoopDocs instructions: Install on Phone walk you through the steps to install the app to a phone. When going through those steps, replace your App Name for Loop. Everything else is the same.

Legacy: Updating from v3.x¶

Given that a Browser Build must be rebuilt every 90 days, the instructions here are unlikely to be required.

Update from LoopFollow v3.x¶

When updating from an older version of LoopFollow, v3.x or older, you need to add the Push Notification to the Identifier Capabilities:

• Sync Your Fork
• Run Add Identifiers to add the new capability
• Build Your App

Repeat these steps if you use LoopFollow_Second or LoopFollow_Third.

Sync Your Fork¶

• Go to your LoopFollow fork and click on the Sync button

Run Add Identifiers¶

• In your LoopFollow fork, select the Action tab and run the Add Identifiers Action
• Wait for a successful completion before trying to Build.

Build Your App¶

• In your LoopFollow fork, select the Action tab and run the Build LoopFollow Action
• Wait for a successful completion and wait for the TestFlight upload (timing varies from a few minutes to a few hours) until trying to install the new build on your phone

Once this completes, be sure to update from TestFlight to get the updated version of LoopFollow on your phone.