Introduction to Secrets¶

In order to build using the Browser Build method, you will need to collect and save six secrets from your free GitHub account and your paid Apple Developer account.

Save Your Information¶

Everyone needs to read this section!

You need to keep a digital copy of your 6 Secrets.

• You need to copy and paste those Secrets to build the app with a browser
• Make sure your editor does not change any characters in your Secrets; use a text-only editor like NotePad (PC) or TextEdit (Mac)
• Many people add other information to the Secrets file for easy reference

Make a Secrets Reference File¶

Please save yourself a lot of agony. Make a Secrets Reference folder and then create a Secrets Reference file in it.

You don't need to know anything about the Secrets to do this. Come up with your own names, but make sure you know where you put this file.

1. Decide where you want your Secrets saved and create a special folder
2. Open a text-only editor (do not use a Smart Editor, those might change capitalization or formatting and ruin your Secrets)
   • Create a blank Secrets Reference file using the text-only editor
   • Tap on the copy icon below to copy the template and paste it into your blank file
   • Save the file
3. As you move through the steps of collecting the six secrets, fill in the file
   • The ## characters are used to indicate sections or title (text only file)
   • There is a reference pattern for each SECRET: replace that with your SECRET or you can add your secret below the pattern to give yourself confidence you got the correct item
4. In addition to the Secrets, this template has places for other pieces of information you may find handy to save in the same file
5. At the very beginning is a place to indicate the last day you updated the file

MySecretsReferenceFile.txt

## This file updated on: DD MMM YYYY

Information needed to use Browser Build.
The same secrets are used for every app you build.

First some handy username and password information:

## Apple ID username for your Developer account is the associated email:
<your information here>
suggest you use your desired password tool to save the password for this account

## GitHub personal account username
<your information here>
suggest you use your desired password tool to save the password for this account

### GitHub organization name
<your GitHub organization name>
Using an organization is optional.
But it you do use one, add the name here for reference.
You always log in using your GitHub personal account to access your organization.

There are Six Secrets and One Variable:
 - the list below shows the expected format of each.
You can replace each prototype with your secret as you gather them,
 - or put your secret below a prototype.
The letter A indicates an alphanumeric character;
 - some may be small letter, some capital letters and some numerals.
The FASTLANE_KEY may have additional characters included.
  Be sure to copy the entire key including
  -----BEGIN PRIVATE KEY-----
  through
  -----END PRIVATE KEY-----

## SECRETS BELOW:

TEAMID
<looks like this>
AAAAAAAAAA

FASTLANE_ISSUER_ID
<looks like this>
AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA

FASTLANE_KEY_ID
<looks like this>
AAAAAAAAAA

FASTLANE_KEY
<looks like this>
-----BEGIN PRIVATE KEY-----
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
AAAAAAAA
-----END PRIVATE KEY-----

GH_PAT
<looks like this>
ghp_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

MATCH_PASSWORD
<looks like this>
AnyThingYouWant-sameForEveryRepository

This Variable (not a secret) is required for the annual certificate renewal:

ENABLE_NUKE_CERTS = true

## Repository Names for my Fork:

If you use an organization (recommended)
https://github.com/my-name-org/Trio

or (if you don't use an organization): 
https://github.com/my-name/Trio


Add additional apps here if you decide to build any

New Terms with GitHub Browser Build¶

The GitHub Browser Build may use new and unfamiliar terms.

These instructions can be used without knowing what any of these terms mean. But if you are curious:

Some of these terms have ToolTips, so hover your mouse over those - or review them in the Glossary.

• Some terms in the Glossary are not in alphabetical order to improve logical grouping. All the individual Secrets are listed after Secrets in the Glossary.

• Actions: available in your GitHub repositories to build your app

  • You must be logged in to GitHub to run the actions manually
  • The build action is automatically run for you once your repository is configured
• Fork: you make a copy of the code needed to build an app and store it in your GitHub account (using a free GitHub organization is recommended for storing your forks)
• Secrets: are required to enable GitHub to build an app from a repository using GitHub Actions
  • Six Secrets must be entered to enable your app (or apps) to build
  • These Secrets work for any branch in your fork (main or dev, for example) and if you use the recommended free GitHub organization to build, they work for any app you fork to your organization
  • If you build more than one app, they use the same Secrets and the use of a GitHub organization is even more strongly recommended
• Certificates: These are required to enable GitHub to build an app from a repository using GitHub Actions
  • They are manually created with the Create Certificates action
  • They expire at the end of one year
  • Certificates are automatically renewed as long as you add the required Variable
• API Key:Application Programming Interface Key
  • You create an API key from the Apple Developer website
  • Doing this provides 3 of your Secrets
  • These secrets enable your GitHub account to interface with Apple to create your app
• Identifiers: are required to build the Trio app with GitHub Browser Build (these are automatically generated for you) when you run Add Identifiers
• App Store Connect: a website available for Apple Developers to review apps build with your Apple Developer account
  • Once you purchase an Apple Developer annual account, you are an Apple Developer and have access to this site
  • Most users will not have an App until using the GitHub Browser Build
  • The instructions walk you through creating and naming your app: Create Trio App in App Store Connect

Next Step¶

Ready to begin? Proceed to:

→ Create GitHub Account

Navigation: ← Back to Overview | Next: Create GitHub Account →