28 KiB
28 KiB
Electron Packager: Changes by Version
Unreleased
17.1.2 - 2023-08-18
Fixed
- Added osx-universal flag to usage.txt (#1533)
- Bumped osx-sign to 1.0.5 to fix an entitlement signing error (#1549)
- Ensured logs are quiet when quiet flag is passed (#1440)
- Pruned electron-nightly even if in dependencies (#1538)
- Changed tsdoc to use @link syntax for index.d.ts (#1450)
- Clarified CLI usage (#1534)
- Fixed typos (#1438)
Changed
- Updated Galactus (#1441)
- Updated got to clean up yarn audit (#1456)
- Set @wg-ecosystem as CODEOWNERS (#1471)
- Bumped dependencies to clean yarn audit (#1473)
- Updated GitHub actions workflows (#1475)
Removed
- Removed Linux/ia32 official support (was removed in Electron 19) (#1449)
17.1.1 - 2022-11-01
Fixed
- Fixed an error allowing packaging twice simultaneously (#1439)
17.1.0 - 2022-10-31
Changed
- Replaced
electron-notarizewith@electron/notarize. The configuration options are unchanged. This migration is purely cosmetic. - Added new
afterFinalizePackageTargetshook. This hook exposes the platform/arch combinations that are being packaged when thearch:allorplatform:alloptions are set.
17.0.0 - 2022-10-19
Changed
- BREAKING: Replaced
electron-osx-signwith@electron/osx-sign. The accepted properties on theosxSignoptions object are now slightly different. Please see the migration guide for more information on these changes. (#1428) - Replaced
asarwith@electron/asar. The configuration options are unchanged. This migration is purely cosmetic. (#1431)
Fixed
ElectronAsarIntegrityis now automatically removed from theasaroption is disabled (#1281)
16.0.0 - 2022-08-23
Fixed
- Properly import info logger (#1405)
Changed
- Bump
gotto 2.0.0 (#1397)
Removed
- Node 12 support (#1399)
15.5.2 - 2022-08-22
Fixed
- Package should not log info on
--quietflag - Ignore
node_gyp_binsdirectory if it exists
15.5.1 - 2022-04-20
Fixed
- Univeral builds single-arch components are now built sequentially instead of in parallel to fix race conditions in hooks
- The typescript definition for HookFunction now correctly allows an error to be passed
15.5.0 - 2022-04-19
Added
- New
universalarchitecture supported when packaging for macOS to generate a universal app osxUniveraloption to allow providing options to@electron/universalwhen packaging a universal app
15.4.0 - 2021-09-10
Added
extendHelperInfooption to allow extending helper appInfo.plistfiles (#1233)- Automatically insert
ElectronAsarIntegrityintoInfo.plistfiles (#1279)
Fixed
- Compatibility with
electron-notarize@^1.1.0(#1278)
15.3.0 - 2021-07-17
Added
- Bundled app validation to ensure that both
package.jsonand the main entry point exist (#1257) - Support for customizing Windows targets on darwin/arm64 (#1260)
- Support for customizing Windows targets on WSL without Wine installed (#1260)
15.2.0 - 2020-12-04
Added
- Upgrade
electron-osx-signto 0.5.0 which adds a new option,entitlementsForFile(#1189)
Fixed
- Add package manager lockfiles to default ignore list (#1182)
- Allow checking official builds against prerelease versions (#1191)
15.1.0 - 2020-08-21
Added
- add darwin/arm64 and mas/arm64 as official platform/arch combinations (#1168)
Fixed
- TypeScript: ensure
OsxNotarizeOptionsdefinition contains credentials (#1167)
15.0.0 - 2020-06-27
Added
- mac: app API key notarization (#1127)
- TypeScript definition (#1131)
Changed
- Replace
cross-zipwithextract-zip(#1139)
Removed
- Node < 10 support (#1122)
14.2.1 - 2020-02-07
Fixed
- mac: don't fail if the icon path doesn't exist (#1101)
- win32: correctly catch missing wine exceptions (#1117)
14.2.0 - 2020-01-13
Added
electronZipDiroption (#1094)
14.1.1 - 2019-11-19
Fixed
- Regression that caused the symlink test on Windows to not work as intended (#1071)
- Always initialize proxy support when running the CLI (#1077)
- Clarify the error message when infer cannot find a package.json file (#1079)
- Handle a missing inferred app version better (#1079)
Chores
- Upgrade
electron-notarizeto^0.2.0(#1069)
14.1.0 - 2019-10-28
Added
- (darwin/mas only)
usageDescriptionoption (#1049) - Support for official win32/arm64 builds (#1053)
14.0.6 - 2019-09-09
Fixed
- Send the properly formatted options from the CLI to electron-osx-sign (#1047)
14.0.5 - 2019-08-28
Fixed
- Ensure that CFBundleExecutable and friends are correct for helper apps (#1046)
14.0.4 - 2019-07-30
Fixed
- Packaging apps based on Electron >= 6.0.0 correctly renames and packages the new Electron GPU Helper bundles (#1036)
14.0.3 - 2019-07-18
Fixed
- Packaging Electron 6 based apps now correctly renames and packages the new Electron Helper bundles (#1033)
14.0.2 - 2019-07-18
Fixed
- Warn Windows 7 users of the unzip dependencies (#1030)
14.0.1 - 2019-07-02
Changed
- Upgrade
fs-extrato^8.1.0(#993)
Fixed
- Host info shows OS release
14.0.0 - 2019-06-20
Added
- Ignore system junk files by default (#1005)
Fixed
- Handle inference when
electron-prebuilt-compilepoints to a non-version (#978)
Changed
- Replace
extract-zipwithcross-zip- on macOS/Linux, thezipbinary is required; on Windows, a relatively recent Powershell and .NET runtime is required, seecross-zipfor details (#984) - Convert from
electron-downloadto@electron/get(#1002). Drops support for versions of Electron < 1.3.2, plus all of thedownloadoptions have changed, notably:cacheis nowcacheRootstrictSSLis nowrejectUnauthorized- The
mirrorURL string is now a set of options defined bymirrorOptions quietis removed as the default downloader no longer has a progress bar
- Linux/ia32 support for Electron >= 4 is downgraded to a warning from
@electron/get(#1016)
Removed
- Node < 8 support (#973)
13.1.1 - 2019-03-04
Fixed
- Linux/ia32 is no longer officially supported for Electron >= 4 (#957)
13.1.0 - 2019-02-19
Added
- Support for inferring version from Electron nightlies (#931)
Fixed
- Infer versions from
electron-prebuilt-compilebetter (#932) - Upgrade
asarto^1.0.0, which removes a vulnerable transitive dependency (#952)
13.0.1 - 2018-12-12
Fixed
- Ensure relative out dirs are correctly ignored when copying (#919)
13.0.0 - 2018-12-04
Added
prebuiltAsaroption to specify a prebuilt ASAR file (#823)- support for macOS Mojave app notarization (#899)
Changed
- Dropped support for running on Node < 6.0. (#900)
Removed
- Deprecated target arch APIs (#915)
- The callback version of the API (use
nodeifyif you need that syntax style) (#916)
12.2.0 - 2018-10-02
Added
- darwinDarkModeSupport option to support macOS Mojave dark mode for older Electron versions (#893)
Fixed
- Don't handle EH/NP Helpers if they don't exist (#894)
12.1.2 - 2018-09-12
Fixed
- Prune user-namespaced modules (#889)
12.1.1 - 2018-08-18
Changed
- Host arch utilities moved to electron-download. This is not a breaking change, as the existing API has been kept the same.
Deprecated
hostArchandunameArchinelectron-packager/targets, replaced withhostandunameinelectron-download/lib/arch, respectively
12.1.0 - 2018-05-18
Added
--versionshows the Packager/Node versions & host platform/arch (#841)
Fixed
mips64elarch is only available with Electron 1.8.x (#843)- better detection of node modules (#847)
12.0.2 - 2018-05-02
Fixed
- Support for Node 10 via the CLI (#835)
Deprecated
- The callback version of the API (use
nodeifyif you need that syntax style) (#837)
12.0.1 - 2018-04-10
Fixed
- Upgraded
galactusto^0.2.1to fix a bug with relative paths
12.0.0 - 2018-04-03
Changed
pruneexclusively utilizes thegalactusmodule for pruning devDependencies, instead of depending on package managers (#819)electron-packageris no longer ignored by default (#819)- A warning is emitted when an Electron module is a production dependency (#819)
Removed
packageManageroption (#819)
11.2.1 - 2019-01-02
Fixed
- Don't handle EH/NP Helpers if they don't exist (Backport of #894)
11.2.0 - 2018-03-24
Added
- Utility function to execute hooks serially (#814)
11.1.0 - 2018-03-04
Added
- Support for MAS Login Helper (Electron 2.0.0-beta.1 and above) (#807)
11.0.1 - 2018-02-12
Fixed
rceditmodule updated to 1.0.0, which fixes some bugs (#804)--helpprints usage to stdout (#805)
11.0.0 - 2018-02-06
Added
linuxplatform,mips64elarch builds (Electron 1.8.2-beta.5 and above) (#800)
Changed
allorplatform=linux, arch=allnow includearch=mips64elif the Electron version specified is 1.8.2-beta.5 or above (#800)
10.1.2 - 2018-01-26
Fixed
overwrite: truewhen no platform/arch is specified (#794)
10.1.1 - 2018-01-02
Fixed
- ARM detection with prebuilt armv7l Node.js (#783)
- Don't create
yarn.lockwhen pruning with Yarn (#784)
10.1.0 - 2017-11-19
Added
- Option to set the executable name separate from the app name (#758)
Fixed
mzdependency (#759)
10.0.0 - 2017-11-19
Changed
- Switch from
minimisttoyargs-parser(#732) - Electron Packager only officially supports Node versions that are supported by the NodeJS team (#747)
- Refactor to use
Promises internally. This has the side effect of somewhat parallelizing building two or more targets at once and/or two or more functions for a given hook, viaPromise.all(#753)
9.1.0 - 2017-09-15
Added
hostArch()andallOfficialArchsForPlatformAndVersion()(#727)
Changed
- CLI arguments with nonstandard argument values emit warnings (#722)
Deprecated
- In the CLI,
--tmpdir=falsehas been deprecated in favor of--no-tmpdir(#722)
9.0.1 - 2017-09-02
Fixed
- Inferring
win32metadata.CompanyNamefromauthorinpackage.jsonwhen it's an Object (#718)
9.0.0 - 2017-08-23
Added
- API hook for afterPrune (#677)
- Package manager-agnostic pruning support (set
packageManagertofalse) (#690) linuxplatform,arm64arch builds (Electron 1.8.0 and above) (#711)
Changed
- Promise support for
packager- function returns a Promise instead of the return value of the callback (#658) win32metadata.CompanyNamedefaults toauthorname from nearestpackage.json(#667)win32metadata.FileDescriptiondefaults toproductNameornamefrom nearestpackage.json(#667)win32metadata.OriginalFilenamedefaults to renamed.exe(#667)win32metadata.ProductNamedefaults toproductNameornamefrom nearestpackage.json(#667)win32metadata.InternalNamedefaults toproductNameornamefrom nearestpackage.json(#667)- Warn when downloading from the official Electron releases and the arch/platform combination specified is invalid (#562)
- Do not error out immediately if a
download.mirroris specified and an unofficial arch/platform is specified (#670) - Allow spaces when specifying archs/platforms as a string, rather than an array (#487)
- The
extraResourceoption works on all target platforms (#637) allorplatform=linux, arch=allnow includearch=arm64if the Electron version specified is 1.8.0 or above (#711)
Fixed
common.warningfor codesigning (#694)
Removed
versionis removed in favor ofelectronVersion(CLI:--electron-version) (#665)version-stringis removed in favor ofwin32metadata(#668)- Options set via the JavaScript API formatted in kebab-case (i.e., with hyphens) are removed in favor of their camelCase variants, per JavaScript naming standards (#669)
8.7.2 - 2017-06-25
Fixed
- Stop yarn creating
.binfolders when pruning (#678)
8.7.1 - 2017-06-05
Fixed
- Usage docs for
win32metadata.application-manifestandwin32metadata.requested-execution-level
8.7.0 - 2017-05-01
Added
packageManager(--package-managervia CLI) option (#618)win32metadata.application-manifestoption (#610)win32metadata.requested-execution-leveloption (#610)
Fixed
- Support for
extract-zip>= 1.6.1
8.6.0 - 2017-03-14
Added
- Limited support for electron-prebuilt-compile (#608)
Changed
- Options formatted in kebab-case (i.e., with hyphens) are available in camelCase, per JavaScript naming standards (#580)
- rcedit upgraded to 0.8.0
Deprecated
- Options formatted in kebab-case (i.e., with hyphens) are deprecated in favor of their camelCase variants, per JavaScript naming standards (#580)
8.5.2 - 2017-02-19
Fixed
- Prepend all warning messages with "WARNING:" (#593)
- Ignore the generated temporary directory on Linux (#596)
- Prevent app names from ending in " Helper" (#600)
8.5.1 - 2017-01-22
Fixed
- Show CLI option when showing option deprecation message (#560)
8.5.0 - 2017-01-10
Added
electronVersion(--electron-versionvia CLI) option (#547)
Deprecated
versionis deprecated in favor ofelectronVersion(--electron-versionvia CLI) (#547)
8.4.0 - 2016-12-08
Added
quietoption (#541)
Fixed
- Better type checking when validating arch/platform (#534)
8.3.0 - 2016-11-16
Changed
- Upgrade to electron-osx-sign 0.4.x (#384)
Fixed
- Clarify symlink error message for Windows
8.2.0 - 2016-10-29
Added
- Allow
extend-infoto specify an object instead of a filename (#510)
Fixed
- Retrieving metadata from
package.jsonby upgradingget-package-info(#505) - Typo when using
extend-info(#510)
8.1.0 - 2016-09-30
Added
.oand.objfiles are ignored by default (#491)- Electron downloads are now checked against their published checksums (#493)
- Documentation for
download.quietoption to enable/disable progress bar (#494) - The
build-versionproperty, when unspecified, now defaults to theapp-versionproperty value on Windows (#501)
8.0.0 - 2016-09-03
Added
win32metadataoption (#331, #463)linuxplatform,armv7larch support (#106, #474)
Changed
allnow includes thelinuxplatform,armv7larch combination- Default the
platformoption to the host platform (#464) - Default the
archoption to the host arch (#36, #464) - Default the
pruneoption totrue(#235, #472)
Fixed
- Allow scoped package names as Electron app names - invalid characters are replaced with hyphens (#308, #455)
Deprecated
version-stringis deprecated in favor ofwin32metadata(#331, #463)
Removed
asar-unpackis removed in favor ofasar.unpackasar-unpack-diris removed in favor ofasar.unpackDircacheis removed in favor ofdownload.cachestrict-sslis removed in favor ofdownload.strictSSL
7.7.0 - 2016-08-20
Added
- The
package.jsonversionproperty is the default app version if--app-versionis unspecified (#449)
Changed
- [darwin/mas] Explicitly disallow
osx-sign.binaries(#459)
7.6.0 - 2016-08-14
Added
- [API] hook for afterCopy (#448)
- [darwin/mas] Documentation for
protocolandprotocol-nameoptions (#121, #450)
Changed
- [CLI] Minimum Node version is enforced (#454)
Fixed
- [CLI] ensure --out has either a string or null value (#442)
- Use
get-package-info(again) to support finding prebuilt in parent directories (#445)
7.5.1 - 2016-08-06
Fixed
- Resolve to absolute path when inferring app name/Electron version (#440)
7.5.0 - 2016-08-04
Added
- Support the new
electronpackage name (#435)
7.4.0 - 2016-07-31
Added
- Basic debugging messages via the
debugmodule - see CONTRIBUTING.md for usage (#433)
Changed
- Clearer error message when inferring the app name and/or Electron version fails
Fixed
- (Test) apps named "Electron" can be packaged successfully (#415)
7.3.0 - 2016-07-10
Added
asaroptions can be specified as anObject(via the API) or with dot notation (via the CLI) - see the respective docs for details (#353, #417)
Deprecated
asar-unpackis deprecated in favor ofasar.unpack(#417)asar-unpack-diris deprecated in favor ofasar.unpackDir(#417)
7.2.0 - 2016-07-03
Added
derefSymlinksoption (#410)
Fixed
- Clarified message when
wineis not found (#357)
7.1.0 - 2016-06-22
Added
- Add
afterExtracthook (#354, #403)
7.0.4 - 2016-06-14
Fixed
- Clarified app name/Electron version error message (#390)
7.0.3 - 2016-05-31
Changed
- [contributors] Code contributions need to be validated in "strict" mode (#342, #351)
Fixed
- CLI output truncated when using Node 6 (and possibly earlier) (#381)
7.0.2 - 2016-05-18
Fixed
- The default
.gitignore only ignores that directory (#344) - Specifying the
download.strictSSLCLI parameter no longer triggers a deprecation warning forstrict-ssl(#349)
7.0.1 - 2016-04-21
Fixed
- Not specifying
strict-sslCLI parameter no longer triggers a deprecation warning (#335)
7.0.0 - 2016-04-17
Added
- Add
downloadparameter (#320)
Changed
- Dropped support for running on Node < 4.0. (#319)
Fixed
strict-ssl(and by extension,download.strictSSL) defaults totrue, as documented (#320)
Deprecated
cacheis deprecated in favor ofdownload.cache(#320)strict-sslis deprecated in favor ofdownload.strictSSL(#320)
Removed
- [win32]
version-string.FileVersionandversion-string.ProductVersionare replaced by favor ofapp-versionandbuild-version, respectively (#327) - [win32]
version-string.LegalCopyrightis replaced byapp-copyright(#327)
6.0.2 - 2016-04-09
Changed
- [win32]
rceditdependency updated to 0.5.x. The DLL mentioned in the 6.0.1 release notes is no longer required.
6.0.1 - 2016-04-08
Changed
- [win32]
rceditdependency updated to 0.4.x. A new DLL is required to run the new version of rcedit, please see the documentation for details - API documentation moved from readme.md to docs/api.md (#296)
Fixed
- [darwin/mas] The OSX icon is properly replaced when Electron ≥ 0.37.4 is used (#301)
default_app.asaris deleted during packaging (necessary when Electron ≥ 0.37.4 is used). Thedefault_appfolder is still deleted for older Electron versions (#298, #311)
6.0.0 - 2016-03-28
Added
- Add support for a new target platform, Mac App Store (
mas), including signing OS X apps (#223, #278) - Add
app-copyrightparameter (#223) - Add
tmpdirparameter to specify a custom temp directory (#230); set tofalseto disable using a temporary directory at all (#251, #276) - Add
NEWS.md, a human-readable list of changes in each version (since 5.2.0) (#263)
Changed
- The GitHub repository has been moved into an organization, electron-userland
- Allow the
ignoreparameter to take a function (#247) - [contributors] Update Standard (JavaScript coding standard) package to 5.4.x
- [contributors] Add code coverage support via Coveralls (#257)
- Better docs around contributing to the project (#258)
- Ignore the directory specified by the
outparameter by default (#255) - [darwin/mas] Add support for merging arbitrary plist files and adding arbitrary resource files (#253)
- Split out the code to sign OS X apps into a separate Node module, electron-osx-sign (#223)
- [darwin/mas] BREAKING: The
signparameter is nowosx-sign(for better cross-platform compatibility) and optionally takes several of the same sub-parameters as electron-osx-sign (#286)
Deprecated
- [win32]
version-string.LegalCopyrightis deprecated in favor ofapp-copyright(#268)
Fixed
-
[darwin/mas] Ensure
CFBundleVersionandCFBundleShortVersionStringare strings (#250) -
[darwin/mas] Correctly set the helper bundle ID in all relevant plist files (#223)
-
[darwin/mas] OSX-specific binaries are correctly renamed to the application name (#244, #293)
If you are upgrading from ≤ 5.2.1 and building for a
darwintarget, you may experience problems. See #323 for details.
5.2.1 - 2016-01-17
Changed
- [win32] Add support for Windows for the
app-versionandbuild-versionparameters (#229) - If
appnameand/orversionare omitted from the parameters, infer frompackage.json(#94)
Deprecated
- [win32]
version-string.FileVersionandversion-string.ProductVersionare deprecated in favor ofapp-versionandbuild-version, respectively (#229)
Fixed
- Remove
default_appfrom built packages (#206) - Add documentation for optional arguments (#226)
- [darwin] Don't declare helper app as a protocol handler (#220)
5.2.0 - 2015-12-16
Added
- Add
asar-unpack-dirparameter (#174) - [darwin] Add
app-category-typeparameter (#202) - Add
strict-sslparameter (#209)
Changed
- Ignore
node_modules/.binby default (#189)
For versions prior to 5.2.0, please see git log.