Skip to content

Commit f521458

Browse files
marionbarkermarionbarker
committed
Deploying to gh-pages from @ 550d694 🚀
1 parent 232a46a commit f521458

File tree

8 files changed

+368
-253
lines changed

8 files changed

+368
-253
lines changed

‎browser/automatic/index.html‎

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1201,6 +1201,66 @@
12011201
</ul>
12021202
</nav>
12031203

1204+
</li>
1205+
1206+
<li class="md-nav__item">
1207+
<a href="#automatic-certificates" class="md-nav__link">
1208+
<span class="md-ellipsis">
1209+
Automatic Certificates
1210+
</span>
1211+
</a>
1212+
1213+
<nav class="md-nav" aria-label="Automatic Certificates">
1214+
<ul class="md-nav__list">
1215+
1216+
<li class="md-nav__item">
1217+
<a href="#requirements" class="md-nav__link">
1218+
<span class="md-ellipsis">
1219+
Requirements
1220+
</span>
1221+
</a>
1222+
1223+
</li>
1224+
1225+
<li class="md-nav__item">
1226+
<a href="#certificates-and-match-secrets" class="md-nav__link">
1227+
<span class="md-ellipsis">
1228+
Certificates and Match-Secrets
1229+
</span>
1230+
</a>
1231+
1232+
</li>
1233+
1234+
<li class="md-nav__item">
1235+
<a href="#annual-renewal" class="md-nav__link">
1236+
<span class="md-ellipsis">
1237+
Annual Renewal
1238+
</span>
1239+
</a>
1240+
1241+
</li>
1242+
1243+
<li class="md-nav__item">
1244+
<a href="#automatic-certificate-renewal" class="md-nav__link">
1245+
<span class="md-ellipsis">
1246+
Automatic Certificate Renewal
1247+
</span>
1248+
</a>
1249+
1250+
</li>
1251+
1252+
<li class="md-nav__item">
1253+
<a href="#open-source-app-schedule" class="md-nav__link">
1254+
<span class="md-ellipsis">
1255+
Open-Source App Schedule
1256+
</span>
1257+
</a>
1258+
1259+
</li>
1260+
1261+
</ul>
1262+
</nav>
1263+
12041264
</li>
12051265

12061266
<li class="md-nav__item">
@@ -3577,6 +3637,66 @@
35773637
</ul>
35783638
</nav>
35793639

3640+
</li>
3641+
3642+
<li class="md-nav__item">
3643+
<a href="#automatic-certificates" class="md-nav__link">
3644+
<span class="md-ellipsis">
3645+
Automatic Certificates
3646+
</span>
3647+
</a>
3648+
3649+
<nav class="md-nav" aria-label="Automatic Certificates">
3650+
<ul class="md-nav__list">
3651+
3652+
<li class="md-nav__item">
3653+
<a href="#requirements" class="md-nav__link">
3654+
<span class="md-ellipsis">
3655+
Requirements
3656+
</span>
3657+
</a>
3658+
3659+
</li>
3660+
3661+
<li class="md-nav__item">
3662+
<a href="#certificates-and-match-secrets" class="md-nav__link">
3663+
<span class="md-ellipsis">
3664+
Certificates and Match-Secrets
3665+
</span>
3666+
</a>
3667+
3668+
</li>
3669+
3670+
<li class="md-nav__item">
3671+
<a href="#annual-renewal" class="md-nav__link">
3672+
<span class="md-ellipsis">
3673+
Annual Renewal
3674+
</span>
3675+
</a>
3676+
3677+
</li>
3678+
3679+
<li class="md-nav__item">
3680+
<a href="#automatic-certificate-renewal" class="md-nav__link">
3681+
<span class="md-ellipsis">
3682+
Automatic Certificate Renewal
3683+
</span>
3684+
</a>
3685+
3686+
</li>
3687+
3688+
<li class="md-nav__item">
3689+
<a href="#open-source-app-schedule" class="md-nav__link">
3690+
<span class="md-ellipsis">
3691+
Open-Source App Schedule
3692+
</span>
3693+
</a>
3694+
3695+
</li>
3696+
3697+
</ul>
3698+
</nav>
3699+
35803700
</li>
35813701

35823702
<li class="md-nav__item">
@@ -3701,6 +3821,101 @@ <h4 id="automatic-creation-of-alive-branch">Automatic Creation of <code>alive br
37013821
<li>Leave the other branches alone unless a mentor directs you to take action</li>
37023822
</ul>
37033823
</div>
3824+
<h2 id="automatic-certificates">Automatic Certificates<a class="headerlink" href="#automatic-certificates" title="Anchor link to this Header on this Page">&para;</a></h2>
3825+
<p>Coming soon with <code>Loop 3.6.0</code>. </p>
3826+
<p>Already here with <code>LoopFollow 2.3.0</code> and some other Open-Source apps.</p>
3827+
<h3 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Anchor link to this Header on this Page">&para;</a></h3>
3828+
<p>You must have the <code>ENABLE_NUKE_CERTS</code> variable set to <code>true</code> for your <em><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> organization, or when using a personal account to build, add it to each <abbr title="contains project files and each file's revision history">repository</abbr>.</p>
3829+
<ul>
3830+
<li>Refer to <a href="../prepare-fork/#add-variable" target="_blank">Add Variable</a></li>
3831+
</ul>
3832+
<h3 id="certificates-and-match-secrets">Certificates and <code>Match-Secrets</code><a class="headerlink" href="#certificates-and-match-secrets" title="Anchor link to this Header on this Page">&para;</a></h3>
3833+
<p>The Create Certificates action does the following:</p>
3834+
<ul>
3835+
<li>Reads existing signing credentials from your <code>Match-Secrets</code> private respository and confirms if they are valid</li>
3836+
<li>OR</li>
3837+
<li>Uses your <code>Distribution</code> <abbr title="Apple certificate is used to sign your iOS or Mac apps - tied to but different from your permanent Developer ID">Certificate</abbr> from <em>Apple</em> or creates a new one if one does not exist</li>
3838+
<li>Securely stores, in your <code>Match-Secrets</code> private <abbr title="contains project files and each file's revision history">repository</abbr>, signing credentials (like certificates and provisioning profiles from <em>Apple</em>) used for code signing for each Identifier in your app when you build</li>
3839+
</ul>
3840+
<h3 id="annual-renewal">Annual Renewal<a class="headerlink" href="#annual-renewal" title="Anchor link to this Header on this Page">&para;</a></h3>
3841+
<p>This happens once a year after <em>Apple</em> automatically expires your <code>Distribution</code> <abbr title="Apple certificate is used to sign your iOS or Mac apps - tied to but different from your permanent Developer ID">Certificate</abbr>.</p>
3842+
<ul>
3843+
<li>When the <em>Apple</em> <code>Distribution</code> certificate expires, the saved credentials in your <code>Match-Secrets</code> private <abbr title="contains project files and each file's revision history">repository</abbr> are invalid and need to be removed (<code><abbr title="clear signing credentials from your Match-Secrets repository">nuke</abbr></code>)</li>
3844+
<li>You need a new <code>Distribution</code> <abbr title="Apple certificate is used to sign your iOS or Mac apps - tied to but different from your permanent Developer ID">Certificate</abbr> at <em>Apple</em></li>
3845+
<li>You need to create new signing credentials for <code>Match-Secrets</code></li>
3846+
</ul>
3847+
<p>For the <code>Loop</code> app, up through version 3.4.4, you need to do this process manually.</p>
3848+
<h3 id="automatic-certificate-renewal">Automatic <abbr title="Apple certificate is used to sign your iOS or Mac apps - tied to but different from your permanent Developer ID">Certificate</abbr> Renewal<a class="headerlink" href="#automatic-certificate-renewal" title="Anchor link to this Header on this Page">&para;</a></h3>
3849+
<p>Some Open-Source apps, in particular <code>Trio</code> and <code>LoopFollow 2.3.0</code> already have this capability.</p>
3850+
<ul>
3851+
<li>
3852+
<p>If your signing credentials for the app being built are invalid and <code>ENABLE_NUKE_CERTS</code> is <code>true</code>, then signing credentials will be cleared from your <code>Match-Secrets</code> <abbr title="contains project files and each file's revision history">repository</abbr>, a new <code>Distribution</code> certificate will be created at <em>Apple</em> and signing credentials for the current app will be generated and stored in <code>Match-Secrets</code>.</p>
3853+
</li>
3854+
<li>
3855+
<p>Next app you build will need certificates created because all signing credentials were cleared out of your <code>Match-Secrets</code> <abbr title="contains project files and each file's revision history">repository</abbr></p>
3856+
<ul>
3857+
<li>If that app is configured for automatic certificate renewal, you only need to run the <code>Build Action</code>; it detects no signing credentials are available and creates them</li>
3858+
<li>If that app is not configured for automatic certificate renewal, you must first run the action <code>Create Certificates</code> and then <code>Build</code></li>
3859+
</ul>
3860+
</li>
3861+
</ul>
3862+
<h3 id="open-source-app-schedule">Open-Source App Schedule<a class="headerlink" href="#open-source-app-schedule" title="Anchor link to this Header on this Page">&para;</a></h3>
3863+
<p>Each Open-Source App has a schedule for when the automatic build happens. This determines when the automatic check for certificate status happens.</p>
3864+
<p>The times are shifted to make sure only one Open-Source app performs a <code>nuke</code> process at one time. This only happens once a year, but we wanted to be sure there are no conflicts. Even if an app doesn't have automatic certificates implemented yet, they are added to the table as suggested values to use when this capability gets added. All times are <abbr title="Coordinated Universal Time is a time standard for civil time and time zones worldwide">UTC</abbr>. If other apps decide to add this feature, please make a pull request to LoopDocs so we can add those times to the deconfliction table.</p>
3865+
<table>
3866+
<thead>
3867+
<tr>
3868+
<th style="text-align: left;">Open-Source App</th>
3869+
<th style="text-align: center;">AutoCerts?</th>
3870+
<th style="text-align: right;">Wed Time</th>
3871+
<th style="text-align: right;">1st of Month Time</th>
3872+
</tr>
3873+
</thead>
3874+
<tbody>
3875+
<tr>
3876+
<td style="text-align: left;"><span translate="no"><abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></span></td>
3877+
<td style="text-align: center;"><code>dev</code> only</td>
3878+
<td style="text-align: right;">09:00</td>
3879+
<td style="text-align: right;">07:00</td>
3880+
</tr>
3881+
<tr>
3882+
<td style="text-align: left;"><span translate="no"><abbr title="An app you can build to provide remote commands to `Loop` using `Nightscout`">LoopCaregiver</abbr></span></td>
3883+
<td style="text-align: center;">n</td>
3884+
<td style="text-align: right;">13:00</td>
3885+
<td style="text-align: right;">11:00</td>
3886+
</tr>
3887+
<tr>
3888+
<td style="text-align: left;"><span translate="no"><abbr title="An app you can build to provide extra alarms and views of important information - can use Dexcom Share or `Nightscout` to include `Loop` information">LoopFollow</abbr></span></td>
3889+
<td style="text-align: center;">y</td>
3890+
<td style="text-align: right;">12:00</td>
3891+
<td style="text-align: right;">10:00</td>
3892+
</tr>
3893+
<tr>
3894+
<td style="text-align: left;"><span translate="no">LoopFollow_Second</span></td>
3895+
<td style="text-align: center;">y</td>
3896+
<td style="text-align: right;">12:20</td>
3897+
<td style="text-align: right;">10:20</td>
3898+
</tr>
3899+
<tr>
3900+
<td style="text-align: left;"><span translate="no">LoopFollow_Third</span></td>
3901+
<td style="text-align: center;">y</td>
3902+
<td style="text-align: right;">12:40</td>
3903+
<td style="text-align: right;">10:40</td>
3904+
</tr>
3905+
<tr>
3906+
<td style="text-align: left;"><span translate="no">Trio</span></td>
3907+
<td style="text-align: center;">y</td>
3908+
<td style="text-align: right;">08:00</td>
3909+
<td style="text-align: right;">06:00</td>
3910+
</tr>
3911+
<tr>
3912+
<td style="text-align: left;"><span translate="no">xDrip4iOS</span></td>
3913+
<td style="text-align: center;">n</td>
3914+
<td style="text-align: right;">16:00</td>
3915+
<td style="text-align: right;">14:00</td>
3916+
</tr>
3917+
</tbody>
3918+
</table>
37043919
<h2 id="modify-automatic-building">Modify Automatic Building<a class="headerlink" href="#modify-automatic-building" title="Anchor link to this Header on this Page">&para;</a></h2>
37053920
<p>For someone using <a href="../build-dev-browser/">development code</a> for their own use, they could decide to choose when to update their <code>fork</code> to the most recent <abbr title="a formal change to files in a repository; each commit has an alphanumeric identifier (SHA-1)">commit</abbr>. They can still have the advantage of automatic building without automatic updates; in other words, they want a new build added to <abbr title="a method to distribute apps without direct connection">TestFlight</abbr> every month. There may be other configurations someone would choose. These options are available starting with <abbr title="Latest release with major updates">Loop 3</abbr>.3.0 (<code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr>) and later.</p>
37063921
<p>You can affect the default behavior:</p>

0 commit comments

Comments
 (0)