GITBOOK-181: change request with no subject merged in GitBook

SUMMARY.md

@@ -24,7 +24,7 @@
  * [deb](config/makers/deb.md)
  * [DMG](config/makers/dmg.md)
  * [Flatpak](config/makers/flatpak.md)
- * [Pkg](config/makers/pkg.md)
+ * [pkg](config/makers/pkg.md)
  * [RPM](config/makers/rpm.md)
  * [Snapcraft](config/makers/snapcraft.md)
  * [Squirrel.Windows](config/makers/squirrel.windows.md)

config/makers/pkg.md

@@ -1,21 +1,85 @@
 ---
-description: Create a PKG file for your Electron app on macOS using Electron Forge.
+description: Create a .pkg file for your Electron app on macOS using Electron Forge.
 ---
 
-# Pkg
+# pkg
 
-The Pkg target builds `.pkg` files for macOS. These are used to upload your application to the Mac App Store or just as an alternate distribution method for macOS users. You can only build the Pkg target on macOS machines while targeting the `darwin` or `mas` platforms.
+The pkg target builds a `.pkg` installer for macOS. These are used to upload your application to the Mac App Store (MAS), or can be used as an alternate distribution method to users outside of the app store.
 
-Configuration options are documented in [`MakerPkgConfig`](https://js.electronforge.io/interfaces/_electron_forge_maker_pkg.MakerPKGConfig.html).
+<figure><img src="../../.gitbook/assets/image.png" alt=""><figcaption><p>Installation wizard when opening the <code>.pkg</code> installer file</p></figcaption></figure>
 
-### Usage
+This format is often referred to as a **flat package installers** for historical purposes. Prior to Mac OS X Leopard (10.5), installation packages were organized in hierarchical directories. OS X Leopard introduced a new flat package format that is used for modern `.pkg` installers.
 
+The flat installer package format is sparsely documented by Apple. If you want to learn more about its specification, there are a few userland articles available:
+
+* [Flat Package Format - The missing documentation](http://s.sudre.free.fr/Stuff/Ivanhoe/FLAT.html) (Stéphane Sudre)
+* [The Flat Package - Examining a newer package format](https://preserve.mactech.com/articles/mactech/Vol.26/26.02/TheFlatPackage/index.html) (MacTech)
+
+## Usage
+
+{% hint style="warning" %}
+You can only build the pkg target on macOS machines while targeting the `darwin` or `mas` platforms.
+{% endhint %}
+
+To use `@electron-forge/maker-pkg`, add it to the `makers` array in your Forge configuration.
+
+{% code title="forge.config.js" %}
 ```javascript
-{
- name: '@electron-forge/maker-pkg',
- config: {
- keychain: 'my-secret-ci-keychain'
- }
+module.exports = {
+ makers: [
+ {
+ name: '@electron-forge/maker-pkg',
+ config: {
+ keychain: 'my-secret-ci-keychain',
+ // other configuration options
+ },
+ },
+ ];
 }
+
 ```
+{% endcode %}
+
+All configuration options are optional, and options are documented in the API docs for [`MakerPkgConfig`](https://js.electronforge.io/interfaces/\_electron\_forge\_maker\_pkg.MakerPKGConfig.html).
+
+### Installation scripts
+
+With the pkg maker, you can add either a `preinstall` or `postinstall` bash script that runs before and after your app is installed, respectively.
+
+Both `preinstall` and `postinstall` scripts need to:
+
+* have execution permissions
+* be extension-less
+* be located in the same folder in your filesystem
+
+For example, they can live in a folder in your project called `scripts`.
+
+```
+my-app
+├─── forge.config.js
+└─── scripts
+    ├── postinstall
+    └── preinstall
+```
+
+Then, your Forge configuration would need to point to the `./scripts` folder.
+
+<pre class="language-javascript"><code class="lang-javascript">const path = require('node:path');
+
+<strong>module.exports = {
+</strong> makers: [
+ {
+ name: '@electron-forge/maker-pkg',
+ config: {
+ install: path.join(__dirname, 'scripts),
+ },
+ },
+ ];
+}
+</code></pre>
+
+## Debugging
+
+All logs for your flat package installer can be found in macOS installation logs, which are stored in `/var/log/install.log`. They are also accessible within the [Console.app](https://support.apple.com/en-ca/guide/console/welcome/mac) utility.
 
+For advanced debug logging for this maker, add the `DEBUG=electron-osx-sign` environment variable.