Skip to content

Latest commit

 

History

History
306 lines (213 loc) · 20.2 KB

testflight.md

File metadata and controls

306 lines (213 loc) · 20.2 KB
Raw

Using Github Actions + FastLane to deploy to TestFlight: the "Browser Build" method

These instructions allow you to build Trio without having access to a Mac.

  • You can install Trio on phones using TestFlight that are not connected to your computer
  • You can send builds and updates to those you care for
  • You can install Trio on your phone using only the TestFlight app if a phone was lost or the app is accidentally deleted
  • You do not need to worry about specific Xcode/Mac versions for a given iOS

Automatic Builds

The browser build defaults to automatically updating and building a new version of Trio according to this schedule:

  • automatically checks for updates weekly on Wednesdays and if updates are found, it will build a new version of the app
  • automatically builds once a month regardless of whether there are updates on the first of the month
  • with each scheduled run (weekly or monthly), a successful Build Trio log appears - if the time is very short, it did not need to build - only the long actions (>10 minutes) built a new Trio app

It also creates an alive branch, if you don't already have one. See Why do I have an alive branch?.

The Optional section provides instructions to modify the default behavior if desired.

Introduction

The setup steps are somewhat involved, but nearly all are one time steps. Subsequent builds are trivial. Your app must be updated once every 90 days, but it's a simple click to make a new build and can be done from anywhere.

Note that installing with TestFlight requires the Apple ID account holder for the phone be 13 years or older (age varies with country). This can be circumvented by logging into Media & Purchase on the child's phone with an adult's account. More details on this can be found in LoopDocs.

This method for building without a Mac was ported from Loop. If you have used this method for Loop or one of the other DIY apps (Loop Caregiver, Loop Follow, xDrip4iOS), some of the steps can be re-used and the full set of instructions does not need to be repeated. This will be mentioned in relevant sections below.

There are more detailed instructions in LoopDocs for doing Browser Builds of Loop and other apps, including troubleshooting and build errors. Please refer to LoopDocs for more details.

If you build multiple apps, you may want to use a free GitHub organization. Please refer to LoopDocs: Use a GitHub Organization Account.

Prerequisites

  • A github account. The free level comes with plenty of storage and free compute time to build Trio, multiple times a day, if you wanted to.
  • A paid Apple Developer account.
  • Some time. Set aside a couple of hours to perform the setup.
  • Use the same GitHub account for all "Browser Builds" of the various DIY apps.

Save 6 Secrets

You require 6 Secrets (alphanumeric items) to use the GitHub build method and if you use the GitHub method to build other apps, e.g., Loop Follow or xDrip4iOS, you will use the same 6 Secrets for each app you build with this method. Each secret is indentified below by ALL_CAPITAL_LETTER_NAMES.

  • Four Secrets are from your Apple Account
  • Two Secrets are from your GitHub account
  • Be sure to save the 6 Secrets in a text file using a text editor
    • Do NOT use a smart editor, which might auto-correct and change case, because these Secrets are case sensitive

Refer to LoopDocs: Make a Secrets Reference File for a handy template to use when saving your Secrets.

Generate App Store Connect API Key

This step is common for all GitHub Browser Builds; do this step only once. You will be saving 4 Secrets from your Apple Account in this step.

  1. Sign in to the Apple developer portal page.
  2. Copy the Team ID from the upper right of the screen. Record this as your TEAMID.
  3. Go to the App Store Connect interface, click the "Integrations" tab, and create a new key with "Admin" access. Give it the name: "FastLane API Key".
  4. Record the issuer id; this will be used for FASTLANE_ISSUER_ID.
  5. Record the key id; this will be used for FASTLANE_KEY_ID.
  6. Download the API key itself, and open it in a text editor. The contents of this file will be used for FASTLANE_KEY. Copy the full text, including the "-----BEGIN PRIVATE KEY-----" and "-----END PRIVATE KEY-----" lines.

Create GitHub Personal Access Token

If you have previously built another app using the "browser build" method, you use the same personal access token (GH_PAT), so skip this step.

Log into your GitHub account to create a personal access token; this is one of two GitHub secrets needed for your build.

  1. Create a new personal access token:
    • Enter a name for your token, use "FastLane Access Token".
    • Change the Expiration selection to No expiration.
    • Select the workflow permission scope * this also selects repo scope.
    • Click "Generate token".
    • Copy the token and record it. It will be used below as GH_PAT.

Make up a Password

This is the second one of two GitHub secrets needed for your build.

The first time you build with the GitHub Browser Build method for any DIY app, you will make up a password and record it as MATCH_PASSWORD. You use the same password for all DIY apps. Note, if you later lose MATCH_PASSWORD, you will need to delete your Match-Secrets repository (automatically created), and go through the GitHub actions again.

GitHub Match-Secrets Repository

A private Match-Secrets repository is automatically created under your GitHub username the first time you run a GitHub Action. Because it is a private repository - only you can see it. You will not take any direct actions with this repository; it needs to be there for GitHub to use as you progress through the steps.

Setup Github Trio repository

  1. Fork https://github.com/nightscout/Trio into your account. If you already have a fork of Trio in GitHub, you can't make another one. You can continue to work with your existing fork, or delete that from GitHub and then fork https://github.com/nightscout/Trio.
  2. In the forked Trio repo, go to Settings -> Secrets and variables -> Actions.
  3. For each of the following secrets, tap on "New repository secret", then add the name of the secret, along with the value you recorded for it:
    • TEAMID
    • FASTLANE_ISSUER_ID
    • FASTLANE_KEY_ID
    • FASTLANE_KEY
    • GH_PAT
    • MATCH_PASSWORD

Validate repository secrets

This step validates most of your six Secrets and provides error messages if it detects an issue with one or more. In addition, if you do not have a private Match-Secrets repository it creates one for you.

  1. Click on the "Actions" tab of your Trio repository and enable workflows if needed
  2. On the left side, select "1. Validate Secrets".
  3. On the right side, click "Run Workflow", and tap the green Run workflow button.
  4. Wait, and within a minute or two you should see a green checkmark indicating the workflow succeeded.
  5. The workflow will check if the required secrets are added and that they are correctly formatted. If errors are detected, please check the run log for details.

There can be a delay after you start a workflow before the screen changes. Refresh your browser to see if it started. And if it seems to take a long time to finish - refresh your browser to see if it is done.

Add Identifiers for Trio App

  1. Click on the "Actions" tab of your Trio repository.
  2. On the left side, select "2. Add Identifiers".
  3. On the right side, click "Run Workflow", and tap the green Run workflow button.
  4. Wait, and within a minute or two you should see a green checkmark indicating the workflow succeeded.

Create App Group

If you previously built Trio using Mac with Xcode with this Apple ID, skip ahead to Optional: App Group Description Modification.

Please note that Trio uses a Trio-specific app group, not the same as Loop. This enables other apps such as xDrip4iOS to share data with Trio. It may require some caution if transfering between Trio and Loop.

  1. Go to Register an App Group on the apple developer site.
  2. For Description, use "Trio App Group".
  3. For Identifier, enter group.org.nightscout.TEAMID.trio.trio-app-group, substituting your team id for TEAMID.
  4. Click "Continue" and then "Register".

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 Trio App Group. Notice in the table below that the Xcode version of the NAME is the same as the IDENTIFIER but with the . replaced with a space.

Referring to the link and table below, tap on the IDENTIFIER for the Trio App Group, edit the Description to match the NAME, then Save the change.

NAME Xcode version IDENTIFIER
Trio App Group group org nightscout TEAMID trio trio-app-group group.org.nightscout.TEAMID.trio.trio-app-group

Bundle Identifiers

Open this link in a separate browser window:

Optional: Identifier Description Modification

This step is not required, but if you previously built using a Mac with Xcode or during early Beta testing for Trio, it is a good idea to update the NAME associated with each IDENTIFIER to match the table below.

Referring to the table below, tap on each IDENTIFIER that has a different NAME, edit the Description to match the NAME, then Save the change for that identifier.

Table of Identifiers

  • If you built previously using a Mac with Xcode, you may see the Xcode version in your NAME column - it starts with XC and then the IDENTIFIER is appended where the . is replaced with a space, the example for Trio is shown in detail
  • If you built during early beta testing, you might not have Trio at the beginning of each IDENTIFIER and the full NAME may be slightly different
  • If you built during early beta testing, you might have the Loop App Group associated with the Trio identifiers. If so, use instructions to Create App Group for Trio. Subsequently, modify the App Group associated with the Trio Identifiers using Add App Group to Bundle Identifiers.
NAME Xcode version IDENTIFIER
Trio XC org nightscout TEAMID trio org.nightscout.TEAMID.trio
Trio LiveActivity - org.nightscout.TEAMID.trio.LiveActivity
Trio Watch XC IDENTIFIER org.nightscout.TEAMID.trio.watchkitapp
Trio WatchKit Extension XC IDENTIFIER org.nightscout.TEAMID.trio.watchkitapp.watchkitextension

Add App Group to Bundle Identifiers

This step is required for first-time builders using GitHub Actions (Browser Build).

If you previously built using a Mac with Xcode you can skip ahead to Create Trio App in App Store Connect.

If you have previously built Trio as a beta tester (between May 13th, 2024, and today), you will already have an app group (Loop App Group) created and configured for your bundle identifiers. In this case, please do not skip this section; you are required to create the Trio App Group and configure it for your identifiers, as described below.

  1. Go to Certificates, Identifiers & Profiles on the Apple developer site.
  2. Repeat this step for these three Identifier NAMES - refer to the Table above if your Names look different; if they do, see Optional: Identifier Description Modification
    • Trio
    • Trio Watch
    • Trio WatchKit Extension
  3. Click on the IDENTIFIER row.
  4. Scroll down to the "App Groups" capabilies row, click on the "Configure" (or "Edit") button.
  5. Select the "Trio App Group" (yes, "Trio App Group" is correct)
  6. Click "Continue".
  7. Click "Save".
  8. Click "Confirm".
  9. Remember to do this for each of three identifiers listed under step 2.

There is an additional identifier, but it does not need the App Group added to it:

  • Trio LiveActivity

Create Trio App in App Store Connect

If you created a Trio app in App Store Connect before, skip ahead to Create Building Certficates.

  1. Go to the apps list on App Store Connect and click the blue "plus" icon to create a New App.
    • Select "iOS".
    • Select a name: this will have to be unique, so you may have to try a few different names here, but it will not be the name you see on your phone, so it's not that important.
    • Select your primary language.
    • Choose the bundle ID that matches the BUNDLE_IDENTIFIER in your Config.xcconfig file
    • This is typically org.nightscout.TEAMID.trio with TEAMID matching your team id
    • SKU can be anything; e.g. "123".
    • Select "Full Access".
  2. Click Create

You do not need to fill out the next form. That is for submitting to the app store.

Create Building Certficates

  1. Go back to the "Actions" tab of your Trio repository in github.
  2. Select "3. Create Certificates".
  3. Click "Run Workflow", and tap the green button.
  4. Wait, and within a minute or two you should see a green checkmark indicating the workflow succeeded.

Build Trio!

  1. Click on the "Actions" tab of your Trio repository.
  2. On the left side, select "4. Build Trio".
  3. Click "Run Workflow", select your branch, and tap the green button.
  4. You have some time now. Go enjoy a coffee. The build should take about 15 minutes.
  5. Your app should eventually appear on App Store Connect.
  6. For each phone/person you would like to support Trio on:
    • Add them in Users and Access on App Store Connect.
    • Add them to your TestFlight Internal Testing group.

TestFlight and Deployment Details

For more details, please refer to LoopDocs: Set Up Users and LoopDocs: Deploy

Automatic Build FAQs

Why do I have an alive branch?

If a GitHub repository has no activity (no commits are made) in 60 days, then GitHub disables the ability to use automated actions for that repository. We need to take action more frequently than that or the automated build process won't work.

The build_trio.yml file uses a special branch called alive and adds a dummy commit to the alive branch at regular intervals. This "trick" keeps the Actions enabled so the automated build works.

The branch alive is created automatically for you. Do not delete or rename it! Do not modify alive yourself; it is not used for building the app.

OPTIONAL

What if you don't want to allow automated updates of the repository or automatic builds?

You can affect the default behavior:

  1. GH_PAT workflow permission
  2. Modify scheduled building and synchronization

GH_PAT workflow permission

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 verify your token holds this permission, follow these steps.

  1. Go to your FastLane Access Token
  2. It should say repo, workflow next to the FastLane Access Token link
  3. If it does not, click on the link to open the token detail view
  4. Click to check the workflow box. You will see that the checked boxes for the repo scope become disabled (change color to dark gray and are not clickable)
  5. Scroll all the way down to and click the green Update token button
  6. Your token now holds both required permissions

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.

Modify scheduled building and synchronization

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 Trio 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: set SCHEDULED_SYNC to false and either do not create SCHEDULED_BUILD or set it to true
  • If you want to only build when an update has been found: set SCHEDULED_BUILD to false and either do not create SCHEDULED_SYNC or set it to true
    • Warning: if no updates to your default branch are detected within 90 days, your previous TestFlight build may expire requiring a manual build
SCHEDULED_SYNC SCHEDULED_BUILD Automatic Actions
true (or NA) true (or NA) keep-alive, weekly update check (auto update/build), monthly build with auto update
true (or NA) false keep-alive, weekly update check with auto update, only builds if update detected
false true (or NA) keep-alive, monthly build, no auto update
false false no automatic activity, no keep-alive

How to configure a variable

  1. Go to the "Settings" tab of your Trio 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 Trio 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