forge

What's Changed

Fixes

• fix: ensure webpack typescript template runs by @MarshallOfSound in https://github.com/electron/forge/pull/3038

Other Changes

• chore(utils): make require-search error message clearer by @erickzhao in https://github.com/electron/forge/pull/3037

Full Changelog: https://github.com/electron/forge/compare/v6.0.0-beta.72...v6.0.0-beta.73

What's Changed

Other Changes

• build: modify ts-ignore for /test & /src by @VerteDinde in https://github.com/electron/forge/pull/3036

Full Changelog: https://github.com/electron/forge/compare/v6.0.0-beta.71...v6.0.0-beta.72

What's Changed

Fixes

• fix: restore isProd in the webpack plugin by @MarshallOfSound in https://github.com/electron/forge/pull/3021
• fix: use @electron-forge/cli hint for project resolution by @MarshallOfSound in https://github.com/electron/forge/pull/3023
• fix(template-base): use minimum instead of exact version when replacing ELECTRON_FORGE/VERSION in templates by @erikian in https://github.com/electron/forge/pull/3030
• fix(publish): ignore unnecessary files when publishing to npm by @erikian in https://github.com/electron/forge/pull/3024
• fix(packager): "packaging application" log never stops when building for multiple architectures by @macdja38 in https://github.com/electron/forge/pull/3006

Other Changes

• build: remove travis and appveyor ci templates by @VerteDinde in https://github.com/electron/forge/pull/3034
• chore: move from electron-rebuild to @electron/rebuild by @MarshallOfSound in https://github.com/electron/forge/pull/3033
• chore: rename typescript-webpack to webpack-typescript by @georgexu99 in https://github.com/electron/forge/pull/3035
• chore: update README.md by @VerteDinde in https://github.com/electron/forge/pull/3025
• docs: update release process by @georgexu99 in https://github.com/electron/forge/pull/3032
• test: add test to detect forge.config by @VerteDinde in https://github.com/electron/forge/pull/3031
• refactor: use listr2 instead of async-ora by @MarshallOfSound in https://github.com/electron/forge/pull/3022
• refactor: use forge.config.ts in the webpack typescript template by @MarshallOfSound in https://github.com/electron/forge/pull/3012

New Contributors

• @macdja38 made their first contribution in https://github.com/electron/forge/pull/3006

Full Changelog: https://github.com/electron/forge/compare/v6.0.0-beta.70...v6.0.0-beta.71

What's Changed

• docs: generate custom docs sidebar by @VerteDinde in https://github.com/electron/forge/pull/2974
• refactor: add / use named exports for plugins + makers + publishers by @MarshallOfSound in https://github.com/electron/forge/pull/2996
• docs: add READMEs to packages by @georgexu99 in https://github.com/electron/forge/pull/2986
• chore: upgrade electron-wix-msi to 4.0.0 by @georgexu99 in https://github.com/electron/forge/pull/3003
• build: fix some yarn audit output by @MarshallOfSound in https://github.com/electron/forge/pull/3002
• refactor(maker-squirrel): ensure Squirrel.Windows name doesn't contain hyphens by @erickzhao in https://github.com/electron/forge/pull/3004
• chore: bump electron-wix-msi to 5.0.0 by @VerteDinde in https://github.com/electron/forge/pull/3008
• chore: fix links from userland migration by @georgexu99 in https://github.com/electron/forge/pull/3010
• Release 6.0.0 beta.69 by @VerteDinde in https://github.com/electron/forge/pull/3011
• fix(template-typescript-webpack): clean up forge config code by @erickzhao in https://github.com/electron/forge/pull/3009
• fix(template-typescript-webpack): webpack entrypoint extensions by @erickzhao in https://github.com/electron/forge/pull/3014
• fix(template-typescript-webpack): properly load forge.config.ts by @erickzhao in https://github.com/electron/forge/pull/3016
• build: add icon property to MakerWixConfig by @VerteDinde in https://github.com/electron/forge/pull/3017

Full Changelog: https://github.com/electron/forge/compare/v6.0.0-beta.69...v6.0.0-beta.70

What's Changed

Breaking Changes

• feat!: prefer forge.config.js over package.json config by @erickzhao in https://github.com/electron/forge/pull/2991
• refactor!: better internal type safety for hooks by @MarshallOfSound in https://github.com/electron/forge/pull/2995

Features

• feat(plugin-webpack): support standalone preload entry points by @erickzhao in https://github.com/electron/forge/pull/2950
• feat: add support for forge.config.ts et. al by @MarshallOfSound in https://github.com/electron/forge/pull/2993
• feat(publisher-s3): Add sessionToken and change default fallback by @bboure in https://github.com/electron/forge/pull/2984

Other Changes

• fix(plugin-webpack): keep devDependencies, dependencies, optionalDependencies and peerDependencies in the distributed package.json by @erikian in https://github.com/electron/forge/pull/3007
• fix(template-typescript-webpack): use new plugin syntax by @georgexu99 in https://github.com/electron/forge/pull/2989
• fix(template-webpack): use new plugin syntax by @georgexu99 in https://github.com/electron/forge/pull/2990
• build: configure import/order eslint rule by @MarshallOfSound in https://github.com/electron/forge/pull/2997
• build: actually enable husky/lint-staged by @MarshallOfSound in https://github.com/electron/forge/pull/2999
• build: add rule that enforces named exports over default exports by @MarshallOfSound in https://github.com/electron/forge/pull/3000
• refactor: rename some constructor params for MakerBase and PublisherBase by @MarshallOfSound in https://github.com/electron/forge/pull/2994

New Contributors

• @bboure made their first contribution in https://github.com/electron/forge/pull/2984

Full Changelog: https://github.com/electron/forge/compare/v6.0.0-beta.68...v6.0.0-beta.69

What's Changed

Breaking Changes

Forge v6.0.0-beta.68 introduces a few breaking changes to the Forge config.

Renamed Electron Rebuild config (https://github.com/electron-userland/electron-forge/pull/2963)

For consistency with the packagerConfig option for electron-packager, the field to configure electron-rebuild has now been shortened to rebuildConfig.

{
-  electronRebuildConfig: { /* ... */ }
+  rebuildConfig: { /* ... */ }
}

Changed plugin configuration syntax (https://github.com/electron-userland/electron-forge/pull/2963)

The plugins array now takes objects containing an object with properties name and config, rather than tuples containing the plugin name and config.

This aligns the syntax for this configuration with the publishers and makers arrays.

{
  plugins: [
-      [
-        '@electron-forge/plugin-webpack',
-        { /* ... */ }
-      ]
+
+      {
+        name: '@electron-forge/plugin-webpack',
+        config: { /* ... */ }
+      }
 ]
}

Upgraded Package dependency to electron-packager@17 (https://github.com/electron-userland/electron-forge/pull/2978)

The upgrade to Electron Packager 17 introduces the shiny new @electron/osx-sign package for macOS code signing. It's a rewrite of the old electron-osx-sign tool with more sensible defaults.

To migrate, we recommend seeing if the default packagerConfig.osxSign options work for you and tweaking the default entitlements to your needs. Otherwise, see the @electron/osx-sign MIGRATION.md doc for a 1:1 conversion from the old config options to the new ones.

Fixes

• fix(plugin-webpack): better webpack-dev-server types by @erickzhao in https://github.com/electron-userland/electron-forge/pull/2952

Other Changes

• feat(maker-pkg): upgrade to @electron/osx-sign by @erickzhao in https://github.com/electron-userland/electron-forge/pull/2959
• build(deps): npx browserslist@latest --update-db by @erickzhao in https://github.com/electron-userland/electron-forge/pull/2962

New Contributors

• @georgexu99 made their first contribution in https://github.com/electron-userland/electron-forge/pull/2946

Full Changelog: https://github.com/electron-userland/electron-forge/compare/v6.0.0-beta.67...v6.0.0-beta.68

What's Changed

• fix(template-typescript-webpack): preload file to webpack config by @fredrikj31 in https://github.com/electron-userland/electron-forge/pull/2936
• feat: remove preload.js from TypeScript templates by @itsananderson in https://github.com/electron-userland/electron-forge/pull/2938
• chore: update electron-packager to v16 by @erikian in https://github.com/electron-userland/electron-forge/pull/2927

New Contributors

• @fredrikj31 made their first contribution in https://github.com/electron-userland/electron-forge/pull/2936
• @itsananderson made their first contribution in https://github.com/electron-userland/electron-forge/pull/2938
• @erikian made their first contribution in https://github.com/electron-userland/electron-forge/pull/2927

Full Changelog: https://github.com/electron-userland/electron-forge/compare/v6.0.0-beta.66...v6.0.0-beta.67

What's Changed

• feat(plugin-webpack): Allow each entrypoint to specify nodeIntegration by @chetbox in https://github.com/electron-userland/electron-forge/pull/2867
• build: update @electron/get to 2.0.0 by @VerteDinde in https://github.com/electron-userland/electron-forge/pull/2924

New Contributors

• @chetbox made their first contribution in https://github.com/electron-userland/electron-forge/pull/2867

Full Changelog: https://github.com/electron-userland/electron-forge/compare/v6.0.0-beta.65...v6.0.0-beta.66

Bug Fixes

• add missing exports from packages (#2920) (460546b7)
• keep stdin unpaused after ora completes (#2904) (aad9c7e4)

Chores

• upgrade Node.js to 14 LTS (#2921) (4dcca1ce)

New Features

• cli: add --inspect-brk-electron option (#1328) (c5a6ea17)
• maker: allow disabling maker in config (#2754) (69777402)
• maker-wix: Make autoUpdate and autoLaunch features configurable in MakerWixConfig (#2620) (bf7d271a)
• publisher-ers: support flavor config (#2766) (6069ebe1)
• publisher-github: allow specifying alternative tag prefix (#2605) (88d9d722)
• template: add a default preload script (#2722) (636e2c5d)
• plugin-webpack:
  • allow specifing a seperate webpack config for your preload (#2679) (f5909424)
  • webpack 5 configuration factory (#2776) (f4a77741)
  • Add packageSourceMaps option to WebpackPluginConfig (#2581) (2bb5e0d8)

Bug Fixes

• make: escape file names for make step (#2752) (beb93056)
• v5 upgrade: default platforms to empty array instead of null (9abc581b)
• publisher-ers:
  • set knownLength option for asset upload (#2706) (cf08cd62)
  • omit RELEASES file when uploading assets (#2089) (2202dcd3)

Bug Fixes

• cli: re-add shebang to electron-forge binary (#2671) (1ca418ec)

New Features

• publisher-github: add retry support (#2550) (a400066d)

Bug Fixes

• replace colors with chalk (#2666) (e909ae83)
• plugin-webpack:
  • rebuild native modules before packaging (#2584) (21310bbf)
  • validate that the correct entry point is used (#2522) (3de904b6)

New Features

• publisher-github: add debug support for Octokit (#2499) (73252c30)

Bug Fixes

• unpin electron-notarize (#2515) (af78353b)

Breaking Changes

• core: add required Forge version for templates (#2415) (c094d168)

New Features

• plugin-webpack: allow most webpack-dev-server options to be configurable (#2444) (699d4862)
• deps: upgrade to electron-rebuild@^3.1.1 (#2434) (60778998)

Bug Fixes

• core:
  • better errors when maker names are invalid (#2467) (ca41d9ba)
  • add support for finding electron for npm 7 workspaces (#2446) (4c601519)
• plugin-webpack:
  • fix deprecation warnings for [email protected] (#2457) (99797449)
  • don't specify resolve.modules by default (#2149) (4a992b76)
  • don't show the error message if packagerConfig.ignore is a function (#2424) (4b4f16c3)
• template-webpack: only use node-loader if the .node files are in native_modules/ (#2449) (bd2526b3)
• maker-dmg: add the arch to the default dmg name (#2431) (0c65f17d)

Fixed

• template-typescript-webpack: lint tsx files by default (#2403) (c2e6c49f)
• template: add plugin:import/electron to TypeScript ESLint config (#2399) (f42c962a)
• webpack-plugin: Ensure asset relocator injected code works with nodeIntegration disabled (#2396) (146fc311)

New Features

• plugin-webpack:
  • improve native asset relocation without forking Vercel loader (#2320)
  • add devContentSecurityPolicy config option (#2332)
  • add nodeIntegration config for renderers (#2330)
• core: add platform and arch to generateAssets hook parameters (#2327)

Bug Fixes

• core: search for electron in a node_modules folder with electron in it (#2326)
• plugin-electronegativity: add parserPlugins option (#2323)
• plugin-webpack: throw error if something bad happened in preload compilation (#2334)
• maker-squirrel: use executableName for exe when available (#2365)

Migration Notes

• Due to the new devContentSecurityPolicy, existing projects using Webpack may have to specify a CSP in development.
• Existing projects using Webpack and nodeIntegration: true will have to also set nodeIntegration in the Webpack plugin config.
• Existing projects using Webpack should replace @marshallofsound/webpack-asset-relocator-loader with @vercel/webpack-asset-relocator-loader.

Bug Fixes

• webpack-plugin: add web as a target for the renderer process (#2285) (9f2bc411)

Breaking Changes

• Require Node >= 12.13.0 for all packages (#2281) (8fbbad24)
• webpack-plugin: upgrade to Webpack 5 (#2225) (564a4451)

Bug Fixes

• plugin-local-electron: bind methods correctly (#2280) (e60445d7)

Build dependencies

• Upgrade electron-winstaller to ^5.0.0 (https://github.com/electron-userland/electron-forge/commit/e93631a39ac30b36a7239c28ad97a27974318a12)

Bug fixes

• core: better error detection for electron-prebuilt-compile (#2268) (fdc82117)
• template/typescript-webpack:
  • magic constant is a string w/comments about what it's for (#2166) (f15b5c7a)
  • add ts/tsx to known eslint-plugin-import extensions (#2139) (90f122c2)
• plugin-webpack: correctly define the asset relocator base dir (#2022) (390219fd)
• template-typescript: add eslint-plugin-import/typescript rules (#2048) (c27ca4bf)
• cli: don't hardcode the minimum required Node version (#2003) (704db4b1)

Fixed

• publisher-github:
  • use new @octokit .auth property (#1989) (dae97c40)
  • don't reexport Octokit type (#1962) (af79fa1c)
• core: init should install the latest caret version of Forge (#1963) (b1693f09)