@todesktop/cli 1.7.7 → 1.8.0

package/README.md

@@ -135,6 +135,8 @@ We also support:
 
 - `todesktop build --code-sign=false`. Run a build with code-signing and notarization disabled. This is handy for testing builds quickly.
 - `todesktop build --config=<path.to.another.todesktop.json>`. Run a build with a different configuration file.
+- `todesktop build --async`. Run a build in the background. This is handy for CI environments.
+- `todesktop build --webhook URL`. Send a POST request to the webhook URL when the build is finished. It's especially useful together with the `--async` flag.
 - `todesktop release`. Release a build. This will publish a new download and an auto-update for existing users. By default it shows a list of builds for you to choose from.
   - Use `todesktop release <id>` to release a specific build by ID.
   - `todesktop release --latest` will release the latest build.
@@ -171,6 +173,38 @@ To build and release in one step, you can execute:
 todesktop build && todesktop release --latest --force
 ```
 
+If you need to run a build in the background, you can use the `--async` flag. To
+get notified when the build is finished you can optionally specify a webhook URL
+which will receive a POST request with the build data:
+
+```sh
+todesktop build --async --webhook https://example.com/build-finished-webhook
+```
+
+The webhook receives a POST request with the following JSON body:
+
+```
+POST https://example.com/build-finished-webhook
+{
+  appId: string;
+  accountUserEmail: string;
+  accountUserId: string;
+  artifacts: {
+    linux?: LinuxArtifactDownloads;
+    mac?: MacArtifactDownloads;
+    windows?: WindowsArtifactDownloads;
+  };
+  buildId: string;
+  endedAt: string; // 2023-01-01T00:00:00Z
+  errorMessage?: string;
+  requesterUserEmail: string;
+  requesterUserId: string; // The same as accountUserId or `contextUserId`
+  schemaVersion: number; // Currently always `1`
+  startedAt: string; // 2023-01-01T00:00:00Z
+  status:  'queued' | 'failed' | 'building' | 'preparation' | 'succeeded' | 'cancelled';
+}
+```
+
 ## Project configuration (todesktop.json)
 
 This describes all of the possible configuration options ín your `todesktop.json`.
@@ -425,9 +459,12 @@ Example:
 - `ext` String | Array<String> - The extension (minus the leading period). e.g. png.
 - `name` String - The name. e.g. PNG. Defaults to value of `ext`.
 - `description` String - windows-only. The description.
+- `icon` String - macOS and windows. Icon file name without extension. It points
+  to ico file for Windows and icns for macOS. For example, if the `icon` value is `"icons/py"` then it will look for both `"icons/py.ico"` and `"icons/py.icns"` in your project directory.
 - `mimeType` String - linux-only. The mime-type.
-- `role` = `Editor` String - macOS-only The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.
-- `isPackage` Boolean - macOS-only Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.
+- `role` = `Editor` String - macOS-only. The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.
+- `isPackage` Boolean - macOS-only. Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.
+- `rank` = `Default` String macOS-only. Determines how Launch Services ranks this app among the apps that declare themselves editors or viewers of files of this type. The possible values are: `Owner` (this app is the primary creator of files of this type), `Default` (this app is an opener of files of this type; this value is also used if no rank is specified), `Alternate` (this app is a secondary viewer of files of this type), and `None` (this app is never selected to open files of this type, but it accepts drops of files of this type).
 
 ### `filesForDistribution` - (optional) array of glob patterns
 
@@ -605,6 +642,12 @@ Example: `yarn`
 
 The package manager to use when installing dependencies. Valid values are `npm`, `yarn` or `pnpm`.
 
+### `pnpmVersion` - string
+
+Example: `8.10.5`.
+
+The version of pnpm that ToDesktop should use for installation.
+
 ### `schemaVersion` - number
 
 Example: `1`.
@@ -791,6 +834,12 @@ Default: `undefined`.
 
 The path to NSIS script to customize installer.
 
+### `yarnVersion` - string
+
+Example: `1.22.1`.
+
+The version of Yarn that ToDesktop should use for installation.
+
 ## Build lifecycle hooks (package.json scripts)
 
 Sometimes you want to do something before or during the build process. For example, you might want to run a script before the build starts, or you might want to run a script after the files have been packaged. Our lifecycle hooks provide a way to do this.
@@ -850,8 +899,8 @@ The `afterPack` function also has the following arguments added to it's signatur
 - shouldCodeSign - boolean - whether the app will be code signed or not
 - outDir - string - the path to the output directory
 - appOutDir - string - the path to the app output directory
-- arch - string - the architecture of the app
 - packager - object - the packager object
+- arch - number - the architecture of the app. `ia32 = 0`, `x64 = 1`, `armv7l = 2`, `arm64 = 3`, `universal = 4`.
 
 Example script:
 
@@ -989,6 +1038,13 @@ Now, when we build your app on ToDesktop servers, it will also run your custom `
 
 ## Changelog
 
+### v1.8.0
+
+- Add support for `--webhook` flag for `todesktop build` command
+- Add support for `--async` flag to run a build in the in the background
+- Add support for specifying custom `yarnVersion` in config
+- Add support for specifying custom `pnpmVersion` in config
+
 ### v1.7.7
 
 - Report errors when S3 upload fails and retry 3 times