Skip to content

Commit f8f27ea

Browse files
authored
Merge pull request #839 from marionbarker/working-docs
Add optional edits for App Groups and IDs
2 parents 73e4cd3 + 362af5c commit f8f27ea

File tree

1 file changed

+37
-13
lines changed

1 file changed

+37
-13
lines changed

docs/gh-actions/gh-first-time.md

Lines changed: 37 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -902,12 +902,12 @@ Please read carefully to avoid confusion.
902902
903903
### :material-dots-triangle: Substep 7.1 for Step 7
904904
905-
> Next section, Create `App Group`, is :material-dots-triangle: Substep 1 out of 2 for Step 7. This is only required one time and can be skipped if you previously built this app with Xcode.
905+
> Next section, Create `App Group`, is :material-dots-triangle: Substep 1 out of 2 for Step 7. This is only required one time.
906906
907907
### Create `App Group`
908908
909909
??? abstract "Section Summary (click to open/close)"
910-
[<span class="loop-bigger">:material-skip-forward:</span>](#previous-xcode-builders) If you have already built the *Loop* app via Xcode using this *Apple* ID, skip ahead to [Previous Xcode Builders](#previous-xcode-builders).
910+
[<span class="loop-bigger">:material-skip-forward:</span>](#optional-app-group-description-modification) If you have already built the *Loop* app via Xcode using this *Apple* ID, skip ahead to [Optional: App Group Description Modification](#optional-app-group-description-modification).
911911
912912
1. Go to [Register an `App Group`](https://developer.apple.com/account/resources/identifiers/applicationGroup/add/){: target="_blank" } on the *Apple Developer* site.
913913
1. For Description, use "Loop App Group".
@@ -916,7 +916,7 @@ Please read carefully to avoid confusion.
916916
917917
[<span class="loop-bigger">:material-skip-forward:</span>](#add-app-group-to-identifiers) To skip the detailed instructions, click on [Add `App Group` to Identifiers](#add-app-group-to-identifiers)
918918
919-
The `Loop` *App Group* already exists if you previously built the *Loop* app using *Xcode* with this *Apple Developer ID*. In that case, skip ahead to [Previous Xcode Builders](#previous-xcode-builders).
919+
The `Loop` *App Group* already exists if you previously built the *Loop* app using *Xcode* with this *Apple Developer ID*. In that case, skip ahead to [Optional: App Group Description Modification](#optional-app-group-description-modification) to update the description.
920920
921921
If you have never built the *Loop* app with *Xcode* using your `TEAMID`, you need to create an *App Group* associated with your `TEAMID`.
922922
@@ -927,6 +927,20 @@ If you have never built the *Loop* app with *Xcode* using your `TEAMID`, you nee
927927
* A mistake here means you will not be able to build the *Loop* app until you fix it
928928
1. Click `Continue` and then `Register`.
929929
930+
### Optional: App Group Description Modification
931+
932+
> This step is not required, but if you previously built using a Mac with Xcode, it is a good idea to update the **NAME** associated with the **IDENTIFIER** for the Loop App Group. Then what you see on your display will match the directions as you continue.
933+
934+
_Referring to the link and table below, tap on the **IDENTIFIER** for the `Loop App Group`, edit the Description to match the **NAME**, then Save the change._
935+
936+
* [App Group List](https://developer.apple.com/account/resources/identifiers/list/applicationGroup){: target="_blank" }
937+
938+
Notice in the table below that the XCode version of the **NAME** for the `App Group` is the same as the **IDENTIFIER** but with the `.` replaced with a space.
939+
940+
| NAME | XCode version | IDENTIFIER |
941+
|:--|:--|:--|
942+
| Loop App Group | group com TEAMID loopkit LoopGroup| group.com.TEAMID.loopkit.LoopGroup |
943+
930944
### Identifiers for the *Loop* app (3.2.x and before)
931945
932946
[<span class="loop-big">:material-skip-forward:</span>](#previous-xcode-builders) If you ever built the *Loop* app using *Mac*, skip ahead to [Previous Xcode Builders](#previous-xcode-builders).
@@ -941,20 +955,30 @@ If you never built using *Xcode*, then after the <code>Add Identifiers</code> *A
941955
942956
#### Previous Xcode Builders
943957
944-
Click this link: [`Certificates, Identifiers & Profiles: Identifiers List`](https://developer.apple.com/account/resources/identifiers/list){: target="_blank" } on the *Apple Developer* site.
958+
If you built previously using a Mac with Xcode, you may see the XCode version in your **NAME** column of the table below.
945959
946-
Because you built the *Loop* app using *Xcode*, then the **`NAME`** associated with at least the `Loop identifier` will appear as `XC com.TEAMID.loopkit.Loop` under the **`NAME`** column. Ignore the **`NAME`** column and key off what you see under the **`IDENTIFIER`** column of the table. Only the six listed in the table below need to appear when building `Loop 3`.
960+
- The name starts with XC and then the **IDENTIFIER** is appended where the `.` is replaced with a space, the example for `Loop` is shown in detail
947961
948962
#### Table with Name and Identifier for `Loop 3`
949963
950-
| `NAME` | `IDENTIFIER` |
951-
|-------|------------|
952-
| `Loop` | `com.TEAMID.loopkit.Loop` |
953-
| `Loop Intent Extension` | `com.TEAMID.loopkit.Loop.Loop-Intent-Extension` |
954-
| `Loop Status Extension` | `com.TEAMID.loopkit.Loop.statuswidget` |
955-
| `Small Status Widget` | `com.TEAMID.loopkit.Loop.SmallStatusWidget` |
956-
| `WatchApp` | `com.TEAMID.loopkit.Loop.LoopWatch` |
957-
| `WatchAppExtension` | `com.TEAMID.loopkit.Loop.LoopWatch.watchkitextension` |
964+
#### Optional: Identifier Description Modification
965+
966+
> This step is not required, but if you previously built using a Mac with Xcode, it is a good idea to update the **NAME** associated with each **IDENTIFIER** to match the table below. Then what you see on your display for the `App IDs` will match the directions as you continue.
967+
968+
_Referring to the table below, tap on each **IDENTIFIER** that has a different **NAME**, edit the Description to match the **NAME**, then Save the change for that identifier._
969+
970+
* Optional Organization Step - if you want, you can add the word `Loop` to the beginning of any **NAME** that starts with another word
971+
* If you later build an additional app, it can be convenient to have the `Loop` identifiers be in adjacent rows (they are displayed alphabetically by **NAME**)
972+
* For example, modify `WatchApp` to `Loop WatchApp` and `WatchAppExtension` to `Loop WatchAppExtension`
973+
974+
| NAME | XCode version | IDENTIFIER |
975+
|:--|:--|:--|
976+
| `Loop` | `XC com TEAMID loopkit Loop`| `com.TEAMID.loopkit.Loop` |
977+
| `Loop Intent Extension` | XC Identifier | `com.TEAMID.loopkit.Loop.Loop-Intent-Extension` |
978+
| `Loop Status Extension` | XC Identifier | `com.TEAMID.loopkit.Loop.statuswidget` |
979+
| `Small Status Widget` | XC Identifier | `com.TEAMID.loopkit.Loop.SmallStatusWidget` |
980+
| `WatchApp` | XC Identifier | `com.TEAMID.loopkit.Loop.LoopWatch` |
981+
| `WatchAppExtension` | XC Identifier | `com.TEAMID.loopkit.Loop.LoopWatch.watchkitextension` |
958982
959983
!!! warning "Loop dev Builders"
960984
The name and identifier for "`Small Status Widget`" has been renamed to "`Loop Widget Extension`". This only affects those using the dev branch until the next release. At that time, this table will be updated.

0 commit comments

Comments
 (0)