Skip to content

Commit

Permalink
docs: snaps
Browse files Browse the repository at this point in the history
  • Loading branch information
develar committed Dec 24, 2016
1 parent a7aa979 commit a2ca818
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
13 changes: 13 additions & 0 deletions docs/Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Don't customize paths to background and icon, — just follow conventions.
* [.build.publish Bintray](#BintrayOptions)
* [.build.publish Generic (any https server)](#GenericServerOptions)
* [.build.publish GitHub](#GithubOptions)
* [.build.snap](#SnapOptions)
* [.build.squirrelWindows](#SquirrelWindowsOptions)
* [.build.win](#WinBuildOptions)
* [.directories](#MetadataDirectories)
Expand Down Expand Up @@ -269,6 +270,18 @@ Amazon S3 — `https` must be used, so, if you use direct Amazon S3 endpoints, f
| repo | <a name="GithubOptions-repo"></a>The repository name. [Detected automatically](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#github-repository).
| vPrefixedTagName | <a name="GithubOptions-vPrefixedTagName"></a>Whether to use `v`-prefixed tag name. Defaults to `true`.

<a name="SnapOptions"></a>
### `.build.snap`

[Snaps](http://snapcraft.io) specific build options.

| Name | Description
| --- | ---
| confinement | <a name="SnapOptions-confinement"></a>The type of confinement supported by the snap. Can be either `devmode` (i.e. this snap doesn’t support running under confinement) or `strict` (i.e. full confinement supported via interfaces). Defaults to `strict`.
| summary | <a name="SnapOptions-summary"></a>The 78 character long summary. Defaults to [productName](#AppMetadata-productName).
| grade | <a name="SnapOptions-grade"></a><p>The quality grade of the snap. It can be either <code>devel</code> (i.e. a development version of the snap, so not to be published to the “stable” or “candidate” channels) or “stable” (i.e. a stable release or release candidate, which can be released to all channels). Defaults to <code>stable</code>.</p>
| assumes | <a name="SnapOptions-assumes"></a>The list of features that must be supported by the core in order for this snap to install.

<a name="SquirrelWindowsOptions"></a>
### `.build.squirrelWindows`
| Name | Description
Expand Down
7 changes: 6 additions & 1 deletion src/options/linuxOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,14 @@ export interface LinuxBuildOptions extends PlatformSpecificBuildOptions {
readonly executableName?: string | null
}

/*
### `.build.snap`
[Snaps](http://snapcraft.io) specific build options.
*/
export interface SnapOptions extends LinuxBuildOptions {
/*
The type of confinement supported by the snap. Can be either `devmode` (i.e. this snap doesn’t support running under confinement) or `strict` (i.e. full confinement supported via interfaces).
The type of confinement supported by the snap. Can be either `devmode` (i.e. this snap doesn’t support running under confinement) or `strict` (i.e. full confinement supported via interfaces). Defaults to `strict`.
*/
confinement?: "devmode" | "strict" | null

Expand Down

0 comments on commit a2ca818

Please sign in to comment.