Skip to content

Commit

Permalink
Add docs on Snapcraft support
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelmeuli committed Nov 16, 2019
1 parent 2bfa087 commit c0bf6ec
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,24 @@ When you want to create a new release, follow these steps:

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).

## Snapcraft

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:

```yml
- name: Install Snapcraft
uses: samuelmeuli/action-snapcraft@v1
with:
# Log in to Snap Store
snapcraft_token: ${{ secrets.snapcraft_token }}
```

You can read [here](https://github.com/samuelmeuli/action-snapcraft) how to obtain the `snapcraft_token`.

## Example

For an example of the action used in production, see [Mini Diary](https://github.com/samuelmeuli/mini-diary).

## Development

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

0 comments on commit c0bf6ec

Please sign in to comment.