Skip to content

Commit

Permalink
refactor: merge electron-builder-core into electron-builder, transfor…
Browse files Browse the repository at this point in the history
…m node-gyp-rebuild bin to subcommand

BREAKING CHANGE: Please use `node-gyp-rebuild` as `electron-buider node-gyp-rebuild` now
  • Loading branch information
develar committed Jun 16, 2017
1 parent 666dec7 commit a8c9ffd
Show file tree
Hide file tree
Showing 55 changed files with 378 additions and 540 deletions.
1 change: 0 additions & 1 deletion docs/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
**Programmatic API**

* [[electron-builder]]
* [[electron-builder-core]]
* [[electron-builder-util]]
* [[electron-builder-http]]
* [[electron-publish]]
Expand Down
6 changes: 3 additions & 3 deletions docs/Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Configuration Options
For example, `"category": "public.app-category.developer-tools"` will set the application category to *Developer Tools*.
Valid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).
* <a name="MacOptions-target"></a>`target` Array&lt;[TargetConfig](electron-builder-core#TargetConfig) | "default" | "dmg" | "mas" | "mas-dev" | "pkg" | "7z" | "zip" | "tar.xz" | "tar.lz" | "tar.gz" | "tar.bz2" | "dir"&gt; | "default" | "dmg" | "mas" | "mas-dev" | "pkg" | "7z" | "zip" | "tar.xz" | "tar.lz" | "tar.gz" | "tar.bz2" | "dir" | [TargetConfig](electron-builder-core#TargetConfig) - The target package type: list of `default`, `dmg`, `mas`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac).
* <a name="MacOptions-target"></a>`target` Array&lt;[TargetConfig](electron-builder#TargetConfig) | "default" | "dmg" | "mas" | "mas-dev" | "pkg" | "7z" | "zip" | "tar.xz" | "tar.lz" | "tar.gz" | "tar.bz2" | "dir"&gt; | "default" | "dmg" | "mas" | "mas-dev" | "pkg" | "7z" | "zip" | "tar.xz" | "tar.lz" | "tar.gz" | "tar.bz2" | "dir" | [TargetConfig](electron-builder#TargetConfig) - The target package type: list of `default`, `dmg`, `mas`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac).
* <a name="MacOptions-identity"></a>`identity` String - The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](https://github.com/electron-userland/electron-builder/wiki/Code-Signing) instead of specifying this option. MAS installer identity is specified in the [mas](#MasBuildOptions-identity).
* <a name="MacOptions-icon"></a>`icon` = `build/icon.icns` String - The path to application icon.
* <a name="MacOptions-entitlements"></a>`entitlements` String - The path to entitlements file for signing the app. `build/entitlements.mac.plist` will be used if exists (it is a recommended way to set). MAS entitlements is specified in the [mas](#MasBuildOptions-entitlements).
Expand Down Expand Up @@ -218,7 +218,7 @@ Configuration Options
* <a name="PkgOptions-artifactName"></a>`artifactName` String - The [artifact file name pattern](https://github.com/electron-userland/electron-builder/wiki/Options#artifact-file-name-pattern).
* <a name="PkgOptions-publish"></a>`publish` String | [GithubOptions](Publishing-Artifacts#GithubOptions) | [S3Options](Publishing-Artifacts#S3Options) | [GenericServerOptions](Publishing-Artifacts#GenericServerOptions) | [BintrayOptions](Publishing-Artifacts#BintrayOptions) | Array
* <a name="Config-win"></a>`win`<a name="WinBuildOptions"></a> - Windows options.
* <a name="WinBuildOptions-target"></a>`target` = `nsis` String | [TargetConfig](electron-builder-core#TargetConfig) | Array - Target package type: list of `nsis`, `nsis-web` (Web installer), `portable` (portable app without installation), `appx`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. AppX package can be built only on Windows 10.
* <a name="WinBuildOptions-target"></a>`target` = `nsis` String | [TargetConfig](electron-builder#TargetConfig) | Array - Target package type: list of `nsis`, `nsis-web` (Web installer), `portable` (portable app without installation), `appx`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. AppX package can be built only on Windows 10.

To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency.
* <a name="WinBuildOptions-signingHashAlgorithms"></a>`signingHashAlgorithms` = `['sha1', 'sha256']` Array&lt;"sha1" | "sha256"&gt; - Array of signing algorithms used. For AppX `sha256` is always used.
Expand Down Expand Up @@ -304,7 +304,7 @@ Configuration Options
* <a name="SquirrelWindowsOptions-useAppIdAsId"></a>`useAppIdAsId` Boolean - Use `appId` to identify package instead of `name`.
* <a name="Config-linux"></a>`linux`<a name="LinuxBuildOptions"></a> - Linux options.
* <a name="LinuxBuildOptions-packageCategory"></a>`packageCategory` String - The [package category](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section). Not applicable for AppImage.
* <a name="LinuxBuildOptions-target"></a>`target` = `AppImage` String | [TargetConfig](electron-builder-core#TargetConfig) | Array - Target package type: list of `AppImage`, `snap`, `deb`, `rpm`, `freebsd`, `pacman`, `p5p`, `apk`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.
* <a name="LinuxBuildOptions-target"></a>`target` = `AppImage` String | [TargetConfig](electron-builder#TargetConfig) | Array - Target package type: list of `AppImage`, `snap`, `deb`, `rpm`, `freebsd`, `pacman`, `p5p`, `apk`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.

electron-builder [docker image](https://github.com/electron-userland/electron-builder/wiki/Docker) can be used to build Linux targets on any platform. See [Multi platform build](https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build). See: [Please do not put an AppImage into another archive like a .zip or .tar.gz](https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages#common-mistake)
* <a name="LinuxBuildOptions-maintainer"></a>`maintainer` String - The maintainer. Defaults to [author](#Metadata-author).
Expand Down
1 change: 0 additions & 1 deletion docs/_Sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
**Programmatic API**

* [[electron-builder]]
* [[electron-builder-core]]
* [[electron-builder-util]]
* [[electron-builder-http]]
* [[electron-publish]]
Expand Down
186 changes: 0 additions & 186 deletions docs/api/electron-builder-core.md

This file was deleted.

Loading

0 comments on commit a8c9ffd

Please sign in to comment.