Merge pull request #732 from quoid/build/update-xcconfig-files-and-de…

…v-doc build: update xcconfig files and dev doc require team id
quoid · Sep 28, 2024 · 2700906 · 2700906
2 parents c4a57a7 + 65159a5
commit 2700906
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 20 deletions.
diff --git a/docs/dev.md b/docs/dev.md
@@ -22,6 +22,7 @@ Reviewing the template will help you understand the composition of the project.
 
 - [`Node.js`](https://nodejs.org/)
 - [`Xcode`](https://geo.itunes.apple.com/app/id497799835)
+- `Developer Team ID` (i.e. Apple Account, see [Xcode section](#xcode))
 
 # Dev
 
@@ -30,6 +31,10 @@ Reviewing the template will help you understand the composition of the project.
 
 # Build
 
+> [!NOTE]
+> Before building the app with Xcode make sure you create the `.dev.xcconfig` files [below](#xcconfig) and fill in your `Developer Team ID`.
+> Otherwise `App groups` related functions will not work properly.
+
 - `npm run build:mac` [^1][^2]
 - `cd ./xcode`
 - `xcodebuild -scheme Mac` [^1][^2][^3] or build with `Xcode` App
@@ -42,32 +47,27 @@ Reviewing the template will help you understand the composition of the project.
 
 # Xcode
 
+Please note that a developer account is required, which can be a free Apple Account that has agreed to the Apple Developer Agreement. This is required to obtain a `Team ID` and use the `App groups` capability.
+
 ### Configurations
 
-The Xcode project contains two configurations, which have independent `xcconfig` configuration files, and can run on your local at the same time without conflicts.
+The Xcode project contains several configurations, which have independent `xcconfig` configuration files, and can run on your local at the same time without conflicts.
+
+- `Vite`: for vite real-time development.
 
-- `Debug`: No developer account is required, that is `Sign to Run Locally` by default, which will speed up the build during development. This is convenient for developers without an account, and contributors who only need to do simple local debugging.
+- `Debug`: for development and debugging.
 
-- `Release`: A developer account is required, which means it can be used for distribution as well as running on real iOS/iPadOS devices. You will need to override your developer account information in `xcconfig` to complete the build.
+- `Release`: for building and distributing.
 
 ### xcconfig
 
 All `xcconfig` files are in the [`/xcode/xcconfig/`](../xcode/xcconfig) directory. Each `.xcconfig` file can be overridden by `.dev.xcconfig` in the same path, they will be ignored by `git`, so you can override any build settings locally.
 
-For example, you can create an `Userscripts-Release.dev.xcconfig` file to override [`Userscripts-Release.xcconfig`](../xcode/xcconfig/Userscripts-Release.xcconfig) and fill in your own developer account information there:
-
-`Userscripts-Release.dev.xcconfig`
-
-```
-DEVELOPMENT_TEAM = XXXXXXXXXX
-```
-
-Another example, if you want `Debug` builds to be also signed, so instead of enabling `Allow Unsigned Extensions` every time in Safari, you can create:
+For example, you can create an `Userscripts-Debug.dev.xcconfig` file to override [`Userscripts-Debug.xcconfig`](../xcode/xcconfig/Userscripts-Debug.xcconfig) and fill in your own developer account `Team ID` there:
 
 `Userscripts-Debug.dev.xcconfig`
 
 ```
-CODE_SIGN_IDENTITY = Apple Development
 DEVELOPMENT_TEAM = XXXXXXXXXX
 ```
 
@@ -79,4 +79,4 @@ Note that all existing `.xcconfig` files already include `.dev.xcconfig` files o
 
 # About
 
-[Userscripts](https://github.com/quoid/userscripts) @ 2018-2023
+[Userscripts](https://github.com/quoid/userscripts) @ 2018-2024
diff --git a/xcode/xcconfig/Userscripts-Debug.xcconfig b/xcode/xcconfig/Userscripts-Debug.xcconfig
@@ -4,8 +4,10 @@ INFOPLIST_KEY_NSHumanReadableCopyright = Copyright © Userscripts
 CURRENT_PROJECT_VERSION = 1
 MARKETING_VERSION = 1.0.0
 
-// Sign to Run Locally
-CODE_SIGN_IDENTITY = -
+// Development
+CODE_SIGN_IDENTITY = Apple Development
+// Developer Team ID
+DEVELOPMENT_TEAM = XXXXXXXXXX
 // Organization Identifier
 ORG_IDENTIFIER = dev.debug
 // Application Identifier
@@ -14,7 +16,7 @@ APP_IDENTIFIER = $(ORG_IDENTIFIER).userscripts
 EXT_IDENTIFIER = $(APP_IDENTIFIER).ext.safari
 // App Groups and Group Containers
 IOS_SHARED_GID = group.$(ORG_IDENTIFIER).userscripts
-MAC_SHARED_GID = 00000.$(ORG_IDENTIFIER).userscripts
+MAC_SHARED_GID = $(DEVELOPMENT_TEAM).$(ORG_IDENTIFIER).userscripts
 // App URL Scheme
 APP_URL_SCHEME = userscriptsdebug
 

diff --git a/xcode/xcconfig/Userscripts-Vite.xcconfig b/xcode/xcconfig/Userscripts-Vite.xcconfig
@@ -4,8 +4,10 @@ INFOPLIST_KEY_NSHumanReadableCopyright = Copyright © Userscripts
 CURRENT_PROJECT_VERSION = 2
 MARKETING_VERSION = 2.0.0
 
-// Sign to Run Locally
-CODE_SIGN_IDENTITY = -
+// Development
+CODE_SIGN_IDENTITY = Apple Development
+// Developer Team ID
+DEVELOPMENT_TEAM = XXXXXXXXXX
 // Organization Identifier
 ORG_IDENTIFIER = dev.vite
 // Application Identifier
@@ -14,7 +16,7 @@ APP_IDENTIFIER = $(ORG_IDENTIFIER).userscripts
 EXT_IDENTIFIER = $(APP_IDENTIFIER).ext.safari
 // App Groups and Group Containers
 IOS_SHARED_GID = group.$(ORG_IDENTIFIER).userscripts
-MAC_SHARED_GID = 00000.$(ORG_IDENTIFIER).userscripts
+MAC_SHARED_GID = $(DEVELOPMENT_TEAM).$(ORG_IDENTIFIER).userscripts
 // App URL Scheme
 APP_URL_SCHEME = userscripts-vite