Skip to content

Commit

Permalink
Deployed 999b8e8 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
marionbarker committed Feb 24, 2024
1 parent 1838f46 commit 4c6b160
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 14 deletions.
30 changes: 19 additions & 11 deletions gh-actions/automatic/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3258,10 +3258,18 @@
<h1>Automatic Update & Build</h1>

<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Anchor link to this Header on this Page">&para;</a></h2>
<p><strong>After the next release of the <em><abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em> app (version 3.4.0), this page will be required for all versions when building with a browser.</strong></p>
<p><strong>Before that release, this page is only relevant when building the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> with a browser and only when the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> is the default <abbr title="version of code within a single repository or workspace repository">branch</abbr>.</strong></p>
<p>The instructions on the <a href="../gh-first-time/">Configure to Use Browser</a> page will, unless you make a change, automatically take the following actions for released versions 3.4.0 and later:</p>
<ul>
<li>Update the version of your&nbsp;<span translate="no"><abbr title="a copy of code in a github repository other than the original">fork</abbr></span>&nbsp;within a week of the change<ul>
<li>When an update to the default <code>branch</code>, typically <code>main</code>, is detected, a new build is created automatically and uploaded to <em><abbr title="a method to distribute apps without direct connection">TestFlight</abbr></em></li>
</ul>
</li>
<li>Build the app at least once a month and upload the fresh build to <em><abbr title="a method to distribute apps without direct connection">TestFlight</abbr></em></li>
</ul>
<p>If you do not want this automatic schedule, you can modify it.</p>
<p>Regardless of your choice, please <a href="../gh-deploy/#disable-automatic-install-from-testflight" target="_blank">Disable Automatic Installation from <em><abbr title="a method to distribute apps without direct connection">TestFlight</abbr></em></a>. You should be alert any time your <em><abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em> app is updated. Check that all settings are maintained and pay attention to make sure the app behavior is nominal.</p>
<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>
<p>For someone using <a href="../build-dev-browser/">development code</a> for their own use, they probably want to decide 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. There may be other configurations someone would choose. These options are added to <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>
<p>For someone using <a href="../build-dev-browser/">development code</a> for their own use, they probably want to decide 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. 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>
<p>You can affect the default behavior:</p>
<ol>
<li><a href="#modify-automatic-schedule">Modify Automatic Schedule</a></li>
Expand All @@ -3281,26 +3289,26 @@ <h3 id="modify-automatic-schedule">Modify Automatic Schedule<a class="headerlink
<table>
<thead>
<tr>
<th><code>SCHEDULED _SYNC</code></th>
<th><code>SCHEDULED _BUILD</code></th>
<th><code>SCHEDULED _SYNC</code></th>
<th>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></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>true</code> (or NA)</td>
<td><code>true</code> (or NA)</td>
<td>keep-alive, weekly update check (auto update/build), monthly build with auto update</td>
<td><code>true</code> (or N/A)</td>
<td><code>true</code> (or N/A)</td>
<td>This is the default:<br>keep-alive, weekly update check (auto update/build), monthly build with auto update</td>
</tr>
<tr>
<td><code>true</code> (or NA)</td>
<td><code>true</code> (or N/A)</td>
<td><code>false</code></td>
<td>keep-alive, weekly update check with auto update, only builds if update detected</td>
<td>keep-alive, monthly build, no auto update</td>
</tr>
<tr>
<td><code>false</code></td>
<td><code>true</code> (or NA)</td>
<td>keep-alive, monthly build, no auto update</td>
<td><code>true</code> (or N/A)</td>
<td>keep-alive, weekly update check with auto update, only builds if update detected</td>
</tr>
<tr>
<td><code>false</code></td>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Binary file modified sitemap.xml.gz
Binary file not shown.
4 changes: 2 additions & 2 deletions version/development/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3494,7 +3494,7 @@ <h3 id="github-browser-build-updates"><span translate="no"><abbr title="an onlin
</ul>
</li>
</ul>
<p>These sections are still useful for version 3.3.0 <code>dev</code> users:</p>
<p>These sections are still useful for version 3.5.0 <code>dev</code> users:</p>
<ul>
<li><a href="../../gh-actions/build-dev-browser/">Browser Build for dev</a>: How to use &nbsp;<span translate="no"><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr> Browser Build</span>&nbsp; for <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr></li>
<li><a href="../../gh-actions/build-dev-browser/#one-time-changes">Browser Build: One-Time Changes</a>: New steps and dates at which the new steps were added</li>
Expand All @@ -3520,7 +3520,7 @@ <h3 id="loop-github-information"><code>Loop</code> <abbr title="an online servic
<p>But then...the chefs/developers go on a trip. They are inspired by new cuisine and want to add new recipes to the old cookbook. (Things like <abbr title="Insulet tubeless insulin pump; Loop supports Eros (with RileyLink) and DASH. Eros is also known as Classic, UST400, and System.">Omnipod</abbr>&#8203; support and the overrides are new "recipes" that were developed since the last <code>main</code> release, for example.) But, the process of developing a recipe is arduous. There was a lot of trial and error involved. Lots of tweaking ingredients (code). The editors try out the new recipes and offer feedback (similar to the <a href="https://github.com/LoopKit/Loop/issues" target="_blank">Issues List on <abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></a>). While the recipes are being developed, they have a version of the old cookbook that gets marked up...edited in pencil a lot. Scribbles and notes in the side. Revisions happen frequently because that's what testing new recipes is all about. These marked-up versions of the cookbook are called the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr>. Short for "development" <abbr title="version of code within a single repository or workspace repository">branch</abbr>. Like the name sounds...this is where new developments are happening, new recipes, and tweaks.</p>
<p>After much testing and tweaking, eventually, the recipes get the flavors right (bugs in code are squashed) and enough people have provided feedback and careful observations of results...that the book goes to the publishing house for the next printing. The cookbook is republished with an updated edition number and new recipes are highlighted. When this happens in <em><abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em>, <span><abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr>&#39;s <code>main</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr></span> is updated with the new features coming from <code>dev</code> (aka, the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> is merged into the <code>main</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr>). When that happens, the <code>main</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> gets another <code>release</code> version. At this point, <code>dev</code> and <code>main</code> are identical. They remain so until the development team for <em><abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em>&nbsp; starts working on the next batch of improvements, which could be in the next hour or even days later, but then the cycle starts again. The developers will start editing the code again and dropping those edits in the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> for further development.</p>
<h2 id="whats-going-on-in-the-dev-branch">What's going on in the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr>?<a class="headerlink" href="#whats-going-on-in-the-dev-branch" title="Anchor link to this Header on this Page">&para;</a></h2>
<p>The <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr>, currently v3.3.0, is where the next version of <em><abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em> is being developed and tested.</p>
<p>The <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr>, currently v3.5.0, is where the next version of <em><abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em> is being developed and tested.</p>
<p>If you choose to build <em><abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em> using a <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr>, you need to be aware that the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> may update code frequently and unannounced in the traditional sense that most users in the <em>Looped</em> group or <em>Instagram</em> would see. Developers are not helped by people being in a <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> if those users mistakenly think of it as a stable <code>main</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> with lots of detailed docs to go with it. People should only use a <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> build if they EDUCATE themselves on the expectations and how to properly manage <code>dev</code> information and updates. People using the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> should also have regular access to a computer to be able to rebuild quickly if a new bug/fix is identified.</p>
<p>If you choose to use a <code>dev</code> build, you can stay abreast of developments in a number of ways...but they will all require you to do some legwork and keep yourself informed. This is not a situation where you should expect a fancy <em>Loopdocs</em> page updated regularly with current "<code>dev</code> updates"...that's just not the way the <code>dev</code> <abbr title="version of code within a single repository or workspace repository">branch</abbr> works (at least normally).</p>
<h3 id="subscribe-to-the-zulipchat-channels">Subscribe to the Zulipchat channels<a class="headerlink" href="#subscribe-to-the-zulipchat-channels" title="Anchor link to this Header on this Page">&para;</a></h3>
Expand Down

0 comments on commit 4c6b160

Please sign in to comment.