Skip to content

Commit 00f0338

Browse files
feat: MSIX maker doc (#239)
Co-authored-by: Erick Zhao <[email protected]>
1 parent 6197a50 commit 00f0338

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

config/makers/msix.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
description: >-
3+
Create a MSIX package that can be shipped as a direct download or to the Microsoft Store for your Electron app, using Electron
4+
Forge.
5+
---
6+
7+
# MSIX
8+
9+
{% hint style="info" %}
10+
11+
MSIX support was added in Electron Forge v7.10 and is currently **experimental**. Breaking changes to the configuration may be introduced between releases.
12+
13+
{% endhint %}
14+
15+
The [MSIX](https://learn.microsoft.com/en-us/windows/msix/overview) target builds `.msix` packages, which can be directly distributed to end user or to the [Microsoft Store](https://apps.microsoft.com/home).
16+
17+
## Requirements
18+
19+
You can only build the MSIX target on Windows 10 or 11 machines with the [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/) installed. Check the [`electron-windows-msix` docs](https://github.com/bitdisaster/electron-windows-msix) for more information on platform requirements.
20+
21+
## Installation
22+
23+
```bash
24+
npm install --save-dev @electron-forge/maker-msix
25+
```
26+
27+
## Usage
28+
29+
To use `@electron-forge/maker-msix`, add it to the `makers` array in your [Forge configuration](../configuration.md):
30+
31+
{% code title="forge.config.js" %}
32+
33+
```javascript
34+
module.exports = {
35+
makers: [
36+
{
37+
name: '@electron-forge/maker-msix',
38+
config: {
39+
manifestVariables: {
40+
publisher: 'Electron Dev'
41+
},
42+
windowsSignOptions: {
43+
certificateFile: 'C:\\devcert.pfx',
44+
certificatePassword: '122345'
45+
}
46+
}
47+
}
48+
]
49+
};
50+
```
51+
52+
{% endcode %}
53+
54+
Configuration options are documented in [`MakerMSIXConfig`](https://js.electronforge.io/types/_electron_forge_maker_msix.MakerMSIXConfig.html).
55+
56+
For advanced code-signing use-cases, this maker utilizes @electron/windows-sign via the `windowsSignOptions` property. see the [windows-sign](https://github.com/electron/windows-sign/blob/main/README.md) README for more details.
57+
58+
## Debugging
59+
60+
For advanced debug logging for this maker, add the `DEBUG=electron-windows-msix*` environment variable
61+
or set the `logLevel` to `debug` in the maker config.

0 commit comments

Comments
 (0)