Skip to content
This repository was archived by the owner on Oct 13, 2024. It is now read-only.

Commit 5e5ae4d

Browse files
committed
Update README
1 parent c39fef6 commit 5e5ae4d

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,18 @@ When you want to create a new release, follow these steps:
8080

8181
After building successfully, the action will publish your release artifacts. By default, a new release draft will be created on GitHub with download links for your app. If you want to change this behavior, have a look at the [`electron-builder` docs](https://www.electron.build).
8282

83-
## Snapcraft
83+
## Configuration
84+
85+
### Options
86+
87+
In addition to the options mentioned above, the following input variables can be set:
88+
89+
- `app_root`: Directory where `electron-builder` commands should be run (default: repository root)
90+
- `package_root`: Directory where NPM/Yarn commands should be run (default: repository root)
91+
92+
See [`action.yml`](./action.yml) for a list of all possible input variables.
93+
94+
### Snapcraft
8495

8596
If you are building/releasing your Linux app for Snapcraft (which is `electron-builder`'s default), you will additionally need to install and sign in to Snapcraft. This can be done using an `action-snapcraft` step before the `action-electron-builder` step:
8697

@@ -96,9 +107,13 @@ If you are building/releasing your Linux app for Snapcraft (which is `electron-b
96107

97108
You can read [here](https://github.com/samuelmeuli/action-snapcraft) how you can obtain a `snapcraft_token`.
98109

99-
## Example
110+
For an example of the action used in production with Snapcraft publishing configured, see [Mini Diary](https://github.com/samuelmeuli/mini-diary).
111+
112+
### Notarization
113+
114+
The author of `electron-builder` [hinted](https://github.com/electron-userland/electron-builder/issues/3870#issuecomment-495885439) that in the future, app notarization for macOS might be provided out of the box. It therefore falls out of the scope of this action.
100115

101-
For an example of the action used in production (including app notarization and publishing to Snapcraft), see [Mini Diary](https://github.com/samuelmeuli/mini-diary).
116+
For an example of the action used in production with app notarization configured, see [Mini Diary](https://github.com/samuelmeuli/mini-diary).
102117

103118
## Development
104119

0 commit comments

Comments
 (0)