You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<summary>Instructions to Modify the Automatic <abbrtitle="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>
3715
3715
<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 <ahref="#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 <ahref="#how-to-configure-a-variable">How to configure a variable</a>.</p>
3717
3717
<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>
3718
3718
<ul>
3719
3719
<li>If you want to manually decide when to update your <abbrtitle="contains project files and each file's revision history">repository</abbr> to the latest <abbrtitle="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>
Copy file name to clipboardExpand all lines: browser/bb-overview/index.html
+12-4Lines changed: 12 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -3810,7 +3810,11 @@ <h3 id="configure-to-use-browser">Configure to use Browser<a class="headerlink"
3810
3810
<p>The steps on these pages must be completed (in order) for you to build an app using a browser:</p>
3811
3811
<ol>
3812
3812
<li><ahref="../intro-summary/" target="_blank">Introduction and Summary</a></li>
3813
-
<li><ahref="../secrets/" target="_blank">Collect <abbrtitle="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><ahref="../secrets/" target="_blank">Collect <abbrtitle="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><abbrtitle="an online service for storing repositories, accessible from a browser">GitHub</abbr></em></li>
<li><ahref="../identifiers/" target="_blank"><abbrtitle="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr></a></li>
@@ -3869,10 +3873,14 @@ <h2 id="update-the-app">Update the App<a class="headerlink" href="#update-the-ap
3869
3873
<ul>
3870
3874
<li><ahref="../bb-update/" target="_blank">Update with Browser</a></li>
3871
3875
</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>
3873
3877
<ul>
3874
3878
<li><ahref="https://www.youtube.com/watch?v=0ipTsiqbbrQ" target="_blank">How to Update and Rebuild <abbrtitle="Do it yourself, a common acronym for the open-source software community (and the maker community)">DIY</abbr><abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> with a Web Browser</a></li>
3875
3879
</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>
<h2id="other-topics">Other Topics<aclass="headerlink" href="#other-topics" title="Anchor link to this Header on this Page">¶</a></h2>
3877
3885
<h3id="building-the-development-version-of-the-app">Building the Development Version of the App<aclass="headerlink" href="#building-the-development-version-of-the-app" title="Anchor link to this Header on this Page">¶</a></h3>
3878
3886
<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><abbrtitle="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
3892
3900
</ul>
3893
3901
</li>
3894
3902
<li>Automatic Updates are loaded into <em><abbrtitle="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>
3896
3904
<li>You choose when to install the new app from <abbrtitle="a method to distribute apps without direct connection">TestFlight</abbr> onto your phone</li>
3897
3905
</ul>
3898
3906
</li>
@@ -3903,7 +3911,7 @@ <h3 id="mac-vs-browser">Mac vs Browser<a class="headerlink" href="#mac-vs-browse
3903
3911
<li>After the <em><abbrtitle="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>
3904
3912
<li>The app is delivered to your phone via <em><abbrtitle="a method to distribute apps without direct connection">TestFlight</abbr></em><ul>
3905
3913
<li>The app is considered "Beta" by <em>Apple</em> and expires after 90 days</li>
3906
-
<li><spantranslate="no"><abbrtitle="Latest release with major updates">Loop 3</abbr>.4</span> and later versions provide automatic build as the default</li>
3914
+
<li><spantranslate="no"><abbrtitle="Latest release with major updates">Loop 3</abbr>.4</span> and newer versions provide automatic build as the default</li>
3907
3915
</ul>
3908
3916
</li>
3909
3917
<li>Customization methods are documented at <ahref="../custom-browser/" target="_blank">Customize with Browser</a></li>
Copy file name to clipboardExpand all lines: browser/build-dev-browser/index.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -3755,7 +3755,7 @@ <h4 id="refresh-do-not-repeat">Refresh, Do Not Repeat<a class="headerlink" href=
3755
3755
</div>
3756
3756
<h2id="automatic-update-build">Automatic Update & Build<aclass="headerlink" href="#automatic-update-build" title="Anchor link to this Header on this Page">¶</a></h2>
3757
3757
<p>The <ahref="../automatic/" target="_blank">Automatic Update & Build</a> features are applied to the default <abbrtitle="version of code within a single repository or workspace repository">branch</abbr> of your <abbrtitle="contains project files and each file's revision history">repository</abbr>. Normally this is the <code>main</code><abbrtitle="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><abbrtitle="version of code within a single repository or workspace repository">branch</abbr> to be built automatically, you must configure it as your default <abbrtitle="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><abbrtitle="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><abbrtitle="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: <ahref="../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><abbrtitle="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><abbrtitle="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>: <ahref="../automatic/#modify-automatic-building" target="_blank">Modify Automatic Building</a>.</p>
3759
3759
<h2id="change-default-branch">Change Default <code>Branch</code><aclass="headerlink" href="#change-default-branch" title="Anchor link to this Header on this Page">¶</a></h2>
3760
3760
<blockquote>
3761
3761
<p><strong>We recommend most users leave their default <abbrtitle="version of code within a single repository or workspace repository">branch</abbr> as <code>main</code>.</strong></p>
<pclass="admonition-title"><abbrtitle="the Loop code uses a number of modules to handle different components of the entire app">Modules</abbr> vs Submodule</p>
4119
4119
<p>This page has instructions to set up your own <code><abbrtitle="a copy of code in a github repository other than the original">fork</abbr></code> for the <abbrtitle="the Loop code uses a number of modules to handle different components of the entire app">Modules</abbr>, otherwise known as <abbrtitle="for Loop, submodules are repositories defined in the Workspace repository that are required to build the app">submodules</abbr>, associated with <spantranslate="no">LoopWorkspace</span> that are needed for a selected customization.</p>
4120
-
<p>Each Module has its own <em><abbrtitle="an online service for storing repositories, accessible from a browser">GitHub</abbr></em><code><abbrtitle="contains project files and each file's revision history">repository</abbr></code>;and you will be working with your <code><abbrtitle="a copy of code in a github repository other than the original">fork</abbr></code> of that Module at https://<abbrtitle="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><abbrtitle="an online service for storing repositories, accessible from a browser">GitHub</abbr></em><code><abbrtitle="contains project files and each file's revision history">repository</abbr></code>; and you will be working with your <code><abbrtitle="a copy of code in a github repository other than the original">fork</abbr></code> of that Module at https://<abbrtitle="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><abbrtitle="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://<abbrtitle="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>
4121
4122
</div>
4122
4123
<divclass="admonition question">
4123
4124
<pclass="admonition-title">What is a <abbrtitle="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
4337
4338
</ul>
4338
4339
<detailsclass="abstract">
4339
4340
<summary>Use only if directed (Click to Open/Close)</summary>
4340
-
<p>Open your browser to your https://<abbrtitle="an online service for storing repositories, accessible from a browser">github.com</abbr>/username/Module <abbrtitle="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://<abbrtitle="an online service for storing repositories, accessible from a browser">github.com</abbr>/my-name-org/Module <abbrtitle="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
4342
<p>If you are customizing a released version, use the <ahref="#table-of-sha-1">Table of <abbrtitle="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 <abbrtitle="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 <abbrtitle="website address (Uniform Resource Locator)">URL</abbr> in Step 2 below. The suggested <abbrtitle="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>
4342
4343
<p>You should create a <code>branch</code> following the numbered steps and watching the <abbrtitle="Graphics Interchange Format (GIF) can be used for small animations and low-resolution video clips">GIF</abbr>. Each Frame in the <abbrtitle="Graphics Interchange Format (GIF) can be used for small animations and low-resolution video clips">GIF</abbr> corresponds to a numbered step below.</p>
4343
4344
<ol>
@@ -4532,7 +4533,7 @@ <h2 id="prepare-the-customizations">Prepare the Customizations<a class="headerli
4532
4533
<h3id="prepare-customization-lines">Prepare customization lines<aclass="headerlink" href="#prepare-customization-lines" title="Anchor link to this Header on this Page">¶</a></h3>
4533
4534
<p>Save the customization lines in your text file for later use in the build_loop.yml file.</p>
<li>adding <code>.patch</code> after the <abbrtitle="Secure Hash Algorithm 1; used to generate an alphanumeric code for commits in git (github)">SHA-1</abbr> informs <em><abbrtitle="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><abbrtitle="a copy of code in a github repository other than the original">fork</abbr></code></li>
4544
4545
<li>the final <code> --directory=Module</code> is critical to apply the customization to the correct Module</li>
4545
4546
</ul>
4546
-
<p>To view the exact code change associated with that patch, open a browser at the <abbrtitle="website address (Uniform Resource Locator)">URL</abbr> of <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 <abbrtitle="website address (Uniform Resource Locator)">URL</abbr> of <code>https://github.com/my-name-org/Module/commit/SHA-1</code>.</p>
4547
4548
<h2id="update-loopworkspace">Update <spantranslate="no">LoopWorkspace</span><aclass="headerlink" href="#update-loopworkspace" title="Anchor link to this Header on this Page">¶</a></h2>
4548
4549
<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 <ahref="#how-to-use-the-patches-folder" target="_blank">How to use the <code>patches</code> Folder</a>.</p>
4549
4550
<p>The final step is to update your <spantranslate="no">LoopWorkspace <abbrtitle="a copy of code in a github repository other than the original">fork</abbr></span> to apply these customizations by adding those customization lines into the build_loop.yml file.</p>
0 commit comments