Skip to content

Commit 4352f1e

Browse files
committed
Deploying to gh-pages from @ a2bde4c 🚀
1 parent 6aebf13 commit 4352f1e

File tree

29 files changed

+5482
-339
lines changed

29 files changed

+5482
-339
lines changed

browser/automatic/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3713,7 +3713,7 @@ <h3 id="modify-automatic-schedule">Modify Automatic Schedule<a class="headerlink
37133713
<details class="tip">
37143714
<summary>Instructions to Modify the Automatic <abbr title="a custom application for the GitHub Actions platform that performs a complex but frequently repeated task; specifically used to build Loop from a browser">Actions</abbr> (Click to Open/Close)</summary>
37153715
<p>You can modify the automation by creating and using some variables.</p>
3716-
<p>To configure the automated build more granularly involves creating up to two environment variables: <code>SCHEDULED_BUILD</code> and/or <code>SCHEDULED_SYNC</code>. See <a href="#how-to-configure-a-variable">How to configure a variable</a>.</p>
3716+
<p>To configure the automated build more granularly involves creating up to two variables: <code>SCHEDULED_BUILD</code> and/or <code>SCHEDULED_SYNC</code>. See <a href="#how-to-configure-a-variable">How to configure a variable</a>.</p>
37173717
<p>Note that the weekly and monthly <code>Build Loop</code> actions will continue, but the actions are modified if one or more of these variables is set to false. <strong>A successful Action Log will still appear, even if no automatic activity happens</strong>.</p>
37183718
<ul>
37193719
<li>If you want to manually decide when to update your <abbr title="contains project files and each file's revision history">repository</abbr> to the latest <abbr title="a formal change to files in a repository; each commit has an alphanumeric identifier (SHA-1)">commit</abbr>, but you want the monthly builds and keep-alive to continue:<ul>

browser/bb-errors/index.html

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

browser/bb-overview/index.html

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3810,7 +3810,11 @@ <h3 id="configure-to-use-browser">Configure to use Browser<a class="headerlink"
38103810
<p>The steps on these pages must be completed (in order) for you to build an app using a browser:</p>
38113811
<ol>
38123812
<li><a href="../intro-summary/" target="_blank">Introduction and Summary</a></li>
3813-
<li><a href="../secrets/" target="_blank">Collect <abbr title="a method to securely embed personal information into your fork of LoopWorkspace to enable GitHub to have access required to build Loop">Secrets</abbr></a></li>
3813+
<li><a href="../secrets/" target="_blank">Collect <abbr title="a method to securely embed personal information into your fork of LoopWorkspace to enable GitHub to have access required to build Loop">Secrets</abbr></a><ul>
3814+
<li>Some from <em>Apple</em></li>
3815+
<li>Some from <em><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></em></li>
3816+
</ul>
3817+
</li>
38143818
<li><a href="../prepare-fork/" target="_blank">Prepare Fork</a></li>
38153819
<li><a href="../identifiers/" target="_blank"><abbr title="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr></a></li>
38163820
<li><a href="../prepare-app/" target="_blank">Prepare App</a></li>
@@ -3869,10 +3873,14 @@ <h2 id="update-the-app">Update the App<a class="headerlink" href="#update-the-ap
38693873
<ul>
38703874
<li><a href="../bb-update/" target="_blank">Update with Browser</a></li>
38713875
</ul>
3872-
<p>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:</p>
3876+
<p>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 <em>Apple</em> Developer account is active, agreements are signed and certificates are valid:</p>
38733877
<ul>
38743878
<li><a href="https://www.youtube.com/watch?v=0ipTsiqbbrQ" target="_blank">How to Update and Rebuild <abbr title="Do it yourself, a common acronym for the open-source software community (and the maker community)">DIY</abbr> <abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> with a Web Browser</a></li>
38753879
</ul>
3880+
<p>After 3.6.0 is released, certificates will be automatically renewed. In the meantime, they must be renewed manually using these instructions:</p>
3881+
<ul>
3882+
<li><a href="../bb-update/#renew-certificate" target="_blank">Renew Certificates</a></li>
3883+
</ul>
38763884
<h2 id="other-topics">Other Topics<a class="headerlink" href="#other-topics" title="Anchor link to this Header on this Page">&para;</a></h2>
38773885
<h3 id="building-the-development-version-of-the-app">Building the Development Version of the App<a class="headerlink" href="#building-the-development-version-of-the-app" title="Anchor link to this Header on this Page">&para;</a></h3>
38783886
<p>For experienced and/or advanced users who want to build the development version of the app, there is additional information at the link below. If you have not built using the browser build method before, it is suggested you first build the released version. Once you have a successful build, then follow the steps for the development version. Building the app is independent of installing the app on your phone from <em><abbr title="a method to distribute apps without direct connection">TestFlight</abbr></em>.</p>
@@ -3892,7 +3900,7 @@ <h3 id="mac-vs-browser">Mac vs Browser<a class="headerlink" href="#mac-vs-browse
38923900
</ul>
38933901
</li>
38943902
<li>Automatic Updates are loaded into <em><abbr title="a method to distribute apps without direct connection">TestFlight</abbr></em><ul>
3895-
<li>With version 3.4, builds are automatically prepared at least once a month</li>
3903+
<li>With version 3.4 and newer, builds are automatically prepared at least once a month</li>
38963904
<li>You choose when to install the new app from <abbr title="a method to distribute apps without direct connection">TestFlight</abbr> onto your phone</li>
38973905
</ul>
38983906
</li>
@@ -3903,7 +3911,7 @@ <h3 id="mac-vs-browser">Mac vs Browser<a class="headerlink" href="#mac-vs-browse
39033911
<li>After the <em><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> Build starts, your app is ready to install on your <em>iPhone</em> in about an hour</li>
39043912
<li>The app is delivered to your phone via <em><abbr title="a method to distribute apps without direct connection">TestFlight</abbr></em><ul>
39053913
<li>The app is considered "Beta" by <em>Apple</em> and expires after 90 days</li>
3906-
<li><span translate="no"><abbr title="Latest release with major updates">Loop 3</abbr>.4</span>&nbsp; and later versions provide automatic build as the default</li>
3914+
<li><span translate="no"><abbr title="Latest release with major updates">Loop 3</abbr>.4</span>&nbsp; and newer versions provide automatic build as the default</li>
39073915
</ul>
39083916
</li>
39093917
<li>Customization methods are documented at <a href="../custom-browser/" target="_blank">Customize with Browser</a></li>

browser/build-dev-browser/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3755,7 +3755,7 @@ <h4 id="refresh-do-not-repeat">Refresh, Do Not Repeat<a class="headerlink" href=
37553755
</div>
37563756
<h2 id="automatic-update-build">Automatic Update &amp; Build<a class="headerlink" href="#automatic-update-build" title="Anchor link to this Header on this Page">&para;</a></h2>
37573757
<p>The <a href="../automatic/" target="_blank">Automatic Update &amp; Build</a> features are applied to the default <abbr title="version of code within a single repository or workspace repository">branch</abbr> of your <abbr title="contains project files and each file's revision history">repository</abbr>. Normally this is the <code>main</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr>. If you are a developer or tester who wants the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> to be built automatically, you must configure it as your default <abbr title="version of code within a single repository or workspace repository">branch</abbr>. Be aware that for this situation, you will not get automatic updates of released code.</p>
3758-
<p>Most people should keep <code>main</code> as default and make a considered decision when to launch a manual build of the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr>. At that time, it will automatically update to the latest <code>dev</code> <abbr title="a formal change to files in a repository; each commit has an alphanumeric identifier (SHA-1)">commit</abbr> unless you have modified your environment settings: <a href="../automatic/#modify-automatic-building" target="_blank">Modify Automatic Building</a>.</p>
3758+
<p>Most people should keep <code>main</code> as default and make a considered decision when to launch a manual build of the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr>. At that time, it will automatically update to the latest <code>dev</code> <abbr title="a formal change to files in a repository; each commit has an alphanumeric identifier (SHA-1)">commit</abbr> unless you have modified your settings with special <code>Variables</code>: <a href="../automatic/#modify-automatic-building" target="_blank">Modify Automatic Building</a>.</p>
37593759
<h2 id="change-default-branch">Change Default <code>Branch</code><a class="headerlink" href="#change-default-branch" title="Anchor link to this Header on this Page">&para;</a></h2>
37603760
<blockquote>
37613761
<p><strong>We recommend most users leave their default <abbr title="version of code within a single repository or workspace repository">branch</abbr> as <code>main</code>.</strong></p>

browser/edit-browser/index.html

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4117,7 +4117,8 @@ <h2 id="hot-topics">Hot Topics<a class="headerlink" href="#hot-topics" title="An
41174117
<div class="admonition warning">
41184118
<p class="admonition-title"><abbr title="the Loop code uses a number of modules to handle different components of the entire app">Modules</abbr> vs Submodule</p>
41194119
<p>This page has instructions to set up your own <code><abbr title="a copy of code in a github repository other than the original">fork</abbr></code> for the <abbr title="the Loop code uses a number of modules to handle different components of the entire app">Modules</abbr>, otherwise known as <abbr title="for Loop, submodules are repositories defined in the Workspace repository that are required to build the app">submodules</abbr>, associated with&nbsp;<span translate="no">LoopWorkspace</span>&nbsp;that are needed for a selected customization.</p>
4120-
<p>Each Module has its own <em><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> <code><abbr title="contains project files and each file's revision history">repository</abbr></code>;and you will be working with your <code><abbr title="a copy of code in a github repository other than the original">fork</abbr></code> of that Module at https://<abbr title="an online service for storing repositories, accessible from a browser">github.com</abbr>/username/Module, where username is your username.</p>
4120+
<p>Each Module has its own <em><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> <code><abbr title="contains project files and each file's revision history">repository</abbr></code>; and you will be working with your <code><abbr title="a copy of code in a github repository other than the original">fork</abbr></code> of that Module at https://<abbr title="an online service for storing repositories, accessible from a browser">github.com</abbr>/my-name-org/Module, where you use your own organization (recommended) or personal account.</p>
4121+
<p>If you are an experienced builder who set the Submodule changes up in your personal <em><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> account, you can leave those forks where they are, i.e., https://<abbr title="an online service for storing repositories, accessible from a browser">github.com</abbr>/my-name/Module. You do not build from Submodules, so no <code>Secrets</code> are required.</p>
41214122
</div>
41224123
<div class="admonition question">
41234124
<p class="admonition-title">What is a <abbr title="Secure Hash Algorithm 1; used to generate an alphanumeric code for commits in git (github)">SHA-1</abbr>?</p>
@@ -4337,7 +4338,7 @@ <h2 id="create-branch-if-needed">Create <code>branch</code> if needed<a class="h
43374338
</ul>
43384339
<details class="abstract">
43394340
<summary>Use only if directed (Click to Open/Close)</summary>
4340-
<p>Open your browser to your https://<abbr title="an online service for storing repositories, accessible from a browser">github.com</abbr>/username/Module <abbr title="website address (Uniform Resource Locator)">URL</abbr>. If you already created the <code>branch</code> you need, you do not need to create a new one.</p>
4341+
<p>Open your browser to your https://<abbr title="an online service for storing repositories, accessible from a browser">github.com</abbr>/my-name-org/Module <abbr title="website address (Uniform Resource Locator)">URL</abbr>. If you already created the <code>branch</code> you need, you do not need to create a new one.</p>
43414342
<p>If you are customizing a released version, use the <a href="#table-of-sha-1">Table of <abbr title="Secure Hash Algorithm 1; used to generate an alphanumeric code for commits in git (github)">SHA-1</abbr></a> under your version number below. Copy the <abbr title="Secure Hash Algorithm 1; used to generate an alphanumeric code for commits in git (github)">SHA-1</abbr> for your Module so you can paste it into the <abbr title="website address (Uniform Resource Locator)">URL</abbr> in Step 2 below. The suggested <abbr title="version of code within a single repository or workspace repository">branch</abbr> name is <code>v-#.#.#</code> where #.#.# corresponds to the version number for <code>main</code>. You will use this in Step 3.3 below.</p>
43424343
<p>You should create a <code>branch</code> following the numbered steps and watching the <abbr title="Graphics Interchange Format (GIF) can be used for small animations and low-resolution video clips">GIF</abbr>. Each Frame in the <abbr title="Graphics Interchange Format (GIF) can be used for small animations and low-resolution video clips">GIF</abbr> corresponds to a numbered step below.</p>
43434344
<ol>
@@ -4532,7 +4533,7 @@ <h2 id="prepare-the-customizations">Prepare the Customizations<a class="headerli
45324533
<h3 id="prepare-customization-lines">Prepare customization lines<a class="headerlink" href="#prepare-customization-lines" title="Anchor link to this Header on this Page">&para;</a></h3>
45334534
<p>Save the customization lines in your text file for later use in the build_loop.yml file.</p>
45344535
<div class="copy highlight"><span class="filename">Customization Template:</span><pre><span></span><code><span class="c1"># Module: File: code customization description</span>
4535-
curl<span class="w"> </span>https://github.com/username/Module/commit/SHA-1.patch<span class="w"> </span><span class="p">|</span><span class="w"> </span>git<span class="w"> </span>apply<span class="w"> </span>-v<span class="w"> </span>--directory<span class="o">=</span>Module
4536+
curl<span class="w"> </span>https://github.com/my-name-org/Module/commit/SHA-1.patch<span class="w"> </span><span class="p">|</span><span class="w"> </span>git<span class="w"> </span>apply<span class="w"> </span>-v<span class="w"> </span>--directory<span class="o">=</span>Module
45364537
</code></pre></div>
45374538
<p>where:</p>
45384539
<ul>
@@ -4543,7 +4544,7 @@ <h3 id="prepare-customization-lines">Prepare customization lines<a class="header
45434544
<li>adding&nbsp;<code>.patch</code>&nbsp;after the <abbr title="Secure Hash Algorithm 1; used to generate an alphanumeric code for commits in git (github)">SHA-1</abbr> informs <em><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> to format that code change so it can be applied to your <code><abbr title="a copy of code in a github repository other than the original">fork</abbr></code></li>
45444545
<li>the final&nbsp;<code> --directory=Module</code>&nbsp;is critical to apply the customization to the correct Module</li>
45454546
</ul>
4546-
<p>To view the exact code change associated with that patch, open a browser at the <abbr title="website address (Uniform Resource Locator)">URL</abbr> of&nbsp;<code>https://github.com/username/Module/commit/SHA-1</code>.</p>
4547+
<p>To view the exact code change associated with that patch, open a browser at the <abbr title="website address (Uniform Resource Locator)">URL</abbr> of&nbsp;<code>https://github.com/my-name-org/Module/commit/SHA-1</code>.</p>
45474548
<h2 id="update-loopworkspace">Update&nbsp;<span translate="no">LoopWorkspace</span><a class="headerlink" href="#update-loopworkspace" title="Anchor link to this Header on this Page">&para;</a></h2>
45484549
<p>With the release of 3.4.x, there are two ways to use this customization. Keep reading for the method in which you edit the build_loop.yml file. If you are feeling adventurous, check out <a href="#how-to-use-the-patches-folder" target="_blank">How to use the <code>patches</code> Folder</a>.</p>
45494550
<p>The final step is to update your&nbsp;<span translate="no">LoopWorkspace <abbr title="a copy of code in a github repository other than the original">fork</abbr></span>&nbsp;to apply these customizations by adding those customization lines into the build_loop.yml file.</p>
@@ -4578,11 +4579,11 @@ <h2 id="update-loopworkspace">Update&nbsp;<span translate="no">LoopWorkspace</sp
45784579

45794580
# Submodule Loop patches:
45804581
# Loop: Filename: customization details
4581-
#curl https://github.com/username/Loop/commit/SHA-1.patch | git apply -v --directory=Loop
4582+
#curl https://github.com/my-name-org/Loop/commit/SHA-1.patch | git apply -v --directory=Loop
45824583

45834584
# Submodule LoopKit patches:
45844585
# LoopKit: Filename: customization details
4585-
#curl https://github.com/username/LoopKit/commit/SHA-1.patch | git apply -v --directory=LoopKit
4586+
#curl https://github.com/my-name-org/LoopKit/commit/SHA-1.patch | git apply -v --directory=LoopKit
45864587

45874588
# Submodule xxxxx patches: Follow prototype above
45884589
</code></pre></div>

browser/img/fork-org.gif

77.8 KB
Loading
Lines changed: 17 additions & 37 deletions
Loading

browser/img/gh-nuke-certs.png

120 KB
Loading

browser/img/gh-org-add-secret.png

133 KB
Loading

browser/img/gh-org-settings-01.png

58.6 KB
Loading

0 commit comments

Comments
 (0)