diff --git a/docs/browser/automatic.md b/docs/browser/automatic.md index 0a0b097adfe..d4368957434 100644 --- a/docs/browser/automatic.md +++ b/docs/browser/automatic.md @@ -81,7 +81,7 @@ This is an optional step. If you are happy with the automatic sync and update, y ??? tip "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](#how-to-configure-a-variable). + To configure the automated build more granularly involves creating up to two variables: `SCHEDULED_BUILD` and/or `SCHEDULED_SYNC`. See [How to configure a variable](#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**. diff --git a/docs/browser/bb-errors.md b/docs/browser/bb-errors.md index 6ea63c7096a..3331ef2d1fb 100644 --- a/docs/browser/bb-errors.md +++ b/docs/browser/bb-errors.md @@ -23,13 +23,17 @@ These are two places to ask for help, but please choose only one. You may get a ### What Information is Needed for Help -1. Your GitHub username (required): +1. Your GitHub name used for building (required): - * You can also provide a link to your repository like the example, but substitute your username for `USERNAME` + * Best to provide a link to your repository, like the example, but substitute your information * If you are building an app other than Loop, replace LoopWorkspace with the app repository name + ``` {.text .copy title="If you use an organization" } + https://github.com/my-name-org/LoopWorkspace ``` - https://github.com/USERNAME/LoopWorkspace + + ``` { .text .copy title="If you do not use an organization" } + https://github.com/my-name/LoopWorkspace ``` 1. A brief summary of the step you are on and what isn't working. @@ -41,20 +45,15 @@ Mentors can go to your public _GitHub repositoryApple Developer @@ -92,7 +91,7 @@ First consider the following results from the *GitHub* ### Annotation with Clear Message -Your screen may look similar to the graphic below. The name in parentheses refers to the branch used to develop these wonderful messages. Yours may be (dev) or (main), once 3.4 is released. +Your screen may look similar to the graphic below. The name in parentheses refers to the branch used to develop these wonderful messages. Yours will almost always be the `main` branch. ![graphic showing failure to validate secrets](img/error-validate-secrets.png){width="500"} {align="center"} @@ -117,15 +116,17 @@ This is an example of a message that is not terribly descriptive - which is why ### Missing Certificates +> Coming soon: when Loop 3.6.0 (or newer) is available, certificates will be automatically renewed if your developer account is up to date, all agreements are signed and you completed the new [Add Variable](prepare-fork.md#add-variable){: target="_blank" } step. + +> After Loop 3.6.0 is released, the first attempt to build will update the files required for automatic certificate creation. The second attempt to build will use the new files. So if the first attempt with Loop 3.6.0 fails, try again. + If your certificates have expired, you will see this error when you try to build. It does not have a clear annotation. The error string starts with: `No code signing identity found and can not create a new one because you enabled`. * See [Renew Certificates](bb-update.md#renew-certificate){: target="_blank" } - ![graphic showing missing distribution certificate](img/missing-distribution-certificate.png){width="800"} {align="center"} - ### Annotation without Clear Message (*Build*) The GIF below shows a failure of _*GitHub* Action: 4. Build Loop_ . The nice messages have not been added to this yet - you will have to follow the [Find the Error](#find-the-error) instructions, but now, you are automatically taken to the correct section so there is less of the log to deal with. @@ -146,25 +147,23 @@ The GIF below shows a failure of _*GitHub* Action: 4. ## Find the Error This section is required when you need to search for a string to diagnose and error that does not have a clear annotation. + ## Misleading Error Message If there are *Apple* Developer agreements you have not accepted, you may get errors when you try to Build that indicate your *Apple* Secrets are incorrect even if they are not. * The misleading message tells you that one or more of these: FASTLANE_ISSUER_ID, FASTLANE_KEY_ID or FASTLANE_KEY is not correct -* Check your *Apple* Developer account for agreements first, before trying to fix those + * Once `Loop 3.6.0` or newer is available, this should no longer appear unless you have a mistake in one of those +* Check your *Apple* Developer account for agreements first, before trying to fix those `Secrets` * If you previously built successfully - it is almost certainly the agreement * It can take 15 minutes to an hour after the agreement is signed before it can be used If you need detailed instructions, click on this [Apple Program License Agreement Help Page](https://support.pushpay.com/s/article/Accepting-the-Apple-Program-License-Agreement){: target="_blank" }. -You can also get this message if the credit card used to purchase the Developer account is not current, e.g., no longer valid or expiration date has passed. - -> One user reported: The expiration date on the credit card used for auto-renew of my developer account was updated and the value in the Apple account did not match the new one. After updating my account with the new expiration date - Browser Build succeeded again. +You can also get this message if the credit card used to purchase the Developer account is not current, e.g., no longer valid or credit card expiration date, as entered at *Apple*, has passed. ## Find Your Error -> For Version 3.2.3 and earlier - later versions have an improved method for display errors. - There is a separate section for each step in the process. First, you must follow the [Examine Annotation](#examine-annotation) instructions to view the record of the failed action. Then go to the section for the Action you were trying to complete to look for possible error strings to copy into the search box. For each section there are possible strings to paste to search the log. * Paste in a possible error string (copy it exactly); repeat until you find a match @@ -198,24 +197,13 @@ Click on the top link to view the record of the failed action as shown in the gr {align="center"} * Still stuck? - * Post for help including your ==*GitHub* **username**== + * Post for help including your ==*GitHub* **URL**== (the link to your repository) * With that, mentors can diagnose your problem - or at least make a good guess at what you need to try * Please **do NOT post a screenshot** -!!! tip "Where to find my *GitHub* username?" - You can find it: - - - either in the URL of your fork of `Loopworkspace`, after `github.com` in between the forward slashes (`/`). - https://github.com/==username==/Loopworkspace - - or on the [*GitHub* website](https://github.com){: target="_blank" } - - ![Find your GitHub username step 1](img/github-username-1.svg) - ![Find your GitHub username step 2](img/github-username-2.svg){width="200"} - {align="right"} - - ![Find your GitHub username step 3](img/github-username-3.svg){width="400"} - - As your *GitHub* `username` is case-sensitive, use copy and paste. +!!! tip "Where to find my *GitHub* URL?" + - Go to your fork of `LoopWorkspace` and highlight the address shown in your browser, for example: + https://github.com/==my-name-org==/Loopworkspace ## Do Not Remove an App @@ -252,7 +240,7 @@ For Version 3.4 and later - use [Examine Annotation](#examine-annotation) and re ## Action: `Create Certificates` Errors -Review [Examine Annotatios](#examine-annotation) for instructions on how to use the error strings. +Review [Examine Annotation](#examine-annotation) for instructions on how to use the error strings. ### Error: Wrong TEAMID in `Secrets` @@ -352,8 +340,6 @@ To fix this error: After you have clicked `Update token` you should see the token overview again with the message `Some of the scopes you’ve selected are included in other scopes. Only the minimum set of necessary scopes has been saved. ` (You can dismiss the message using the `X` near the upper right side if it appears). -NOTE: for next release or if using the dev branch - you want GH_PAT to have `repo, workflow` scope. So click on the workflow scope now and save yourself a step later. - #### Create Certificates You should be able to continue with the [Configure to Use Browser Steps to `Create Certificates`](certs.md#create-certificates) and then proceed from there with `Build Loop` and keep going. @@ -370,7 +356,11 @@ The full error message is: > `Could not create another Distribution certificate, reached the maximum number of available Distribution certificates` -These steps are needed to make room for a `Certificate`: +#### New with `Loop 3.6.0` + +> If you just updated to 3.6.0 (once it is released), you might not have added the new variable, `ENABLE_NUKE_CERTS`. Go do that now and then try again. It will take care of renewing your certificates automatically. See [Add Variable](prepare-fork.md#add-variable){: target="_blank" }. + +These steps are needed to make room for a `Certificate` when running versions earlier than 3.6.0: 1. Delete an old `Distribution Certificate` * *Apple* limits you to two `Distribution Certificates` @@ -406,7 +396,7 @@ Otherwise, you need to follow the steps to [Reset Match-Secrets](#reset-match-se ## Action: `Build Loop` Errors !!! warning "Run `Create Certificates` First" - You must run Action: `Create Certificates` before attempting to run Action: `Build Loop` + When running a version earlier than `Loop 3.6.0`, you must run Action: `Create Certificates` before attempting to run Action: `Build Loop` If you had to step backward and fix an `Identifier`, you must run `Create Certificates` again. @@ -661,58 +651,17 @@ These steps are needed to reset your `Match-Secrets`: If you already have the other apps configured and then you delete `Match-Secrets` and add a new one, you will need to run `Create Certificates` for each app before the next time you build each app - go ahead and do that now so you don't forget. -## Misleading Error Message - -If there are *Apple Developer* agreements you have not accepted, you will get errors when you try to build the app that indicate your *Apple* Secrets are incorrect. - -You can also get this message if the credit card used to purchase the Developer account is not current, e.g., no longer valid or expiration date has passed. - -* The misleading message tells you that one or more of these: FASTLANE_ISSUER_ID, FASTLANE_KEY_ID or FASTLANE_KEY is not correct -* Check your *Apple* Developer account for agreements first, before trying to fix those -* If you previously built successfully - it is almost certainly the agreement -* It can take 15 minutes to an hour after the agreement is signed before it can be used - -If you need detailed instructions, click on this [Apple Program License Agreement Help Page](https://support.pushpay.com/s/article/Accepting-the-Apple-Program-License-Agreement). ## Extra Sections -It is unlikely you will need these sections. They are being saved for the transition to version 3.4.x. The Match-Secrets repository is automatically created for you if you don't have one. The instructions below were used when you had to create yours manually. - -### Create Match-Secrets - -Open your github.com URL (this is `https://github.com/username`), (`username` is your GitHub account name). - -Create a new private repository - you can either click on the link below or follow the instructions with the first graphic: +It is unlikely you will need these sections. -* Click on this link: [https://github.com/new](https://github.com/new){: target="_blank" } - -or - -* At the top right of the screen, click on the + sign and select `New Repository` - - ![plus sign to add repository](img/create-match-secrets.svg){width="200"} - {align="center"} - -This shows you a screen similar to the following graphic which has 3 regions highlighted: - -* In `Repository name`, type `Match-Secrets` (use a hyphen between `Match` and `Secrets`) -* Be sure to check the box **`Private`** (red circle) to make the repository **private** -* **Please confirm you selected the `Match-Secrets` repository as private.** -* Scroll to the bottom of the page and tap on "`Create repository`" - -![first screen for new repository](img/01-gh-create-match-secrets.png){width="600"} -{align="center"} - -A screen will appear with a lot of options - do **not** do anything on this screen. - -* Click on your username (as indicated by the red rectangle) to return to your main *GitHub* URL. - -![second screen for new repository](img/02-gh-match-secrets-leave-alone.png){width="600"} -{align="center"} +### Delete Identifiers -You will not directly interact with your `Match-Secrets` repository. +These instructions are useful if: -### Delete Identifiers +* You messed up your TEAMID when initially setting up your app and you want to remove identifiers that may be confusing +* You built an app but no longer want it, and want to clean up the list of identifiers so it is shorter The `Identifier` that is associated with the `Loop` identifier cannot be deleted if it is already in the *App Store* but all others can. If you attempt to delete the `XC` *Loop* identifier, you may be told it cannot be deleted because it is in use in the app store. That's OK. If a `Bundle ID` has ever been associated with an app in the *App Store*, you cannot delete the `Identifier`. @@ -731,4 +680,4 @@ The `Identifier` that is associated with the `Loop` identifier cannot be deleted If coming here because you enter the wrong `TEAMID` in `Secrets` - return to [Rerun Steps with Correct TEAMID](#rerun-steps-with-correct-teamid) when you've deleted as many identifiers as you can. -After you delete identifiers, you must add them back, configure them and create certificate before you can build again. \ No newline at end of file +After you delete identifiers, you must add them back before you can build a given app. Configure them and create certificates before you can build again. diff --git a/docs/browser/bb-overview.md b/docs/browser/bb-overview.md index a5f9d0951a2..a83b420470e 100644 --- a/docs/browser/bb-overview.md +++ b/docs/browser/bb-overview.md @@ -44,6 +44,8 @@ The steps on these pages must be completed (in order) for you to build an app us 1. [Introduction and Summary](intro-summary.md){: target="_blank" } 1. [Collect Secrets](secrets.md){: target="_blank" } + * Some from *Apple* + * Some from *GitHub* 1. [Prepare Fork](prepare-fork.md){: target="_blank" } 1. [Identifiers](identifiers.md){: target="_blank" } 1. [Prepare App](prepare-app.md){: target="_blank" } @@ -95,10 +97,14 @@ Instructions to make updates are found at: * [Update with Browser](bb-update.md){: target="_blank" } -There is also a helpful video for this process. Once again, this was prepared for an earlier version 3.2.3 or older. With version 3.4.1 and newer, the update and build is automatic: +There is also a helpful video for this process. Once again, this was prepared for an earlier version 3.2.3 or older. With version 3.4.1 and newer, the update and build is automatic if your *Apple* Developer account is active, agreements are signed and certificates are valid: * [How to Update and Rebuild DIY Loop with a Web Browser](https://www.youtube.com/watch?v=0ipTsiqbbrQ){: target="_blank" } +After 3.6.0 is released, certificates will be automatically renewed. In the meantime, they must be renewed manually using these instructions: + +* [Renew Certificates](bb-update.md#renew-certificate){: target="_blank" } + ## Other Topics ### Building the Development Version of the App @@ -117,13 +123,13 @@ These considerations were prepared when most people were using a Mac computer to * Compatible version of *Xcode* is provided by *GitHub* * The time required for the initial setup to build with a browser may take less time than one *macOS* and *Xcode* version update for those using [Build with *Mac*](../build/overview.md) * Automatic Updates are loaded into *TestFlight* - * With version 3.4, builds are automatically prepared at least once a month + * With version 3.4 and newer, builds are automatically prepared at least once a month * You choose when to install the new app from TestFlight onto your phone * Manual Updates are easy * Starting an update takes a few minutes of your time; it can be done from your phone; the rest is automatic and is done in about an hour * After the *GitHub* Build starts, your app is ready to install on your *iPhone* in about an hour * The app is delivered to your phone via *TestFlight* * The app is considered "Beta" by *Apple* and expires after 90 days - * Loop 3.4  and later versions provide automatic build as the default + * Loop 3.4  and newer versions provide automatic build as the default * Customization methods are documented at [Customize with Browser](custom-browser.md){: target="_blank" } diff --git a/docs/browser/build-dev-browser.md b/docs/browser/build-dev-browser.md index 33af08211b2..18fae16121d 100644 --- a/docs/browser/build-dev-browser.md +++ b/docs/browser/build-dev-browser.md @@ -93,7 +93,7 @@ If you have one branch as default, for example `main`, and choose to build a dif The [Automatic Update & Build](automatic.md){: target="_blank" } features are applied to the default branch of your repository. Normally this is the `main` branch. If you are a developer or tester who wants the `dev` branch to be built automatically, you must configure it as your default branch. Be aware that for this situation, you will not get automatic updates of released code. -Most people should keep `main` as default and make a considered decision when to launch a manual build of the `dev` branch. At that time, it will automatically update to the latest `dev` commit unless you have modified your environment settings: [Modify Automatic Building](automatic.md#modify-automatic-building){: target="_blank" }. +Most people should keep `main` as default and make a considered decision when to launch a manual build of the `dev` branch. At that time, it will automatically update to the latest `dev` commit unless you have modified your settings with special `Variables`: [Modify Automatic Building](automatic.md#modify-automatic-building){: target="_blank" }. ## Change Default `Branch` diff --git a/docs/browser/edit-browser.md b/docs/browser/edit-browser.md index 243f0b19110..dc43dfa9283 100644 --- a/docs/browser/edit-browser.md +++ b/docs/browser/edit-browser.md @@ -10,7 +10,9 @@ !!! warning "Modules vs Submodule" This page has instructions to set up your own fork for the Modules, otherwise known as submodules, associated with LoopWorkspace that are needed for a selected customization. - Each Module has its own *GitHub* repository;and you will be working with your fork of that Module at https://github.com/username/Module, where username is your username. + Each Module has its own *GitHub* repository; and you will be working with your fork of that Module at https://github.com/my-name-org/Module, where you use your own organization (recommended) or personal account. + + If you are an experienced builder who set the Submodule changes up in your personal *GitHub* account, you can leave those forks where they are, i.e., https://github.com/my-name/Module. You do not build from Submodules, so no `Secrets` are required. !!! question "What is a SHA-1?" SHA-1 means Secure Hash Algorithm 1; which is used to generate an alphanumeric code. @@ -185,7 +187,7 @@ When you "fork a repository", the default  * Otherwise, when you a preparing a customization where the file changed sufficiently between `main` and `dev` and you want to build the `main` branch, you need to create a branch for this Module that is consistent with the version you wish to customize. ??? abstract "Use only if directed (Click to Open/Close)" - Open your browser to your https://github.com/username/Module URL. If you already created the `branch` you need, you do not need to create a new one. + Open your browser to your https://github.com/my-name-org/Module URL. If you already created the `branch` you need, you do not need to create a new one. If you are customizing a released version, use the [Table of SHA-1](#table-of-sha-1) under your version number below. Copy the SHA-1 for your Module so you can paste it into the URL in Step 2 below. The suggested branch name is `v-#.#.#` where #.#.# corresponds to the version number for `main`. You will use this in Step 3.3 below. @@ -367,7 +369,7 @@ Save the customization lines in your text file for later use in the build_loop.y ``` { .sh .copy title="Customization Template:" } # Module: File: code customization description -curl https://github.com/username/Module/commit/SHA-1.patch | git apply -v --directory=Module +curl https://github.com/my-name-org/Module/commit/SHA-1.patch | git apply -v --directory=Module ``` where: @@ -379,7 +381,7 @@ where: * adding `.patch` after the SHA-1 informs *GitHub* to format that code change so it can be applied to your fork * the final  --directory=Module is critical to apply the customization to the correct Module -To view the exact code change associated with that patch, open a browser at the URL of `https://github.com/username/Module/commit/SHA-1`. +To view the exact code change associated with that patch, open a browser at the URL of `https://github.com/my-name-org/Module/commit/SHA-1`. ## Update LoopWorkspace @@ -412,11 +414,11 @@ Return to your GitHub fork for LoopWorkspace&nb # Submodule Loop patches: # Loop: Filename: customization details - #curl https://github.com/username/Loop/commit/SHA-1.patch | git apply -v --directory=Loop + #curl https://github.com/my-name-org/Loop/commit/SHA-1.patch | git apply -v --directory=Loop # Submodule LoopKit patches: # LoopKit: Filename: customization details - #curl https://github.com/username/LoopKit/commit/SHA-1.patch | git apply -v --directory=LoopKit + #curl https://github.com/my-name-org/LoopKit/commit/SHA-1.patch | git apply -v --directory=LoopKit # Submodule xxxxx patches: Follow prototype above diff --git a/docs/browser/img/fork-org.gif b/docs/browser/img/fork-org.gif new file mode 100644 index 00000000000..c9041687870 Binary files /dev/null and b/docs/browser/img/fork-org.gif differ diff --git a/docs/browser/img/gh-fork-loopworkspace.svg b/docs/browser/img/gh-fork-loopworkspace-top.svg similarity index 87% rename from docs/browser/img/gh-fork-loopworkspace.svg rename to docs/browser/img/gh-fork-loopworkspace-top.svg index 835466a6900..4b490548505 100644 --- a/docs/browser/img/gh-fork-loopworkspace.svg +++ b/docs/browser/img/gh-fork-loopworkspace-top.svg @@ -1,11 +1,11 @@ + y="652.5" + clip-path="url(#clipPath1371)" /> diff --git a/docs/browser/img/gh-nuke-certs.png b/docs/browser/img/gh-nuke-certs.png new file mode 100644 index 00000000000..2df154e8d02 Binary files /dev/null and b/docs/browser/img/gh-nuke-certs.png differ diff --git a/docs/browser/img/gh-org-add-secret.png b/docs/browser/img/gh-org-add-secret.png new file mode 100644 index 00000000000..56813f81153 Binary files /dev/null and b/docs/browser/img/gh-org-add-secret.png differ diff --git a/docs/browser/img/gh-org-settings-01.png b/docs/browser/img/gh-org-settings-01.png new file mode 100644 index 00000000000..14fbd7ec240 Binary files /dev/null and b/docs/browser/img/gh-org-settings-01.png differ diff --git a/docs/browser/img/gh-org-settings-02.png b/docs/browser/img/gh-org-settings-02.png new file mode 100644 index 00000000000..4f14549c043 Binary files /dev/null and b/docs/browser/img/gh-org-settings-02.png differ diff --git a/docs/browser/img/gh-quick-access-org.png b/docs/browser/img/gh-quick-access-org.png new file mode 100644 index 00000000000..6c3c6ac9e19 Binary files /dev/null and b/docs/browser/img/gh-quick-access-org.png differ diff --git a/docs/browser/img/github-username-1.svg b/docs/browser/img/github-username-1.svg deleted file mode 100644 index 6bf40647a3c..00000000000 --- a/docs/browser/img/github-username-1.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/browser/img/github-username-2.svg b/docs/browser/img/github-username-2.svg deleted file mode 100644 index 79061229f78..00000000000 --- a/docs/browser/img/github-username-2.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/browser/img/github-username-3.svg b/docs/browser/img/github-username-3.svg deleted file mode 100644 index fa5635fe657..00000000000 --- a/docs/browser/img/github-username-3.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/browser/intro-summary.md b/docs/browser/intro-summary.md index af9e6fc7509..c80306e8960 100644 --- a/docs/browser/intro-summary.md +++ b/docs/browser/intro-summary.md @@ -26,13 +26,16 @@ * [Collect the four *Apple* Secrets](secrets.md#collect-the-four-apple-secrets){: target="_blank" } * *GitHub*: * [Collect the GH_PAT Secret](secrets.md#collect-the-gh_pat-secret){: target="_blank" } + * (Optional) [Create a Free *GitHub* Organization](secrets.md#create-a-free-github-organization){: target="_blank" } (strongly recommended) * [Make up a Password](secrets.md#make-up-a-password){: target="_blank" } and save it as your sixth `Secret` Now it's time to use those Secrets to build the Loop app * *GitHub*: * [`Fork` the repository (make your copy of LoopWorkspace)](prepare-fork.md#fork-loopworkspace){: target="_blank" } - * [Add Secrets to your `fork`](prepare-fork.md#configure-secrets){: target="_blank" } + * Using an organization? Add `Secrets` and `Variables` to your Organization and all your apps can use them + * Not using an organization? You have to add `Secrets` and `Variables` to each repository individually + * [Add Secrets to your `organization` or a single `fork`](prepare-fork.md#configure-secrets){: target="_blank" } * [`Action: 1. Validate Secrets`](identifiers.md#validate-secrets){: target="_blank" } * [`Action: 2. Add Identifiers`](identifiers.md#add-identifiers){: target="_blank" } * _Apple_: @@ -61,6 +64,18 @@ The steps to configure for building with a browser require a lot of focused atte * [Click here to find help](bb-errors.md#help-with-errors){: target="_blank" }. +???+ tips "Who should use a free GitHub Organization option (click to close/open)" + There are several places where you see a recommendation to use a free GitHub Organization instead of building directly from your personal free GitHub account. + + When you use an organization, you don't have to add 6 Secrets to each repository for every app you build. It can save a lot of time in the long run. + + * Even if you just build Loop and nothing else, using an organization is pretty easy and your build works just the same as using only a personal account + * Who should definitely build with an organization: + * Anyone who is a caregiver will want LoopCaregiver or LoopFollow or both + * Anyone who wants to use LoopFollow for the amazing alarm capabilties + * Anyone who might want to try a customized version of Loop + * Anyone who might want to try a different app such as xDrip4iOS or Trio + ### The Short Version Complete instructions are found at this link for those comfortable with using *GitHub* and navigating the *Apple Developer* and *Apple App Connect* pages. @@ -103,7 +118,7 @@ You need to keep a digital copy of your 6 Secrets. !!! important "Use a Text-Only Editor" **Be sure to use a Text-Only editor like NotePad (PC) or TextEdit (Mac) to archive your information.** - If you use a "smart" editor, it may change lower-case letters to upper-case letters at the beginning of a line when you paste items into your archive file. + If you use a "smart" editor, it may change small letters to capital letters at the beginning of a line when you paste items into your archive file. If even one character is capitalized when it should not be, you will get errors. @@ -123,6 +138,7 @@ You don't need to know anything about the Secrets to do this. Come * 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 +6. If you use Nightscout, you may also want the [Nightscout template](../nightscout/remote-config.md#save-your-important-nightscout-information){: target="_blank" } ``` { .bash .copy title="Template to use for Secrets" } MySecretsReferenceFile.txt @@ -142,15 +158,17 @@ suggest you use your desired password tool to save the password for this account suggest you use your desired password tool to save the password for this account -These are the Six Secrets in alphabetical order - each one shows the expected format. -Delete each prototype as you gather your own secrets. -The letter A indicates an alphanumeric character. -Some may be lower case, some upper case and some numerals. +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. -For that one copy the entire key -including -----BEGIN PRIVATE KEY----- -through ------END PRIVATE KEY----- + Be sure to copy the entire key including + -----BEGIN PRIVATE KEY----- + through + -----END PRIVATE KEY----- ## SECRETS BELOW: @@ -166,7 +184,6 @@ FASTLANE_KEY_ID AAAAAAAAAA - FASTLANE_KEY -----BEGIN PRIVATE KEY----- @@ -184,9 +201,21 @@ MATCH_PASSWORD AnyThingYouWant-sameForEveryRepository +New addition, this Variable: + +ENABLE_NUKE_CERTS = true + +With release of Loop 3.6.0: + this variable is needed to automatically renew your certificates when they expire. + ## Repository Names for my Fork: -https://github.com/my-github-username/LoopWorkspace +If you use an organization (recommended) +https://github.com/my-name-org/LoopWorkspace + +or (if you don't use an organzation): +https://github.com/my-name/LoopWorkspace + Add additional apps here if you decide to build any ``` diff --git a/docs/browser/other-apps.md b/docs/browser/other-apps.md index 13d02fcd603..667aa44ff3c 100644 --- a/docs/browser/other-apps.md +++ b/docs/browser/other-apps.md @@ -408,12 +408,11 @@ The [Install on Phone](phone-install.md) walks you through the steps to install This section is optional. It is provided to assist: * Users who are using *GitHub* for other reasons and want to segregate their DIY app building from their existing accounts -* Mentors who want to do a lot of testing of many DIY apps to support people and get tired of entering the 6 Secrets repeatedly -* Users who are comfortable with the *GitHub* web interface who want the convenience of entering the 6 Secrets just one time instead of entering them for each repository individually +* Users who want the convenience of entering the 6 Secrets just one time instead of entering them for each repository individually ### Set up a Free *GitHub* Organization -Prerequisite: You need a personal *GitHub* account. +Prerequisite: You need a personal *GitHub* account. If you do not already have a personal *GitHub* account, click on [New *GitHub* Account](secrets.md#new-github-account){: target="_blank" }. In the instructions below, use your *GitHub* username instead of `my-name`. diff --git a/docs/browser/prepare-app.md b/docs/browser/prepare-app.md index 4acc03dc2f0..08626635ae8 100644 --- a/docs/browser/prepare-app.md +++ b/docs/browser/prepare-app.md @@ -270,6 +270,8 @@ If you have previously used some kind of remote build, like `diawi` or `TestFlig ### Remove Apple Vision Pro +> This might not be displayed anymore. Leaving it here in case you see this. + It is now time to edit the availability of your app on Apple Vision Pro. If you skip this step, you will get an annoying email telling you Apple Vision Pro is not supported by your app. * First click to return to the main [App Store Connect](https://appstoreconnect.apple.com/apps){: target="_blank" }. In the message section labeled **iOS Apps on Apple Vision Pro**, click on "Edit Availability", highlighted by the red rectangle in the graphic below. diff --git a/docs/browser/prepare-fork.md b/docs/browser/prepare-fork.md index 97307054fb3..c78e1702a02 100644 --- a/docs/browser/prepare-fork.md +++ b/docs/browser/prepare-fork.md @@ -1,11 +1,11 @@ ## Fork `LoopWorkspace` -??? tip "Feeling confident? Planning to build more than one app? Click to see more." - If you are already feeling overwhelmed - skip this tip. +???+ tip "Are you a Caregiver? Are you planning to build more than one app? (Click to close/open)" + Did you skip the optional section to [Create a Free *GitHub* Organization](secrets.md#create-a-free-github-organization){: target="_blank" }? - If you plan to build more that one app, you will making a fork of each repository associated with each app, and then you must add the 6 Secrets to each repository. It is not hard but it can get tiresome. + If you plan to build more that one app and use your personal account, you must add the 6 Secrets to each repository for each app. It is not hard but it can get tiresome. - There is a way to enter the 6 Secrets only one time for all your repositories, but this requires setting up a free GitHub organization. This is also not hard, but it modifies some of displays you see on GitHub. If you are interested, refer to [Use a GitHub Organization Account](other-apps.md#use-a-github-organization-account){: target="_blank" } + If you make use of the organization option, you only enter the 6 Secrets one time for all your repositories. This is strongly recommended, but not required, for all Browser Builders. ???+ abstract "Section Summary (click to open/close)" Fork [https://github.com/LoopKit/LoopWorkspace](https://github.com/LoopKit/LoopWorkspace){: target="_blank" } into your account. @@ -15,19 +15,25 @@ !!! warning "Existing Fork" If you already have a fork of LoopWorkspace, click on [Already Have LoopWorkspace](#already-have-loopworkspace) to decide what to do. That section provides links to return you to these instructions. +### Create the `Fork` + 1. Click this link [https://github.com/LoopKit/LoopWorkspace](https://github.com/LoopKit/LoopWorkspace){: target="_blank" } to open the LoopWorkspace repository owned by `LoopKit` -1. Review the highlighted locations of the graphic below (yours won't look quite like this yet, but the `Fork` button is in the same place) 1. At the upper right side of the screen, click on the word `Fork` - * If you already have a fork, you cannot proceed, see [Already Have a LoopWorkspace](#already-have-loopworkspace) -1. Now your screen should look like the graphic below - * Your username will be automatically filled in as the owner (`Owner`) - * LoopWorkspace is the repository name (`Repository Name`) highlighted with the blue rectangle + + ![fork information for LoopWorkspace](img/gh-fork-loopworkspace-top.svg){width="700"} + {align="center"} + +1. Refer the the GIF below: + * If you created a free organization (strongly recommended), you will see the display shown in the GIF below where you will choose your organization as the owner + * If you did not set up a free organization, `my-name` will be automatically filled in as the owner (`Owner`) + * If you already have a fork, you should not proceed, see [Already Have a LoopWorkspace](#already-have-loopworkspace) + * The repository name is already filled in * Do not rename the repository to something else * It needs to match the original repository name or automatic building will not work * Leave the selection that says "`Copy the main branch only`" checked * Click on the green `Create fork` button - ![fork information for LoopWorkspace](img/gh-fork-loopworkspace.svg){width="700"} + ![fork information for LoopWorkspace](img/fork-org.gif){width="700"} {align="center"} #### Successful Fork @@ -42,8 +48,9 @@ After creating the  fork, your screen shou Carefully compare your screen to the graphic below paying attention to the highlighted sections. -* Note that your username is now showing -* The comment under your username indicates where the  fork  came from (that is a clickable link) +* Note that your URL is `https://github.com/my-name-org/LoopWorkspace` or `https://github.com/my-name/LoopWorkspace` where `my-name` is the name you chose: + * Many graphics for LoopDocs are created using a free *GitHub* organization called `loopdocs-tester` +* The comment on the second row indicates where the  fork  came from (that is a clickable link) * The branch that is selected :octicons-git-branch-16: is `main` * The message says "`This branch is up to date with LoopKit/LoopWorkspace:main`" @@ -52,24 +59,49 @@ Carefully compare your screen to the graphic below paying attention to the highl ## Configure Secrets -??? abstract "Section Summary (click to open/close)" - These Secrets are the same for any repository for which you use `GitHub Browser Build`. +If you set up a GitHub organization (strongly recommended), follow this [set of instructions](#prepare-to-enter-secrets). - * They are added once for a repository and work for all branches of that repository - * They must be added to any other repository, such as LoopCaregiver, for which you also use `GitHub Browser Build` +If you decided to not to use a GitHub organization, skip ahead to [Personal Account: Prepare to Enter Secrets](#personal-account-prepare-to-enter-secrets). - 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: +!!! tip "What if I already have a bunch of forks in my personal account?" + You do not have to switch to an organization. But if you want to make the move, follow instructions here [Switch to a GitHub Organization](#switch-to-a-github-organization) - * `TEAMID` - * `FASTLANE_ISSUER_ID` - * `FASTLANE_KEY_ID` - * `FASTLANE_KEY` - * `GH_PAT` - * `MATCH_PASSWORD` +### Prepare to Enter Secrets - [:material-skip-forward:](identifiers.md#validate-secrets){: target="_blank" } To skip the detailed instructions, click on [Validate Secrets](identifiers.md#validate-secrets){: target="_blank" }. +You will be adding `Secrets` and `Variables` to your organization. This makes them available to any app you decide to build as long as you set up your free *GitHub* organization as the [owner of the fork](#create-the-fork). -### Prepare to Enter Secrets +1. Tap on this [*GitHub* link](https://github.com/settings/organizations){: target="_blank" } to see your organizations. (If you don't see a screen similar to the graphic below - you are not logged in to *GitHub*). + + ![settings screen](img/gh-quick-access-org.png){width="700"} + {align="center"} + +1. Choose your organization name from the list (most people will only see one organization) + * I chose `loopdocs-tester` as my organization, so you will see that name in the URL for graphics in this section. + + ![settings screen](img/gh-org-settings-01.png){width="700"} + {align="center"} + +1. Click on the Settings Icon near the top right + * If you don't see ⚙️ `Settings`, make your browser wider or scroll to the right + * After you click on ⚙️ `Settings`, your screen will show a lot of menu items on the left side of the screen. + * Scroll down until you can see the `Security` section with `Secrets and variables` drop down. + * Click on the dropdown icon and then selection `Actions` + + ![settings screen](img/gh-org-settings-02.png){width="600"} + {align="center"} + +1. Your screen should now look like the graphic below. Note that the `Secret` tab is automatically selected. + + ![action secrets and variables screen](img/gh-actions-secrets.svg){width="700"} + {align="center"} + +The next steps are identical whether you are configuring your organizations `Secrets` and `Variables` or doing this for every repository in a private account. + +* Skip ahead to [Enter the Secrets](#enter-the-secrets) + +### Personal Account: Prepare to Enter Secrets + +> This section is only if you are using a personal *GitHub* account to build. Using an organization is recommended. Log into *GitHub*. @@ -89,12 +121,17 @@ Log into *GitHub*. {align="center"} 1. On the left side, find the `Secrets and variables` dropdown and choose Actions - * After you select Actions, your screen should look like the graphic below - ![action secrets and variables screen](img/gh-actions-secrets.svg){width="700"} - {align="center"} +At this point the instructions are the same whether you are using an organization or a personal account. + +## Enter the Secrets + +The steps to enter the `Secrets` and `Variables` are identical whether you are configuring these in your [organization account](#prepare-to-enter-secrets) or repeating this for every repository in a [private account](#personal-account-prepare-to-enter-secrets). -### Enter the Secrets +Your screen should look like the graphic below. If not head back to [Configure Secrets](#configure-secrets). Note that the `Secret` tab is automatically selected. + +![action secrets and variables screen](img/gh-actions-secrets.svg){width="700"} +{align="center"} 1. Tap on the green button at the top right of your screen labeled `New repository secret` (highlighted above) * A new screen appears as shown in the first graphic below @@ -110,7 +147,7 @@ Log into *GitHub*. ![teamid secret ready to be saved](img/teamid-secret-ready-to-save.png){width="700"} {align="center"} -#### Enter Each Secret +### Enter Each Secret Enter the name of each Secret found in [Save Your Information](intro-summary.md#save-your-information) and your value for that `Secret`. @@ -151,10 +188,55 @@ Once all six Secrets have been added to your LoopWorkspace Your personal *GitHub* account is still needed. The free organization points to your private account as a member. If you delete your personal *GitHub* account, you lose access to your organization account too. + ## Already Have LoopWorkspace? Some people may already have a copy (`fork`) of LoopWorkspace. @@ -163,7 +245,7 @@ If your copy (`fork`) is **not** from `LoopKit`, follow the [Delete and Start Fr If your copy (`fork`) is from `LoopKit`: -* Open your LoopWorkspace repository (`https://github.com/username/LoopWorkspace`) where you use your *GitHub* `username` in the URL +* Open your LoopWorkspace repository (`https://github.com/my-name-org/LoopWorkspace`) where you use your version of `my-name` in the URL * Review the graphic in the [Configure: Successful Fork](#successful-fork) section * Make sure all the items highlighted by red rectangles are correct with the possible exception of your fork being up to date * If you see a message that your *fork* is not up to date - tap on the `Sync fork` button and follow the instructions @@ -176,4 +258,3 @@ If your fork is not from `LoopKit`: * Delete your LoopWorkspace repository * Instructions to delete a repository are found at [*GitHub* Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/deleting-a-repository){: target="_blank" } * Return to [Fork LoopWorkspace](#fork-loopworkspace) and follow all the instructions - diff --git a/docs/browser/secrets.md b/docs/browser/secrets.md index 91cd1fd0450..b3e44ed2d8a 100644 --- a/docs/browser/secrets.md +++ b/docs/browser/secrets.md @@ -16,7 +16,7 @@ You need to save your information digitally, so you can copy and paste. The information is created in one place and used in another. Refer to [Configure Secrets](prepare-fork.md#configure-secrets){: target="_blank" } for how the Secrets are used. In addition to the 6 Secrets, other important information to keep handy (like usernames and passwords) is listed below. Be sure to keep this file secure. -**Created at developer.apple.com** +**Created / used at developer.apple.com** * Email address (this is your username) * password @@ -26,13 +26,15 @@ You need to save your information digitally, so you can copy and paste. The info * FASTLANE_KEY_ID * FASTLANE_KEY -**Created at github.com** +**Created / used at github.com** * Email address * password * username -* Your *GitHub* repository address will be: `https://github.com/username` -* Your LoopWorkspace repository address will be: `https://github.com/username/LoopWorkspace` +* If your username is `my-name` then: + * Your *GitHub* address (URL) will be: `https://github.com/my-name` + * Your (optional but recommended) *GitHub* organization address will be : `https://github.com/my-name-org` + * Your LoopWorkspace repository address will be: `https://github.com/my-name-org/LoopWorkspace` * One item used as a Secret * *GitHub* Personal Access Token (GH_PAT) @@ -283,6 +285,35 @@ You must be logged into your *GitHub* account before starting this step. If you ![copy fastlane access token on github](img/gh-token-to-copy.png){width="600"} {align="center"} +### Create a Free *GitHub* Organization + +This step is optional but it can save you a lot of time and is strongly recommended. + +Prerequisite: You need a personal *GitHub* account. If you do not already have a personal *GitHub* account, click on [New *GitHub* Account](#new-github-account). + +In the instructions below, use your *GitHub* username instead of `my-name`. + +1. Follow the directions below to create a new *GitHub* organization account with a username of `my-name-org` (of course naming is up to you) + * *GitHub* provides documentation at this link, [New *GitHub* Organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch){: target="_blank" }, or you can follow the bullets below + * Log into `my-name` and click on your icon (at upper right) and choose Settings + * On the left side-bar, click on Organizations + * In the new view, click on New Organization and choose Free for the plan by clicking on `Create a free organization`. + * In the `Set up your organization` screen: + * Enter `my-name-org` into the `Organization name` box + * Enter the same email you use for `my-name` account + * Select this organization belongs to `My personal account` + * Check the box to accept the terms of service + * Tap on the next button +2. You now see a Welcome screen + * Unless you plan to collaborate with others, just tap `Complete setup` + * You can always add others at a later time +3. Confirm access by entering the same password as you use for `my-name` + +???+ tip "GH_PAT comes from personal `my-name` account" + The *GitHub* personal access token used as one of the 6 Secrets is associated with your personal account (`my-name`); so if you already have one, you just keep using it. + +**Your personal *GitHub* account is still needed. The free organization points to your private account as a member. Please do not delete your personal *GitHub* account after creating an organization. If you do that - you will no longer have access to your organization.** + ## Make up a Password If you have not already made up a password, do it now and record it as MATCH_PASSWORD. Note that if you [build more than one app](other-apps.md){: target="_blank" }, you use the same MATCH_PASSWORD for all the apps. Every app needs to have the same 6 Secrets. diff --git a/docs/build/build-errors.md b/docs/build/build-errors.md index 0a6880a8281..d0a643c0624 100644 --- a/docs/build/build-errors.md +++ b/docs/build/build-errors.md @@ -462,7 +462,7 @@ Or you may see `Unable to process request - PLA Update available. You currently ![img/container-1.png](img/container-1.png){width="750"} {align="center"} -**Solution**: To resolve this error, you will need to click on the Loop target's signing area and then the plus-sign in the App Groups area under the signing. Copy and paste the bundle indentifier into the new container that starts with `group.` and then add `Group` to the end of the name. Click OK to save. Note, the line will start with lower case `group.` followed by your bundle identifier and an upper case `Group` added to the end of the bundle identifier. +**Solution**: To resolve this error, you will need to click on the Loop target's signing area and then the plus-sign in the App Groups area under the signing. Copy and paste the bundle indentifier into the new container that starts with `group.` and then add `Group` to the end of the name. Click OK to save. Note, the line will start with small letter `group.` followed by your bundle identifier and a capital letter `Group` added to the end of the bundle identifier. ![img/container-2.png](img/container-2.png){width="750"} {align="center"} diff --git a/docs/nightscout/img/key-apns.png b/docs/nightscout/img/key-apns.png deleted file mode 100644 index 3feb4f73d4a..00000000000 Binary files a/docs/nightscout/img/key-apns.png and /dev/null differ diff --git a/docs/nightscout/img/key-apns.svg b/docs/nightscout/img/key-apns.svg new file mode 100644 index 00000000000..586ef9ed1c2 --- /dev/null +++ b/docs/nightscout/img/key-apns.svg @@ -0,0 +1,4778 @@ + +image/svg+xml diff --git a/docs/nightscout/remote-config.md b/docs/nightscout/remote-config.md index 95275427b32..b0ee9f8139a 100644 --- a/docs/nightscout/remote-config.md +++ b/docs/nightscout/remote-config.md @@ -5,6 +5,75 @@ 3. [Update *Nightscout* site and add some "config vars" lines in *Nightscout* site settings](#step-3-add-apn-to-nightscout) 4. [Test Remote Overrides](#step-4-test-remote-overrides) +## Save Your Important Nightscout Information + +There is some important information you need to save when using Nightscout, especially for Remote Control of a Looper's phone. In addition to the URL and API_SECRET, you need 3 or 4 additional variables (`config-vars`) that you add to your Nightscout configuration. + +1. Decide where you want your Nightscout information saved and create a special folder +2. Open a text-only editor (do not use a Smart Editor, those might change capitalization or formating and ruin some of the `config-vars`) + * Create a blank Nightscout 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 below to configure Nightscout for remote commands, fill in the file + +``` { .bash .copy title="Template to use for Nightscout" } +MyNightscoutReferenceFile.txt + +## This file updated on: DD MMM YYYY + +## Important Information for Remote Commands with Nightscout + +You will want to add information specific to your Nightscout. +This will be different depending on whether you build it yourself or pay a vendor. + +PLACEHOLDER FOR YOUR SPECIFIC INFO, e.g., vendor, username + +The URL will always start with https:// + +https://your-nightscout-site + +API_SECRET + +choose-something-hard-to-guess + +* must contain at least 12 characters and is case-sensitive +* hint: don’t make it too long, best to use letters and numbers, + best to avoid special characters + +If you also use Browser Build method, you need to be careful not to mix +up your keys. +The APNS key for Nightscout is an Apple Push Notification Key. +It may look like the FASTLANE_KEY used for Browser Build, +but it is completely different. +You need both (if using remote features). Do NOT get them mixed up. + +LOOP_APNS_KEY + +-----BEGIN PRIVATE KEY----- +AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +AAAAAAAA +-----END PRIVATE KEY----- + +LOOP_APNS_KEY_ID + +AAAAAAAAAA + +LOOP_DEVELOPER_TEAM_ID +This is the same as the TEAMID used as a browser build Secret. + +AAAAAAAAAA + +LOOP_PUSH_SERVER_ENVIRONMENT is used only if you use TestFlight (Browser Build) +as a build method; or use Xcode but then distribute via TestFlight. + +If you build from Mac-Xcode directly to a phone, do not include this config-var + +LOOP_PUSH_SERVER_ENVIRONMENT = production + +``` + ## Set Up Remote for *Nightscout* You can use the *Nightscout* site to remotely set and cancel override presets remotely in the *Loop* app. @@ -62,6 +131,11 @@ The step is required for the *Loop* app to give permissions to your *Nightscout* !!! info "Reminder" This only works with the **paid** Apple Developer ID. +!!! warning "*Apple* changed the APN system" + *Apple* changed the way APN are created. Your old ones should still work, but it they don't, create new ones and update all the places where they are used. + + When creating new APN keys, you have the option for "Sandbox", "Production" or "Sandbox & Production". Be sure to choose "Sandbox & Production". + 1. To get started, go to the `Keys` section under Apple Developer's [`Certificates, Identifiers & Profiles`](https://developer.apple.com/account/resources/authkeys/list){: target="_blank" } and login with the *Apple ID* associated with your developer team that you used to build the *Loop* app. 2. If not already open in your browser (compare with the below screenshot), - Click on **`Keys`** (located in the left-hand column). @@ -70,8 +144,10 @@ The step is required for the *Loop* app to give permissions to your *Nightscout* 3. In the form that appears, do the following: - Click the checkbox for enabling **`Apple Push Notifications service (APNs)`** - Enter a name for the key such as `Nightscout` (you can name it however you want, just make sure you know what the key is for by the name you choose). - - Then click the **`Continue`** button in the upper right of the screen. - > ![img/key-apns.png](img/key-apns.png) + - Then click the **`Configure`** button to the right of the name + - Choose **`Sandbox & Production`** and then **`Save`** + - Tap on the **`Continue`** button, upper right + > ![updated instructions for creating and configuring an APNS key](img/key-apns.svg) 4. In the screen that follows, click the blue **`Register`** button. > ![img/apns-register.png](img/apns-register.png) 5. In the screen that follows, click the blue **`Download`** button. diff --git a/docs/version/build-time-flag.md b/docs/version/build-time-flag.md index 29542d4a449..f455a9cd81d 100644 --- a/docs/version/build-time-flag.md +++ b/docs/version/build-time-flag.md @@ -15,7 +15,7 @@ The `Build Time Flags` are available for both build methods: * You can edit the version in your LoopWorkspace folder (it shows up as the top item in the Xcode folder view) - or - if you use the build script, you can edit the copy found in ~/Downloads/BuildLoop after the first time you use the script. * If you edit `~/Downloads/BuildLoop/LoopConfigOverride.xcconfig`, the "flags" you add are applied to this download and all subsequent downloads created with the script. -These flags are always upper case with underscore separating words for clarity, for example `MY_EXAMPLE_FLAG`. If you have more than one flag, they are separated by a space. Do not enter a line break between selections; in other words, do not hit return or enter. Xcode will automatically word-wrap the line for clarity. All values need to be on a single line. +These flags are always capital letters with underscore separating words for clarity, for example `MY_EXAMPLE_FLAG`. If you have more than one flag, they are separated by a space. Do not enter a line break between selections; in other words, do not hit return or enter. Xcode will automatically word-wrap the line for clarity. All values need to be on a single line. Copy the text below, add it to the end of your LoopConfigOverride.xcconfig file and then insert the desired flags in place of `MY_EXAMPLE_FLAG`. If you want more than one flag, separate them by a space. diff --git a/docs/version/development.md b/docs/version/development.md index 8de8175f12e..eb11955b5d0 100644 --- a/docs/version/development.md +++ b/docs/version/development.md @@ -12,9 +12,32 @@ Please read this entire page before using any version of *Loop* other than the r ## Updates in `dev` -This section is an early look at major features added to dev since Loop 3.4 was released. +This section is provides an overview of changes to dev compared to `Loop 3.4.4`. -Right now it is empty. +### Add Automatic Certificate Generation and Renewal + +These changes in the build process only work when `dev` is your default branch. Once `Loop 3.6.0` is released, these changes will work with the `main` branch. + +Automatic certificate generation and renewal requires a `Variable` be added to your organization or your repository. Please see these instructions: [Add Variable](prepare-fork.md#add-variable){: target="_blank" } + +### Loop Updates + +Updates made to Loop or LoopKit submodules affect the operation of Loop. + +No functional changes made at the current time. + +### OmniBLE and OmniKit Updates + +Updates were made to the Omnipod pump submodules: OmniBLE and OmniKit. Unless otherwise noted, the following functional updates were made to both submodules with the PR numbers included in parentheses: + +* Miscellaneous Omnipod code improvements & cleanup (PR 135, 44) +* Unacknowledged command handling fixes and PodCommsSession improvements (PR 136, 45) +* DASH (OmniBLE only): Don't fail on ack comms error if validated response has been received (PR 137) +* Eros (OmniKit only): return clock icon when isClockOffset is true (PR 46) +* DASH (OmniBLE only): Use alternate type 7 getStatus call for standalone getStatus sessions (matches the Insulet PDM) (PR 138) +* Improved unacknowledged command recovery (PR 139, 47) +* Logic fix for 049 pod fault with concurrent temp basal commands; fixed Trio Issue (PR 140, 48) +* Logic fix for pump manager returns bogus podSuspended; fixed Trio Issue (PR 141, 49) ## Updates from 3.2 to 3.4