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

Commit c0bf6ec

Browse files
committed
Add docs on Snapcraft support
1 parent 2bfa087 commit c0bf6ec

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

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

8181
After building successfully, the GitHub action will then 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
84+
85+
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 by adding an `action-snapcraft` step before the `action-electron-builder` step:
86+
87+
```yml
88+
- name: Install Snapcraft
89+
uses: samuelmeuli/action-snapcraft@v1
90+
with:
91+
# Log in to Snap Store
92+
snapcraft_token: ${{ secrets.snapcraft_token }}
93+
```
94+
95+
You can read [here](https://github.com/samuelmeuli/action-snapcraft) how to obtain the `snapcraft_token`.
96+
97+
## Example
98+
99+
For an example of the action used in production, see [Mini Diary](https://github.com/samuelmeuli/mini-diary).
100+
83101
## Development
84102

85103
Suggestions and contributions are always welcome! Please discuss larger changes via issue before submitting a pull request.

0 commit comments

Comments
 (0)