Automatic Update & Build

Overview

The instructions on the Configure to Use Browser page will, unless you make a change, automatically take the following actions for released versions 3.4.1 and newer:

• Update the version of your fork within a week of the change
  • When an update to the default branch, typically main, is detected, a new build is created automatically and uploaded to TestFlight
• Build the app at least once a month and upload the fresh build to TestFlight

If you do not want this automatic schedule, you can modify it.

This only works because of special branches that are automatically created in your repository.

• What are the alive branches and why do I need them?

Regardless of your choice, please Disable Automatic Installation from TestFlight. You should be alert any time your Loop app is updated. Check that all settings are maintained and pay attention to make sure the app behavior is nominal.

You still need to take these actions to ensure a recent build of the Loop app is available in TestFlight for you to install on your phone when you choose:

• Keep your Apple Developer account up to date with agreements signed
• Renew Certificate once a year

Successful Weekly Action

Normally, you will see a successful build action once a week. This happens at 08:00 UTC every Wednesday.

If there are no updates to the main branch, your actions show a very short, successful build action as shown in the graphic below. It only takes about a minute because the logic says - no update then skip the build.

If there is an update, the build action updates your fork and creates a new build.

In that case, you should check your favorite information site to find out what the update was and then, when you are ready, install the update using the TestFlight app on your phone.

Successful Monthly Action

On the first day of every month at 06:00 UTC, you will see a successful build action. The purpose of this build is to provide a recent version of the app in TestFlight so you are never in a situation where you have no app on your phone.

You start getting Notifications when there are fewer than 20 days until expiration. When you see the warning, install the newest build from your TestFlight app. You do not want to get the dreaded "Loop Beta is not available" message on your phone. (The warnings get very agressive when close to expiration.)

Modify Automatic Building

For someone using development code for their own use, they could decide to choose when to update their fork to the most recent commit. They can still have the advantage of automatic building without automatic updates; in other words, they want a new build added to TestFlight every month. There may be other configurations someone would choose. These options are available starting with Loop 3.3.0 (dev branch) and later.

You can affect the default behavior:

1. Modify Automatic Schedule
2. Disable Automatic Actions

Modify Automatic Schedule

This is an optional step. If you are happy with the automatic sync and update, you are done with this page.

Instructions to Modify the Automatic Actions (Click to Open/Close)

You can modify the automation by creating and using some variables.

To configure the automated build more granularly involves creating up to two environment variables: SCHEDULED_BUILD and/or SCHEDULED_SYNC. See How to configure a variable.

Note that the weekly and monthly Build Loop actions will continue, but the actions are modified if one or more of these variables is set to false. A successful Action Log will still appear, even if no automatic activity happens.

• If you want to manually decide when to update your repository to the latest commit, but you want the monthly builds and keep-alive to continue:
  • create the variable SCHEDULED_SYNC and set it to false
  • either do not create the variable SCHEDULED_BUILD or set it to true
  • If you are building the dev branch at a time when there is a lot of activity in that branch, you may want this configuration
• If you want to only build when an update has been found:
  • either do not create the variable SCHEDULED_SYNC or set it to true
  • create the variable SCHEDULED_BUILD and set it to false
  • Warning: if no updates to your default branch are detected within 90 days, your previous TestFlight build may expire requiring a manual build
  • During a time when updates are not happening frequently, this is not a good choice

SCHEDULED_SYNC	SCHEDULED_BUILD	Automatic Actions
true (or N/A)	true (or N/A)	This is the default: keep-alive, weekly update check (auto update/build), monthly build with auto update
false	true (or N/A)	keep-alive, monthly build, no auto update
true (or N/A)	false	keep-alive, weekly update check with auto update, only builds if update detected
false	false	no automatic activity, no keep-alive

How to configure a variable

1. Go to the "Settings" tab of your LoopWorkspace repository.
2. Click on Secrets and Variables.
3. Click on Actions
4. You will now see a page titled Actions secrets and variables. Click on the Variables tab
5. To disable ONLY scheduled building, do the following:
   • Click on the green New repository variable button (upper right)
   • Type SCHEDULED_BUILD in the "Name" field
   • Type false in the "Value" field
   • Click the green Add variable button to save.
6. To disable scheduled syncing, add a variable:
   • Click on the green New repository variable button (upper right)
   • • Type SCHEDULED_SYNC in the "Name" field
   • Type false in the "Value" field
   • Click the green Add variable button to save

Your build will run on the following conditions:

• Default behaviour:
  • Run weekly, every Wednesday at 08:00 UTC to check for changes; if there are changes, it will update your repository and build
  • Run monthly, every first of the month at 06:00 UTC, if there are changes, it will update your repository; regardless of changes, it will build
  • Each time the action runs, it makes a keep-alive commit to the alive branch if necessary
• If you disable any automation (both variables set to false), no updates, keep-alive or building happens when Build Loop runs
• If you disabled just scheduled synchronization (SCHEDULED_SYNC set tofalse), it will only run once a month, on the first of the month, no update will happen; keep-alive will run
• If you disabled just scheduled build (SCHEDULED_BUILD set tofalse), it will run once weekly, every Wednesday, to check for changes; if there are changes, it will update and build; keep-alive will run

Disable Automatic Actions

To enable the scheduled build and sync, the GH_PAT must hold the workflow permission scopes. This permission serves as the enabler for automatic and scheduled builds with browser build. To disable this, follow these steps:

1. Go to your FastLane Access Token
2. If it says repo, workflow next to the FastLane Access Token link, then automatic building is enabled
3. To disable automatic update and build, click on the link to open the token detail view
   • Click to uncheck the workflow box
   • Click to check the repo box
4. Scroll all the way down to and click the green Update token button
5. Your token now holds only the repo permission

If you choose not to have automatic building enabled, be sure the GH_PAT has repo scope or you won't be able to manually build.

Stop Building

What if I decide I don't want the automatic building feature?

• If you are using the released version of Loop, please leave automatic building running

  • Please read TestFlight Automatic Updates on how to configure TestFlight so you choose when the updated app gets installed on your phone
  • Otherwise, you may see the dreaded "Loop Beta has expired" message, have a Loop that won't open and not have a version ready to go in TestFlight that you can install within a few seconds

• If you are taking a break from Loop and want to stop monthly Build emails, consider disabling actions for the Build Loop action for your app.

  • GitHub Directions to Disable and Enable a Workflow
  • It is the Build action that kicks off the update and build steps, so simply disabling the one action is sufficient

• If you are done with Loop, you can delete the whole repository; but you should be sure about this because you'll need to start over with Configure to Use Browser to restore ability to build Loop with GitHub.

What are the alive branches and why do I need them?

The automatic update and build features of version 3.4.1 and later use branches that start with the name alive. You may see branches called alive, alive-dev and alive-main in your repository. These are automatically created. They are used to keep GitHub actions working in your repository.

• GitHub keeps track of repositories
• If there is no activity in a given repository in 60 days, GitHub disables Actions

In other words, during a time when the Loop app is fairly stable, your automatic update and build features would just stop working.

No one wants that. The alive branches are created and used to make sure at least one commit per month is added to an alive branch in your repository. That keeps your repository active to allow the automatic update and build process to work.

The alive branches are only used for the keep-alive functions. Do not build using an alive branch. Most people will build using the default branch of main.

Automatic Creation of alive branch

The alive branch you need is created automatically when you run the Build Loop action.

I got an error regarding a branch with alive in the name

• Sometimes you get an error about an alive branch
• If you do get an error, simply delete the branch and run the Build Loop action again
  • Use this GitHub link or ask for help when deleting a branch
• You can delete every branch that starts with the name alive
• Leave the other branches alone unless a mentor directs you to take action