Skip to content

Commit a2bde4c

Browse files
authored
Merge pull request #899 from marionbarker/working-docs
Recommend GitHub Org method, add certificate Variable, update APNS, update dev status
2 parents 641db72 + e3a32ac commit a2bde4c

26 files changed

+5149
-196
lines changed

docs/browser/automatic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ This is an optional step. If you are happy with the automatic sync and update, y
8181
??? tip "Instructions to Modify the Automatic Actions (Click to Open/Close)"
8282
You can modify the automation by creating and using some variables.
8383

84-
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).
84+
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).
8585

8686
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**.
8787

docs/browser/bb-errors.md

Lines changed: 37 additions & 88 deletions
Large diffs are not rendered by default.

docs/browser/bb-overview.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ The steps on these pages must be completed (in order) for you to build an app us
4444

4545
1. [Introduction and Summary](intro-summary.md){: target="_blank" }
4646
1. [Collect Secrets](secrets.md){: target="_blank" }
47+
* Some from *Apple*
48+
* Some from *GitHub*
4749
1. [Prepare Fork](prepare-fork.md){: target="_blank" }
4850
1. [Identifiers](identifiers.md){: target="_blank" }
4951
1. [Prepare App](prepare-app.md){: target="_blank" }
@@ -95,10 +97,14 @@ Instructions to make updates are found at:
9597

9698
* [Update with Browser](bb-update.md){: target="_blank" }
9799

98-
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:
100+
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:
99101

100102
* [How to Update and Rebuild DIY Loop with a Web Browser](https://www.youtube.com/watch?v=0ipTsiqbbrQ){: target="_blank" }
101103

104+
After 3.6.0 is released, certificates will be automatically renewed. In the meantime, they must be renewed manually using these instructions:
105+
106+
* [Renew Certificates](bb-update.md#renew-certificate){: target="_blank" }
107+
102108
## Other Topics
103109

104110
### Building the Development Version of the App
@@ -117,13 +123,13 @@ These considerations were prepared when most people were using a Mac computer to
117123
* Compatible version of *Xcode* is provided by *GitHub*
118124
* 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)
119125
* Automatic Updates are loaded into *TestFlight*
120-
* With version 3.4, builds are automatically prepared at least once a month
126+
* With version 3.4 and newer, builds are automatically prepared at least once a month
121127
* You choose when to install the new app from TestFlight onto your phone
122128
* Manual Updates are easy
123129
* 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
124130
* After the *GitHub* Build starts, your app is ready to install on your *iPhone* in about an hour
125131
* The app is delivered to your phone via *TestFlight*
126132
* The app is considered "Beta" by *Apple* and expires after 90 days
127-
* <span translate="no">Loop 3.4</span>&nbsp; and later versions provide automatic build as the default
133+
* <span translate="no">Loop 3.4</span>&nbsp; and newer versions provide automatic build as the default
128134
* Customization methods are documented at [Customize with Browser](custom-browser.md){: target="_blank" }
129135

docs/browser/build-dev-browser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ If you have one branch as default, for example `main`, and choose to build a dif
9393

9494
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.
9595

96-
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" }.
96+
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" }.
9797

9898
## Change Default `Branch`
9999

docs/browser/edit-browser.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
!!! warning "Modules vs Submodule"
1111
This page has instructions to set up your own <code>fork</code> for the Modules, otherwise known as submodules, associated with&nbsp;<span translate="no">LoopWorkspace</span>&nbsp;that are needed for a selected customization.
1212

13-
Each Module has its own *GitHub* <code>repository</code>;and you will be working with your <code>fork</code> of that Module at https://github.com/username/Module, where username is your username.
13+
Each Module has its own *GitHub* <code>repository</code>; and you will be working with your <code>fork</code> of that Module at https://github.com/my-name-org/Module, where you use your own organization (recommended) or personal account.
14+
15+
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.
1416

1517
!!! question "What is a SHA-1?"
1618
SHA-1 means Secure Hash Algorithm 1; which is used to generate an alphanumeric code.
@@ -185,7 +187,7 @@ When you&nbsp;"<span translate="no">fork a repository"</span>, the default&nbsp;
185187
* 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.
186188

187189
??? abstract "Use only if directed (Click to Open/Close)"
188-
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.
190+
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.
189191

190192
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.
191193

@@ -367,7 +369,7 @@ Save the customization lines in your text file for later use in the build_loop.y
367369

368370
``` { .sh .copy title="Customization Template:" }
369371
# Module: File: code customization description
370-
curl https://github.com/username/Module/commit/SHA-1.patch | git apply -v --directory=Module
372+
curl https://github.com/my-name-org/Module/commit/SHA-1.patch | git apply -v --directory=Module
371373
```
372374

373375
where:
@@ -379,7 +381,7 @@ where:
379381
* adding&nbsp;`.patch`&nbsp;after the SHA-1 informs *GitHub* to format that code change so it can be applied to your <code>fork</code>
380382
* the final&nbsp;<code> --directory=Module</code>&nbsp;is critical to apply the customization to the correct Module
381383

382-
To view the exact code change associated with that patch, open a browser at the URL of&nbsp;`https://github.com/username/Module/commit/SHA-1`.
384+
To view the exact code change associated with that patch, open a browser at the URL of&nbsp;`https://github.com/my-name-org/Module/commit/SHA-1`.
383385

384386
## Update&nbsp;<span translate="no">LoopWorkspace</span>
385387

@@ -412,11 +414,11 @@ Return to your&nbsp;<span translate="no">GitHub fork for LoopWorkspace</span>&nb
412414

413415
# Submodule Loop patches:
414416
# Loop: Filename: customization details
415-
#curl https://github.com/username/Loop/commit/SHA-1.patch | git apply -v --directory=Loop
417+
#curl https://github.com/my-name-org/Loop/commit/SHA-1.patch | git apply -v --directory=Loop
416418
417419
# Submodule LoopKit patches:
418420
# LoopKit: Filename: customization details
419-
#curl https://github.com/username/LoopKit/commit/SHA-1.patch | git apply -v --directory=LoopKit
421+
#curl https://github.com/my-name-org/LoopKit/commit/SHA-1.patch | git apply -v --directory=LoopKit
420422
421423
# Submodule xxxxx patches: Follow prototype above
422424

docs/browser/img/fork-org.gif

77.8 KB
Loading

docs/browser/img/gh-fork-loopworkspace.svg renamed to docs/browser/img/gh-fork-loopworkspace-top.svg

Lines changed: 17 additions & 37 deletions
Loading

docs/browser/img/gh-nuke-certs.png

120 KB
Loading
133 KB
Loading
58.6 KB
Loading

0 commit comments

Comments
 (0)