@todesktop/cli 1.6.2 → 1.7.0-0

package/README.md

@@ -102,6 +102,14 @@ To release that build (i.e. publish new downloads and an auto-update), run:
 todesktop release
 ```
 
+### Step 6: Run smoke test
+
+To test whether that build works fine and can be successfully updated, run:
+
+```sh
+todesktop smoke-test
+```
+
 See the next section for more information on the available commands.
 
 ## CLI Commands
@@ -140,6 +148,10 @@ We also support:
   - Append `--config=<path.to.another.todesktop.json>` to use a different configuration file.
   - Append `--exit` to disable dynamic pagination and exit the process once the build data has been displayed.
 - `todesktop logout`. Logs you out.
+- `todesktop smoke-test` Check whether the build works and can be successfully updated.
+  - Use `todesktop smoke-test <id>` to test a specific build by ID.
+  - `todesktop smoke-test --latest` will test the latest build.
+  - Append `--config=<path.to.another.todesktop.json>` to use a different configuration file.
 - `todesktop whoami`. Prints the email of the account you're signed into.
 - `todesktop --help`. Shows the help documentation.
 - `todesktop --version`. Shows the current version of the CLI.
@@ -727,6 +739,31 @@ Default: The root [`icon`](#icon---string) is used.
 
 The path to your application's Windows desktop icon. It must be an ICO, ICNS, or PNG.
 
+#### `windows.nsisCustomBinary` - (optional) object
+
+Example:
+
+```json
+{
+  "debugLogging": true,
+  "url": "https://download.todesktop.com/nsis/nsis-3.06.1-log.7z",
+  "checksum": "pB4LJ5s+bIjK6X+IrY4oyq1knpI1YNcykawJR1+ax9XqDULohiS6J7/Imin22rBBX6uoEDY2gvsaCcvqKkWAtA=="
+}
+```
+
+Default: `undefined`.
+
+Allows you to provide your own makensis, such as one with support for debug logging via LogSet and LogText. (Logging also requires option debugLogging = true). It's not recommended to use it for production build.
+
+Example of NSIS script which enables install logging:
+
+```nsis
+!macro customInit
+  SetOutPath $INSTDIR
+  LogSet on
+!macroend
+```
+
 #### `windows.nsisInclude` - (optional) string
 
 Example: `build/installer.nsh`.
@@ -826,7 +863,7 @@ module.exports = async ({ appOutDir, packager }) => {
 
 ## FAQs
 
-### One of my dependencies is a private package. How do I safely using it with ToDesktop CLI
+### One of my dependencies is a private package. How do I safely use it with ToDesktop CLI
 
 ToDesktop CLI is similar to Continuous Integration service so you can use the guide from here: https://docs.npmjs.com/using-private-packages-in-a-ci-cd-workflow/
 
@@ -881,8 +918,62 @@ ToDesktop CLI supports the concept of a staging version of your app. This is use
 
 Now you can run `npm run todesktop-build` to build the production app. Or you can run `npm run todesktop-staging-build` to build the staging app.
 
+### I want ToDesktop to compile my typescript/react/whatever on ToDesktop Servers
+
+No problem, this can be achieved with a [`postInstall`](https://docs.npmjs.com/cli/v9/using-npm/scripts) script in combination with ToDesktop's `TODESKTOP_CI` and `TODESKTOP_INITIAL_INSTALL_PHASE` environment variables.
+
+| Name                              | Description                                                                           |
+| --------------------------------- | ------------------------------------------------------------------------------------- |
+| `TODESKTOP_CI`                    | Set to `true` when running on ToDesktop build servers                                 |
+| `TODESKTOP_INITIAL_INSTALL_PHASE` | Set to `true` when running the first npm/yarn/pnpm install on ToDesktop build servers |
+
+First, let's create a file called `todesktop-postinstall.js` or something similar in the root of your app (alongside `pkckage.json`). This file is going to run a script to compile typescript after your dependencies have been installed. It could look something like this
+
+```js
+const { exec } = require("child_process");
+const { promisify } = require("util");
+const execAsync = promisify(exec);
+
+async function postInstall() {
+  const firstInstallOnToDesktopServers =
+    process.env.TODESKTOP_CI && process.env.TODESKTOP_INITIAL_INSTALL_PHASE;
+
+  if (firstInstallOnToDesktopServers) {
+    console.log("➔ Building typescript on ToDesktop servers");
+    await execAsync("npm run build", {
+      stdio: "inherit",
+    });
+  } else {
+    console.log("➔ Not on ToDesktop servers... Do nothing.");
+  }
+}
+
+postInstall();
+```
+
+Next, add the following to your `package.json`:
+
+```js
+{
+  // ...
+  "scripts": {
+    // This is our existing typescript build script
+    "build": "tsc -p .",
+
+    // Our new postinstall script will run the script above when on ToDesktop servers
+    "postinstall": "node todesktop-postinstall.js"
+  }
+}
+```
+
+Now, when we build your app on ToDesktop servers, it will also run your custom `build` script after all dependencies have been installed.
+
 ## Changelog
 
+### v1.6.3
+
+- Add support for specifying custom `windows.nsisCustomBinary` in config
+
 ### v1.6.2
 
 - Add support for specifying custom `nodeVersion` in config