@todesktop/cli 1.22.0 → 1.23.0

package/README.md

@@ -48,7 +48,7 @@ Create a `todesktop.json` file in the root of your Electron project.
 
 ```json
 {
-  "$schema": "https://unpkg.com/@todesktop/cli@1.22.0/schemas/schema.json",
+  "$schema": "https://unpkg.com/@todesktop/cli@1.23.0/schemas/schema.json",
   "schemaVersion": 1
   "id": "your-todesktop-id",
   "icon": "./desktop-icon.png",
@@ -413,7 +413,7 @@ To enable JSON validation and IntelliSense for your `todesktop.json` file in com
 - For example, if using a hosted version of the schema:
   ```json
   {
-    "$schema": "https://unpkg.com/@todesktop/cli@1.22.0/schemas/schema.json",
+    "$schema": "https://unpkg.com/@todesktop/cli@1.23.0/schemas/schema.json",
     "id": "your-todesktop-id"
   }
   ```
@@ -489,7 +489,7 @@ This is the path to your Electron application directory. Omit this unless your p
 The path can be absolute or a relative path from the project root. The directory
 it points to must be a valid Electron application directory; i.e.:
 
-- It could be ran with the `electron` command; i.e. `npx electron {{appPath}}`.
+- It could be ran with the `electron` command; i.e. `npx electron {appPath}`.
 - It needs to contain a valid `package.json`.
 - The `package.json` must either have a `main` property pointing to a file in
   the directory or there must be an `index.js` at the root of the directory.
@@ -1028,7 +1028,12 @@ Extra entries for `Info.plist`.
 
 Example: `./mac-icon.png`
 
-The path to your application's Mac desktop icon. It must be an ICNS or PNG.
+The path to your application's Mac desktop icon. It must be an ICNS, PNG, or Apple `.icon` package directory.
+
+Note: Apple `.icon` paths should point to the Icon Composer package directory
+(for example `AppIcon.icon`).
+
+Note: Apple `.icon` support requires `appBuilderLibVersion` `26.8.1` or later.
 
 Default: The root [`icon`](#icon---string) is used.
 
@@ -1372,9 +1377,12 @@ The publisher name, exactly as in your code signing certificate. Several names c
 
 ### `appBuilderLibVersion` - (optional) string
 
-Example: `22.14.13`
+Example: `22.14.13`, `latest`
+
+The version of app-builder-lib that ToDesktop should use for building your app. This can be a specific version, a semantic version range, or "latest". This can be useful if you need to use a specific version that includes certain features or fixes.
 
-The version of app-builder-lib that ToDesktop should use for building your app. This can be useful if you need to use a specific version that includes certain features or fixes.
+Note: Set this to `26.8.1` or later if you are using Apple Icon Composer assets
+via [`mac.icon`](#macicon---optional-string).
 
 ### `platformOverrides` - (optional) object
 
@@ -1726,6 +1734,33 @@ Now, when we build your app on ToDesktop servers, it will also run your custom
 
 ## Changelog
 
+### 1.23.0
+
+#### Minor Changes
+
+- d4ed725: Add macOS Icon Composer `.icon` package support via `mac.icon`
+
+#### Patch Changes
+
+- 9cc64ae: Allow choosing the latest app-builder-lib version in
+  `todesktop.json`.
+- cb5ef40: Clean up failed builds by deleting the build record when upload
+  fails.
+
+### 1.22.2
+
+#### Patch Changes
+
+- f6557f8: Fix cases when build cancelling doesn't work as expected
+
+### 1.22.1
+
+#### Patch Changes
+
+- 3e109f0: Improved build introspection so the CLI passes app context for faster
+  session startup and invited teammates can connect without tunnel auth
+  permission errors.
+
 ### 1.22.0
 
 #### Minor Changes