@todesktop/cli 1.18.1 → 1.18.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -8
- package/dist/cli.js +7 -1
- package/dist/cli.js.map +2 -2
- package/dist/types.d.ts +4 -0
- package/package.json +1 -1
- package/schemas/schema.json +6 -0
package/README.md
CHANGED
|
@@ -11,6 +11,7 @@ For more information, visit the project
|
|
|
11
11
|
- [Installation](#installation)
|
|
12
12
|
- [Get started](#get-started)
|
|
13
13
|
- [CLI commands](#cli-commands)
|
|
14
|
+
- [Release Webhooks](#release-webhooks)
|
|
14
15
|
- [Automating your builds (CI)](#automating-your-builds-ci)
|
|
15
16
|
- [Project configuration (todesktop.json, todesktop.js, or todesktop.ts)](#project-configuration-todesktopjson-todesktopjs-or-todesktops)
|
|
16
17
|
- [Build lifecycle hooks (package.json scripts)](#build-lifecycle-hooks-packagejson-scripts)
|
|
@@ -46,7 +47,7 @@ Create a `todesktop.json` file in the root of your Electron project.
|
|
|
46
47
|
|
|
47
48
|
```json
|
|
48
49
|
{
|
|
49
|
-
"$schema": "https://unpkg.com/@todesktop/cli@1.18.
|
|
50
|
+
"$schema": "https://unpkg.com/@todesktop/cli@1.18.2/schemas/schema.json",
|
|
50
51
|
"schemaVersion": 1
|
|
51
52
|
"id": "your-todesktop-id",
|
|
52
53
|
"icon": "./desktop-icon.png",
|
|
@@ -201,6 +202,10 @@ We also support:
|
|
|
201
202
|
- Append `--force` to skip the interactive confirmation step.
|
|
202
203
|
- Append `--config=<path.to.config.file>` to use a different configuration
|
|
203
204
|
file.
|
|
205
|
+
- **Note:** By default, apps can not be released via the CLI. For security
|
|
206
|
+
reasons, you can only release apps through the
|
|
207
|
+
[web UI](https://app.todesktop.com) with security token authentication. If
|
|
208
|
+
you wish to enable CLI releases, please contact support with your app ID.
|
|
204
209
|
- `todesktop builds`. View your recent builds.
|
|
205
210
|
- Use `todesktop builds <id>` to view a specific build and its progress.
|
|
206
211
|
- `todesktop builds --latest` will show the latest build and it's progress.
|
|
@@ -232,12 +237,6 @@ TODESKTOP_ACCESS_TOKEN=accessToken
|
|
|
232
237
|
TODESKTOP_EMAIL=email
|
|
233
238
|
```
|
|
234
239
|
|
|
235
|
-
To build and release in one step, you can execute:
|
|
236
|
-
|
|
237
|
-
```sh
|
|
238
|
-
todesktop build && todesktop release --latest --force
|
|
239
|
-
```
|
|
240
|
-
|
|
241
240
|
If you need to run a build in the background, you can use the `--async` flag. To
|
|
242
241
|
get notified when the build is finished you can optionally specify a webhook URL
|
|
243
242
|
which will receive a POST request with the build data:
|
|
@@ -270,6 +269,15 @@ The webhook receives a POST request with the following JSON body:
|
|
|
270
269
|
}
|
|
271
270
|
```
|
|
272
271
|
|
|
272
|
+
## Release Webhooks
|
|
273
|
+
|
|
274
|
+
You can configure a webhook URL to receive notifications when a release is
|
|
275
|
+
published. This is useful for triggering downstream processes like deployment
|
|
276
|
+
pipelines or notifications.
|
|
277
|
+
|
|
278
|
+
You can read about how to do this in
|
|
279
|
+
[our release webhooks guide](https://www.todesktop.com/electron/docs/guides/release-webhooks).
|
|
280
|
+
|
|
273
281
|
## Project configuration (todesktop.json, todesktop.js, or todesktop.ts)
|
|
274
282
|
|
|
275
283
|
This describes all of the possible configuration options in your
|
|
@@ -311,7 +319,7 @@ To enable JSON validation and IntelliSense for your `todesktop.json` file in com
|
|
|
311
319
|
- For example, if using a hosted version of the schema:
|
|
312
320
|
```json
|
|
313
321
|
{
|
|
314
|
-
"$schema": "https://unpkg.com/@todesktop/cli@1.18.
|
|
322
|
+
"$schema": "https://unpkg.com/@todesktop/cli@1.18.2/schemas/schema.json",
|
|
315
323
|
"id": "your-todesktop-id"
|
|
316
324
|
}
|
|
317
325
|
```
|
|
@@ -877,6 +885,12 @@ Example: `distribution`
|
|
|
877
885
|
|
|
878
886
|
Whether to sign app for development or for distribution.
|
|
879
887
|
|
|
888
|
+
#### `mas.minimumSystemVersion` - (optional) string
|
|
889
|
+
|
|
890
|
+
Example: `12.0`, `11.0`, `10.15`
|
|
891
|
+
|
|
892
|
+
The minimum macOS version required to run the app. Set to '12.0' or higher for arm64-only Mac App Store submissions.
|
|
893
|
+
|
|
880
894
|
### `mas.x64ArchFiles` - (optional) string
|
|
881
895
|
|
|
882
896
|
Default: not defined
|
|
@@ -1517,6 +1531,12 @@ Now, when we build your app on ToDesktop servers, it will also run your custom
|
|
|
1517
1531
|
|
|
1518
1532
|
## Changelog
|
|
1519
1533
|
|
|
1534
|
+
### 1.18.2
|
|
1535
|
+
|
|
1536
|
+
#### Patch Changes
|
|
1537
|
+
|
|
1538
|
+
- 797f9cc: feat(mas): add `mas.minimumSystemVersion` config option
|
|
1539
|
+
|
|
1520
1540
|
### 1.18.0
|
|
1521
1541
|
|
|
1522
1542
|
#### Minor Changes
|
package/dist/cli.js
CHANGED
|
@@ -2158,6 +2158,12 @@ var schema_default = {
|
|
|
2158
2158
|
examples: ["distribution"],
|
|
2159
2159
|
default: "development"
|
|
2160
2160
|
},
|
|
2161
|
+
minimumSystemVersion: {
|
|
2162
|
+
type: "string",
|
|
2163
|
+
description: "The minimum macOS version required to run the app. Set to '12.0' or higher for arm64-only Mac App Store submissions.",
|
|
2164
|
+
examples: ["12.0", "11.0", "10.15"],
|
|
2165
|
+
pattern: "^[0-9]+\\.[0-9]+(\\.[0-9]+)?$"
|
|
2166
|
+
},
|
|
2161
2167
|
x64ArchFiles: {
|
|
2162
2168
|
type: "string",
|
|
2163
2169
|
description: "Minimatch pattern of paths that are allowed to be x64 binaries in both ASAR files.",
|
|
@@ -6649,7 +6655,7 @@ var package_default = {
|
|
|
6649
6655
|
access: "public"
|
|
6650
6656
|
},
|
|
6651
6657
|
name: "@todesktop/cli",
|
|
6652
|
-
version: "1.18.
|
|
6658
|
+
version: "1.18.2",
|
|
6653
6659
|
license: "MIT",
|
|
6654
6660
|
author: "Dave Jeffery <dave@todesktop.com> (http://www.todesktop.com/)",
|
|
6655
6661
|
homepage: "https://todesktop.com/cli",
|