Build Beta with Browser

Use Browser Build for Public Beta Version¶

This page is provided to help people currently running the public beta version of Trio.

Update to Trio dev branch from Trio 0.2.x main¶

The Browser Build documentation is under construction for Trio version 0.5.x and newer.

This temporary set of instructions is intended for the subset of users who previously built Trio 0.2.x using Browser Build. Because this is aimed at experienced builders, some of the steps are abbreviated and will be expanded as the documents are updated.

If you are new to Trio — please wait until the documents have been expanded and preferably until the release of Trio 1.0.

Mac-Xcode to Browser Build¶

Transition from Other Apps to Trio Browser Build¶

Summary of Tasks to Build Trio 0.5.x¶

These steps assume:

• You previously built Trio 0.2.x using GitHub Actions (Browser Build)
• You confirmed your Apple Developer license agreements are up to date

These are the new steps for you to follow:

1. Configure Browser Build Certificate Automation
2. Configure Fork with dev branch
   • Configure the dev branch as default (while public beta is ongoing)
3. Update Identifiers
4. Update Certificates
5. Build Trio 0.5.x

Browser Build Certificate Automation¶

Browser Build Certificate Automation was added to Trio 0.2.3 - if you have not added the ENABLE_NUKE_CERTS variable, you should add it now. Otherwise, skip ahead to Configure Fork with dev branch.

In order to utilize the new automatic certificate renewal feature, you’ll need to add a new Variable. Variables are located in GitHub, in the same location as your Secrets. The exact location will depend upon whether you build using a GitHub organization or a personal account.

If you use a personal account, click on your Trio repository. If you have other repositories, just follow these same steps for each of them.

If you build using a GitHub organization and have already added this variable to your organization, there’s nothing for you to do. All repositories in your organization are covered. Otherwise, click on your organization name.

The numbered steps correspond to numbers in the graphics below:

1. Choose settings
2. Scroll down to select Secret and variables
3. Choose Actions
4. Choose Variable
5. Tap on “Create new organization variable” or “New repository variable”
6. For the Name, type ENABLE_NUKE_CERTS
7. For the Value, type true
8. Tap on Add Variable.

Configure Fork with dev branch¶

The open beta testing for Trio uses the dev branch.

• If you do not have a dev branch you must first configure one following these directions.
• If you already have a dev branch, skip ahead to Update Branch and be sure to select the dev branch when you update your fork.

Add Branch¶

First, you need to get to your Trio repository and tap on the branch icon. (Do not worry about how many branches you have.):

The next screen displays the branches you currently have. It shows a New branch button in the upper right. If you don't see that, you are not logged in. Tap on the New branch button.

Each step in the list below matches with the number in the graphic. On the left half of the graphic is the default selections for your fork when main is the default branch. The right side shows the display after making the indicated selections.:

1. Click on the drop-down menu labeled 1 in the graphic and choose nightscout/Trio
2. Click on the drop-down menu labeled 2 in the graphic and choose dev
3. Click on the Branch name box labeled 3 in the graphic and type dev
   • The branch name in your fork should always match the branch name you are adding; check that you type it correctly
4. Review the dialog items to make sure everything is correct, and then tap on Create branch

Configure the dev branch as default¶

This recommendation is only while the public beta is ongoing. Typically only developers configure the dev branch as their default branch.

1. Once you commit to the 0.5.x version of Trio, you want to stay with it
2. By making the dev branch your default, you will get automatic build updates weekly

These are the steps to modify the default branch.

For this example, we show how to change from a default branch of main to a default branch of dev. Note — only the owner of the repository can take this action and they must be logged in. Otherwise the Settings tab does not appear.

For the numbered steps below, refer to the graphic found under each group of steps.

1. Click on the Settings Icon near the top right of your Trio repository

   • You may need to scroll down to see the Default Branch as shown in the graphic
   • Do not tap on the Branches tab to the left under Code and Automation, that is not the correct menu

   

2. To the right of the default branch name there is a pencil and a left-right arrow icon (⇄)

   • Tap on the left-right arrow icon (⇄) to bring up the Switch default branch to another branch dialog
3. Click on the dropdown next to the current default branch, in this example, main

1. Select the desired default branch, for the public beta, choose dev

2. Click on the Update button

3. You will be presented with an are-you-sure question.

   • Click on the red I understand, update the default branch. button

Your default branch has been changed.

Update Branch¶

The dev branch of the nightscout/Trio repository will be updated frequently. This is how you know if your fork needs to be updated as well. As long as the automatic runs are happening weekly for your repository — you will not need these manual instructions, unless you want to manually build an update sooner.

Tap the Code button (upper left) and ensure this branch in your fork is up to date.

• Select the desired branch in the dropdown menu (this graphic shows main branch, to get 0.5.x, you must choose dev branch)
• If the message indicates this branch is "behind", tap on the sync fork button and then the Update branch button

Update Identifiers¶

For Trio 0.5.x and newer, you must have Apple Push Notification enabled to build the app. This capability is added to the existing Trio Identifier by running the Action: Add Identifiers after you update your fork.

Refer to the graphic below for the numbered steps:

1. Click on the Actions tab of your Trio repository
2. On the left side, click on 2. Add Identifiers
3. On the right side, click Run Workflow to show a dropdown menu
   • You will see your default branch (typically this is main)
   • To update the Identifiers so you can build the Trio 0.5.x, you must select dev

4. Tap the green button that says Run workflow.

   

The Add Identifiers Action  should succeed or fail in a few minutes. Do not continue to the next step until this one succeeds.

Update Certificates¶

For Trio 0.5.x and newer, you must have Apple Push Notification enabled to build the app. After you add this capability to the Trio Identifier, you must update the Certificate by running the Action: Create Certificates.

Refer to the graphic below for the numbered steps:

1. Click on the Actions tab of your Trio repository
2. On the left side, click on 3. Create Certificates
3. On the right side, click Run workflow to show a dropdown menu
   • You will see your default branch (typically main)
   • Because you plan to build Trio 0.5.x, select dev

4. Tap the green button that says Run workflow.

   

5. Wait a minute or two for the action to finish

Once you see the green check mark by Create Certificates, the next step is to Build the app.

Build the App¶

If you completed all the steps on this page successfully (got a green checkmark ✅), you are ready to run Action: Build Trio.

We recommend that while participating in the public beta, you should Configure the dev branch as default. This will ensure weekly updates to TestFlight. You must still manually install updates to your phone from TestFlight.

If you choose to build a different branch than your default branch, there is an extra step when you Build Trio. In addition to the normal steps 1, 2, and 3 in the graphic below, you must also do the (optional) step. Select the dev branch in the branch dropdown menu before continuing to step 4 and tapping on the green Run workflow button:

Refresh, Do Not Repeat¶

Disable the DO NOT RUN Actions¶

You may notice some GitHub actions that have DONT RUN or DO NOT RUN in their names. Those are special actions that are used by the developers. They are skipped in your Fork, but you may see logs for them.

If they already have the notation disabled beside them, so won't see them run. Otherwise, click on each one, click on the three dots at the upper right, and then select Disable workflow. Then you will avoid the annoyance of seeing logs that say the action was automatically run and then skipped.

Update Build Errors¶

The most likely build error is that you did not Update Identifiers and Certificates.
In that case, you will see this error in the build action annotations.

Error¶

If you decide to look at the action log, instead of reading the annotations, you may see an error similar to the two graphics below.

Solution¶

1. Update Identifiers - make sure you select dev branch
2. Update Certificates - make sure you select dev branch

New Trio Builders¶

For experienced browser builders, this minimal set of instructions might be sufficient.
Warning - there is no hand holding in these directions.

Every app you build will use the same 6 Secrets.

• Fork from: https://github.com/nightscout/Trio
• Use the Trio App Group for Trio, see Create the Trio App Group
• Identifiers for Trio: see Table of Identifiers
• Add the Trio App Group to these Identifiers:
  • Trio
  • Trio Watch
  • Trio WatchKit Extension
• In App Store Connect, the Bundle ID for Trio will be: org.nightscout.TEAMID.trio

Create the Trio App Group¶

If you already have a Trio App Group

• You can skip this step - your existing App Groups are found at this link: App Group List
• If your Trio App Group was created from a Mac with Xcode, you may choose to edit the Description to make the NAME match

If you do not have a Trio App Group:

• Go to Register an App Group on the Apple developer site and use the table below to help you create one.
• Replace TEAMID with your Apple Developer ID.

Table of Identifiers¶

These are the Identifiers created by running the GitHub action "Add Identifiers". Only 3 of them need to have the Trio App Group added. Be sure that you selected the dev branch when you start the "Add Identifiers" action. For more details, see Update Identifiers, but then return here when that action succeeds.

Add Trio App Group to Identifiers¶

• Open the App IDs Identifier page for your Apple Developer Account.
  • Click on the Trio Identifier and assign the Trio App Group to the Identifier - see graphic below.

    

  • Repeat this for the other 2 Identifiers that need to have an App Group assigned: Trio Watch and Trio WatchKit Extension

Configure Trio App¶

Follow the directions in LoopDocs, but use the Trio Bundle ID

• In App Store Connect, the Bundle ID for Trio will be: org.nightscout.TEAMID.trio

Return to the main set of instructions on this page, Update Certificates, and keep going until you have a successful build.

Extra Tips¶

Remove Annoying Message¶

If you accidentally build 0.2.x over 0.5.x, and then return to 0.5.x:

• You will see “Oops? Some data didn’t make it over” every time you restart the app
• But all your "stuff" is there

You see that because some special files are labeled with .migrated by 0.5.x when you complete the onboarding action when you upgrade from 0.2.x to 0.5.x.

• When you accidentally build 0.2.x over 0.5.x, the old names for the files are recreated
• When you restore to 0.5.x, it sees the duplicate files, one set has .migrated in the file name and one set does not
• You are warned that migration can't happen - but for this case, you don't need it

You can get rid of the annoying message by taking these steps:

First quit (stop running, swipe up) the Trio app

• Search for Files on your phone
• Open the Trio folder on your phone
• Open the enact folder
  • you may see 4 files, instead of 2
  • delete the ones that do not have .migrated in the name
• Open the monitor folder
  • you will probably see many files, but 3 of them have .migrated in the name
  • find the files with the same name except for .migrated and delete them

Open the Trio app and it should just say "Getting everything ready for you" and just keep going. Annoying message is gone.