|
1191 | 1191 | <nav class="md-nav" aria-label="Update Fork"> |
1192 | 1192 | <ul class="md-nav__list"> |
1193 | 1193 |
|
| 1194 | + <li class="md-nav__item"> |
| 1195 | + <a href="#update-from-32x-to-34" class="md-nav__link"> |
| 1196 | + <span class="md-ellipsis"> |
| 1197 | + Update from 3.2.x to 3.4 |
| 1198 | + </span> |
| 1199 | + </a> |
| 1200 | + |
| 1201 | +</li> |
| 1202 | + |
1194 | 1203 | <li class="md-nav__item"> |
1195 | 1204 | <a href="#special-instructions-for-360" class="md-nav__link"> |
1196 | 1205 | <span class="md-ellipsis"> |
|
3724 | 3733 | <nav class="md-nav" aria-label="Update Fork"> |
3725 | 3734 | <ul class="md-nav__list"> |
3726 | 3735 |
|
| 3736 | + <li class="md-nav__item"> |
| 3737 | + <a href="#update-from-32x-to-34" class="md-nav__link"> |
| 3738 | + <span class="md-ellipsis"> |
| 3739 | + Update from 3.2.x to 3.4 |
| 3740 | + </span> |
| 3741 | + </a> |
| 3742 | + |
| 3743 | +</li> |
| 3744 | + |
3727 | 3745 | <li class="md-nav__item"> |
3728 | 3746 | <a href="#special-instructions-for-360" class="md-nav__link"> |
3729 | 3747 | <span class="md-ellipsis"> |
@@ -4046,6 +4064,113 @@ <h2 id="update-fork">Update <code>Fork</code><a class="headerlink" href="#update |
4046 | 4064 | <p>This is Step 2 of 5 - it may not always be necessary, but please check every time.</p> |
4047 | 4065 | </blockquote> |
4048 | 4066 | <p>Open your <em><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> account and select your <code>LoopWorkspace <abbr title="contains project files and each file's revision history">repository</abbr></code> from your repositories list.</p> |
| 4067 | +<h3 id="update-from-32x-to-34">Update from 3.2.x to 3.4<a class="headerlink" href="#update-from-32x-to-34" title="Anchor link to this Header on this Page">¶</a></h3> |
| 4068 | +<p>This should only be necessary if you are changing from an older, Mac-<abbr title="program used to build an app">Xcode</abbr> build of version 3.2.x to a Browser Build of 3.6.x. Most people are updating from 3.4.x to 3.6.x and should skip ahead to <a href="#special-instructions-for-360">Special Instructions for 3.6.0</a>.</p> |
| 4069 | +<p>For the update from 3.2.x to 3.6, you must do more than "just" build. If you skip this step - the build will fail.</p> |
| 4070 | +<ul> |
| 4071 | +<li>The <code>Identifier</code> for the "<code>widget</code>" changed from "<code>SmallStatusWidget</code>" to the more descriptive "<code>LoopWidgetExtension</code>"</li> |
| 4072 | +</ul> |
| 4073 | +<blockquote> |
| 4074 | +<p>If you built version 3.3.0 (the <code>dev branch</code> before release of version 3.4) or newer, you can skip ahead to <a href="#special-instructions-for-360">Special Instructions for 3.6.0</a>.</p> |
| 4075 | +</blockquote> |
| 4076 | +<p>You will (1) run <a href="#add-identifiers"><code>Add Identifiers</code></a>, (2) <a href="#add-app-group-to-new-identifier">add the <code>App Group</code></a> to the new identifier, (3) run <a href="#create-certificates"><code>Create Certificates</code></a> and then (4) run <a href="#build-the-app"><code>Build Loop</code></a>.</p> |
| 4077 | +<h4 id="add-identifiers">Add <abbr title="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr><a class="headerlink" href="#add-identifiers" title="Anchor link to this Header on this Page">¶</a></h4> |
| 4078 | +<p>In your <abbr title="a copy of code in a github repository other than the original">fork</abbr> of LoopWorkspace:</p> |
| 4079 | +<ul> |
| 4080 | +<li>Run the Action: <code>Add Identifier</code></li> |
| 4081 | +<li>Wait for it to succeed</li> |
| 4082 | +</ul> |
| 4083 | +<details class="tip"> |
| 4084 | +<summary>Detailed instructions for <code>Add Identifier</code> (Click to open/close)</summary> |
| 4085 | +<p>Refer to the graphic below for the numbered steps:</p> |
| 4086 | +<ol> |
| 4087 | +<li>Click on the <code>Actions</code> tab of your <code>LoopWorkspace</code> <abbr title="contains project files and each file's revision history">repository</abbr></li> |
| 4088 | +<li>On the left side, click on 2. <code>Add <abbr title="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr></code></li> |
| 4089 | +<li>On the right side, click <code>Run Workflow</code> to show a dropdown menu<ul> |
| 4090 | +<li>You will see your default <abbr title="version of code within a single repository or workspace repository">branch</abbr> (typically this is <code>main</code>)</li> |
| 4091 | +</ul> |
| 4092 | +</li> |
| 4093 | +<li> |
| 4094 | +<p>Tap the green button that says <code>Run workflow</code>.</p> |
| 4095 | +<p align="center"><img alt="add identifiers using github actions" src="../img/action-02-add-identifiers.svg" width="700" /></p> |
| 4096 | +</li> |
| 4097 | +</ol> |
| 4098 | +<p>The <code>Add Identifiers</code> <span class=notranslate>Action</span> should succeed or fail in a few minutes. Do not continue to the next step until this one succeeds.</p> |
| 4099 | +<ul> |
| 4100 | +<li>If you see the green check (<span class="twemoji passed"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M8 16A8 8 0 1 1 8 0a8 8 0 0 1 0 16m3.78-9.72a.75.75 0 0 0-.018-1.042.75.75 0 0 0-1.042-.018L6.75 9.19 5.28 7.72a.75.75 0 0 0-1.042.018.75.75 0 0 0-.018 1.042l2 2a.75.75 0 0 0 1.06 0Z"/></svg></span>) continue to the next section</li> |
| 4101 | +<li>If you see the red <code>X</code> (<span class="twemoji failed"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path d="M2.343 13.657A8 8 0 1 1 13.658 2.343 8 8 0 0 1 2.343 13.657M6.03 4.97a.75.75 0 0 0-1.042.018.75.75 0 0 0-.018 1.042L6.94 8 4.97 9.97a.749.749 0 0 0 .326 1.275.75.75 0 0 0 .734-.215L8 9.06l1.97 1.97a.749.749 0 0 0 1.275-.326.75.75 0 0 0-.215-.734L9.06 8l1.97-1.97a.749.749 0 0 0-.326-1.275.75.75 0 0 0-.734.215L8 6.94Z"/></svg></span>):<ul> |
| 4102 | +<li><a href="../bb-errors/#action-add-identifiers-errors" target="_blank">Action: Add <abbr title="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr> Errors</a> tells you what to search for in the file</li> |
| 4103 | +<li>Resolve the error and repeat <code>Add Identifiers</code></li> |
| 4104 | +</ul> |
| 4105 | +</li> |
| 4106 | +</ul> |
| 4107 | +</details> |
| 4108 | +<h4 id="add-app-group-to-new-identifier">Add <code>App Group</code> to New <code>Identifier</code><a class="headerlink" href="#add-app-group-to-new-identifier" title="Anchor link to this Header on this Page">¶</a></h4> |
| 4109 | +<p>Open the <a href="https://developer.apple.com/account/resources/identifiers/list" target="_blank">Certificates, <abbr title="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr> & Profiles: <abbr title="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr> List</a> page.</p> |
| 4110 | +<p>Click on the "<code>LoopWidgetExtension</code>" identifier to open the <code>Edit Your App ID Configuration</code> screen.</p> |
| 4111 | +<table> |
| 4112 | +<thead> |
| 4113 | +<tr> |
| 4114 | +<th><code>NAME</code></th> |
| 4115 | +<th><code>IDENTIFIER</code></th> |
| 4116 | +</tr> |
| 4117 | +</thead> |
| 4118 | +<tbody> |
| 4119 | +<tr> |
| 4120 | +<td><code>Loop Widget Extension</code></td> |
| 4121 | +<td><code>com.TEAMID.loopkit.Loop.LoopWidgetExtension</code></td> |
| 4122 | +</tr> |
| 4123 | +</tbody> |
| 4124 | +</table> |
| 4125 | +<p>The graphic below has numbered steps that match these directions:</p> |
| 4126 | +<ol> |
| 4127 | +<li>Looking at the <code>App Services</code> column, scroll down to the <code>App Groups</code> row and ensure the check box (under the <code>Capabilities column</code>) for <code>App Groups</code> is checked</li> |
| 4128 | +<li>If the word <code>Configure</code> shows up, tap on it<ul> |
| 4129 | +<li>This opens the <code>App Group Assignment</code> screen</li> |
| 4130 | +<li>If it said <code>Edit</code> instead of <code>Configure</code> - you can click to confirm you have the correct <abbr title="a unique identifier that Apple users for a given app, yours has your TEAMID embedded in it, group.com.TEAMID.loopkit.LoopGroup">App Group</abbr> but won't need to continue or save if it is correct</li> |
| 4131 | +</ul> |
| 4132 | +</li> |
| 4133 | +<li>Check the box by <code>Loop App Group</code> that uses your <code>TEAMID</code> in <code>group.com.TEAMID.loopkit.LoopGroup</code><ul> |
| 4134 | +<li>Note that if you previously built with <abbr title="program used to build an app">Xcode</abbr>, the name may be different, i.e., <code>XC group com TEAMID loopkit LoopGroup</code></li> |
| 4135 | +</ul> |
| 4136 | +</li> |
| 4137 | +<li>Tap <code>Continue</code></li> |
| 4138 | +<li>Tap <code>Save</code></li> |
| 4139 | +</ol> |
| 4140 | +<p align="center"><img alt="graphic showing selection of the correct App Group" src="../img/update-identifier-loop-3-4.png" width="700" /></p> |
| 4141 | +<p>If you did not need to make changes, the <code>Save</code> button will not be active.</p> |
| 4142 | +<ul> |
| 4143 | +<li>Tap on the <code>< All Identifiers</code> link at the top left</li> |
| 4144 | +</ul> |
| 4145 | +<p>The full list of <abbr title="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr> should be displayed again.</p> |
| 4146 | +<div class="admonition note"> |
| 4147 | +<p class="admonition-title">Other <abbr title="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr></p> |
| 4148 | +<p>All other identifiers should be already set up.</p> |
| 4149 | +<ul> |
| 4150 | +<li>If they are not, refer to <a href="../prepare-app/#add-app-group-to-identifiers" target="_blank">Configure to Use Browser: Add <abbr title="a unique identifier that Apple users for a given app, yours has your TEAMID embedded in it, group.com.TEAMID.loopkit.LoopGroup">App Group</abbr> to <abbr title="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr></a></li> |
| 4151 | +</ul> |
| 4152 | +</div> |
| 4153 | +<h4 id="create-certificates">Create Certificates<a class="headerlink" href="#create-certificates" title="Anchor link to this Header on this Page">¶</a></h4> |
| 4154 | +<p>You must run the action <code>Create Certificates</code> again because the <code>Identifiers</code> were updated. Wait for this to succeed before trying to build.</p> |
| 4155 | +<details class="tip" open="open"> |
| 4156 | +<summary>Detailed instructions (Click to open/close)</summary> |
| 4157 | +<p>Refer to the graphic below for the numbered steps:</p> |
| 4158 | +<ol> |
| 4159 | +<li>Click on the "<code><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></code>" tab of your <code>LoopWorkspace</code> <abbr title="contains project files and each file's revision history">repository</abbr></li> |
| 4160 | +<li>On the left side, click on "<code>Create Certificates</code>"</li> |
| 4161 | +<li>On the right side, click "<code>Run Workflow</code>" to show a dropdown menu<ul> |
| 4162 | +<li>You will see your default <abbr title="version of code within a single repository or workspace repository">branch</abbr> (typically <code>main</code>)</li> |
| 4163 | +</ul> |
| 4164 | +</li> |
| 4165 | +<li> |
| 4166 | +<p>Tap the green button that says "<code>Run workflow</code>".</p> |
| 4167 | +<p align="center"><img alt="create certificates using github actions" src="../img/action-03-create-certs.svg" width="700" /></p> |
| 4168 | +</li> |
| 4169 | +<li> |
| 4170 | +<p>Wait a minute or two for the action to finish</p> |
| 4171 | +</li> |
| 4172 | +</ol> |
| 4173 | +</details> |
4049 | 4174 | <h3 id="special-instructions-for-360">Special Instructions for 3.6.0<a class="headerlink" href="#special-instructions-for-360" title="Anchor link to this Header on this Page">¶</a></h3> |
4050 | 4175 | <p>When updating to version 3.6.0, there are two "extra" things to do.</p> |
4051 | 4176 | <ul> |
@@ -4324,7 +4449,7 @@ <h3 id="manual-steps-to-renew-your-distribution-certificate">Manual Steps to Ren |
4324 | 4449 | <p align="center"><img alt="delete the distributon certs folder in your Match-Secrets repository" src="../img/delete-distr-certs-match-secrets.gif" width="650" /></p> |
4325 | 4450 | <div class="admonition question"> |
4326 | 4451 | <p class="admonition-title">Deleting the certs/distribution folder did not work for me</p> |
4327 | | -<p>Some people reported trouble with this step. The other option is to delete and create a new <code>Match-Secrets</code> <abbr title="contains project files and each file's revision history">repository</abbr>: see <a href="../bb-errors/#reset-match-secrets" target="_blank">Reset <code>Match-Secrets</code></a></p> |
| 4452 | +<p>Some people reported trouble with this step. The other option is to delete and create a new <code>Match-Secrets</code> <abbr title="contains project files and each file's revision history">repository</abbr>: see <a href="../bb-errors/#delete-match-secrets" target="_blank">Delete <code>Match-Secrets</code></a></p> |
4328 | 4453 | </div> |
4329 | 4454 | </li> |
4330 | 4455 | <li> |
|
0 commit comments