update

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @electron/wg-ecosystem

.github/workflows/ci.yml

@@ -7,6 +7,7 @@ on:
  tags:
  - v[0-9]+.[0-9]+.[0-9]+*
  pull_request:
+ merge_group:
 
 jobs:
  fast-tests:
@@ -23,13 +24,10 @@ jobs:
  with:
  node-version: 14.x
  cache: yarn
- - name: Install latest NPM on Windows
+ - name: Install npm 8 on Windows
  if: matrix.os == 'windows-latest'
- # See https://github.com/actions/virtual-environments/issues/4856#issuecomment-1043256330
- # and https://github.com/actions/setup-node/issues/411#issuecomment-1051084491
  run: |
- npm install -g npm@8.3.1
- npm install -g npm@latest
+ npm install -g npm@8
  - name: Install
  run: yarn install
  - name: Lint
@@ -54,6 +52,7 @@ jobs:
  if: matrix.os == 'windows-latest'
  shell: bash
  run: |
+ npm install -g npm@8
  echo 'C:\Program Files (x86)\WiX Toolset v3.11\bin' >> $GITHUB_PATH
  npm config set node-gyp "$GITHUB_WORKSPACE\node_modules\node-gyp\bin\node-gyp.js"
  - name: Linux specific setup
@@ -72,10 +71,10 @@ jobs:
  node-version: 14.x
  cache: yarn
  - name: Install
- run: yarn install
+ run: yarn install --frozen-lockfile
  - name: Build
  run: yarn build
  - name: Test
- run: yarn test
+ run: yarn test:slow
  env:
  DEBUG: electron-installer-snap:snapcraft

.github/workflows/semantic.yml

@@ -0,0 +1,26 @@
+name: 'Check Semantic Commit'
+
+on:
+ pull_request_target:
+ types:
+ - opened
+ - edited
+ - synchronize
+
+permissions:
+ contents: read
+
+jobs:
+ main:
+ permissions:
+ pull-requests: read # for amannn/action-semantic-pull-request to analyze PRs
+ statuses: write # for amannn/action-semantic-pull-request to mark status of analyzed PR
+ name: Validate PR Title
+ runs-on: ubuntu-latest
+ steps:
+ - name: semantic-pull-request
+ uses: amannn/action-semantic-pull-request@01d5fd8a8ebb9aafe902c40c53f0f4744f7381eb # tag: v5
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ validateSingleCommit: false

.gitignore

@@ -5,6 +5,7 @@ dist
 docs
 doc
 node_modules
+lerna-debug.log
 yarn-error.log
 packages/**/.npmignore
 packages/**/tsconfig.json

CONTRIBUTING.md

@@ -125,23 +125,38 @@ Here are some things to keep in mind as you file pull requests to fix bugs, add
 - If you are continuing the work of another person's PR and need to rebase/squash, please retain the
  attribution of the original author(s) and continue the work in subsequent commits.
 
-### Release process
-
-- Make sure the tests pass with `yarn test`
-- Run `git clean -fdx` - this will ensure unneeded build files (and potentially sensitive files) are not included in the npm package.
-- Ensure that you are logged into npm via command line (`npm login`)
-- Run `yarn lerna:publish`, which will run the `lerna publish` command with a necessary set of flags.
- - The script will then ask you for your `npm` OTP password.
- - The script will commit the changes automatically. Run `git log` to confirm that the changes have been
- committed.
-- The command will have published your packages to `npm`, and pushed an appropriate tag to github.
-- After running the command, you should have a commit which:
- - Updates the version field in the package.json file
- - Updates the version fields in each of the submodule package.json files
-- Push your commit upstream to the main/default branch.
-- Create a new github release
- - Go to releases tab
- - Draft a new release and choose the appropriate tag
- - Target default branch
- - Generate release notes by copying in CHANGELOG.md contents into the release description or use
- GitHub's [automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)
+## Release process
+
+This guide is for maintainers who have:
+
+- Push access to the `electron/forge` repository.
+- Collaborator access to the `@electron-forge` packages on npm.
+
+### 1. Prepare your local code checkout
+
+- Switch to the tip of the `main` branch with `git switch main && git pull`.
+- Run tests locally with `yarn test`.
+- Check that the latest CI run passed on `main` on [GitHub](https://github.com/electron/forge/actions?query=workflow:CI).
+- Remove all untracked files and directories from your checkout with `git clean -fdx`.
+- Install dependencies with `yarn install`.
+
+### 2. Publish all npm packages
+
+- Log into npm with `npm login`.
+- Run the `yarn lerna:publish` command.
+- Enter your npm account's time-based one-time password (TOTP).
+
+The `lerna:publish` script will automatically increment the next package version based on the
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. From there, it does two things:
+
+1. It creates a tagged commit that bumps the version number in `package.json` at the root and package levels
+ and pushes the commit and tag to GitHub.
+1. It publishes every `@electron-forge/` package to npm.
+
+### 3. Publish release to GitHub
+
+- Go to the repo's [New Release](https://github.com/electron/forge/releases/new) page.
+- Select tag you just published.
+- Target the `main` branch.
+- [Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)
+ against the previous Forge release.

lerna.json

@@ -1,6 +1,6 @@
 {
  "$schema": "node_modules/lerna/schemas/lerna-schema.json",
  "useWorkspaces": true,
- "version": "6.0.4",
+ "version": "6.0.5",
  "npmClient": "yarn"
 }

package.json

@@ -14,12 +14,13 @@
  "docs": "yarn build && yarn docs:generate",
  "docs:generate": "yarn docs:plugin && node --max-old-space-size=8192 -r ts-node/register ./tools/gen-docs.ts",
  "docs:plugin": "cd ./tools/doc-plugin && yarn build",
- "lerna:publish": "lerna publish --force-publish --conventional-commits --no-changelog",
+ "lerna:publish": "lerna publish --force-publish --conventional-commits --no-changelog --exact",
  "lint": "prettier --check . && eslint .",
  "lint:fix": "prettier --write .",
  "link:prepare": "lerna exec -- node ../../../tools/silent.js yarn link --link-folder ../../../.links --silent --no-bin-links",
  "test": "xvfb-maybe cross-env LINK_FORGE_DEPENDENCIES_ON_INIT=1 TS_NODE_PROJECT='./tsconfig.test.json' TS_NODE_FILES=1 mocha './tools/test-globber.ts'",
  "test:fast": "xvfb-maybe cross-env LINK_FORGE_DEPENDENCIES_ON_INIT=1 TS_NODE_PROJECT='./tsconfig.test.json' TEST_FAST_ONLY=1 TS_NODE_FILES=1 mocha './tools/test-globber.ts'",
+ "test:slow": "xvfb-maybe cross-env LINK_FORGE_DEPENDENCIES_ON_INIT=1 TS_NODE_PROJECT='./tsconfig.test.json' TEST_SLOW_ONLY=1 TS_NODE_FILES=1 mocha './tools/test-globber.ts'",
  "postinstall": "rimraf node_modules/.bin/*.ps1 && ts-node ./tools/gen-tsconfigs.ts && ts-node ./tools/gen-ts-glue.ts",
  "prepare": "husky install",
  "preversion": "yarn build"
@@ -78,6 +79,7 @@
  "yarn-or-npm": "^3.0.1"
  },
  "devDependencies": {
+ "@electron/fuses": ">=1.0.0",
  "@knodes/typedoc-plugin-monorepo-readmes": "0.22.5",
  "@malept/eslint-config": "^2.0.0",
  "@types/chai": "^4.2.12",
@@ -151,6 +153,9 @@
  "electron-wix-msi": "^5.0.0",
  "macos-alias": "^0.2.11"
  },
+ "peerDependencies": {
+ "@electron/fuses": ">=1.0.0"
+ },
  "lint-staged": {
  "*.{html,json,md,yml}": "prettier --write",
  "*.{js,ts}": [

packages/api/cli/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@electron-forge/cli",
- "version": "6.0.4",
+ "version": "6.0.5",
  "description": "A complete tool for building modern Electron applications",
  "repository": "https://github.com/electron/forge",
  "author": "Samuel Attard",
@@ -17,8 +17,8 @@
  "mocha": "^9.0.1"
  },
  "dependencies": {
- "@electron-forge/core": "6.0.4",
- "@electron-forge/shared-types": "6.0.4",
+ "@electron-forge/core": "6.0.5",
+ "@electron-forge/shared-types": "6.0.5",
  "@electron/get": "^2.0.0",
  "chalk": "^4.0.0",
  "commander": "^4.1.1",

packages/api/core/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@electron-forge/core",
- "version": "6.0.4",
+ "version": "6.0.5",
  "description": "A complete tool for building modern Electron applications",
  "repository": "https://github.com/electron/forge",
  "main": "dist/api/index.js",
@@ -15,16 +15,16 @@
  "test:slow": "yarn test:base test/slow/**/*_spec_slow.ts"
  },
  "devDependencies": {
- "@electron-forge/maker-appx": "6.0.4",
- "@electron-forge/maker-deb": "6.0.4",
- "@electron-forge/maker-dmg": "6.0.4",
- "@electron-forge/maker-flatpak": "6.0.4",
- "@electron-forge/maker-rpm": "6.0.4",
- "@electron-forge/maker-snap": "6.0.4",
- "@electron-forge/maker-squirrel": "6.0.4",
- "@electron-forge/maker-wix": "6.0.4",
- "@electron-forge/maker-zip": "6.0.4",
- "@electron-forge/test-utils": "6.0.4",
+ "@electron-forge/maker-appx": "6.0.5",
+ "@electron-forge/maker-deb": "6.0.5",
+ "@electron-forge/maker-dmg": "6.0.5",
+ "@electron-forge/maker-flatpak": "6.0.5",
+ "@electron-forge/maker-rpm": "6.0.5",
+ "@electron-forge/maker-snap": "6.0.5",
+ "@electron-forge/maker-squirrel": "6.0.5",
+ "@electron-forge/maker-wix": "6.0.5",
+ "@electron-forge/maker-zip": "6.0.5",
+ "@electron-forge/test-utils": "6.0.5",
  "@types/interpret": "^1.1.1",
  "@types/progress": "^2.0.5",
  "@types/rechoir": "^0.6.1",
@@ -40,14 +40,14 @@
  "yaml-hook": "^1.0.0"
  },
  "dependencies": {
- "@electron-forge/core-utils": "6.0.4",
- "@electron-forge/maker-base": "6.0.4",
- "@electron-forge/plugin-base": "6.0.4",
- "@electron-forge/publisher-base": "6.0.4",
- "@electron-forge/shared-types": "6.0.4",
- "@electron-forge/template-base": "6.0.4",
- "@electron-forge/template-webpack": "6.0.4",
- "@electron-forge/template-webpack-typescript": "6.0.4",
+ "@electron-forge/core-utils": "6.0.5",
+ "@electron-forge/maker-base": "6.0.5",
+ "@electron-forge/plugin-base": "6.0.5",
+ "@electron-forge/publisher-base": "6.0.5",
+ "@electron-forge/shared-types": "6.0.5",
+ "@electron-forge/template-base": "6.0.5",
+ "@electron-forge/template-webpack": "6.0.5",
+ "@electron-forge/template-webpack-typescript": "6.0.5",
  "@electron/get": "^2.0.0",
  "@electron/rebuild": "^3.2.10",
  "@malept/cross-spawn-promise": "^2.0.0",

packages/api/core/src/api/import.ts

@@ -66,7 +66,7 @@ export default async ({
  collapseErrors: false,
  },
  rendererSilent: !interactive,
- rendererFallback: Boolean(process.env.DEBUG && process.env.DEBUG.includes('electron-forge')),
+ rendererFallback: Boolean(process.env.DEBUG),
  };
 
  const runner = new Listr(

packages/api/core/src/api/init.ts

@@ -137,7 +137,7 @@ export default async ({ dir = process.cwd(), interactive = false, copyCIFiles =
  {
  concurrent: false,
  rendererSilent: !interactive,
- rendererFallback: Boolean(process.env.DEBUG && process.env.DEBUG.includes('electron-forge')),
+ rendererFallback: Boolean(process.env.DEBUG),
  }
  );
 

packages/api/core/src/api/make.ts

@@ -106,7 +106,7 @@ export const listrMake = (
  collapseErrors: false,
  },
  rendererSilent: !interactive,
- rendererFallback: Boolean(process.env.DEBUG && process.env.DEBUG.includes('electron-forge')),
+ rendererFallback: Boolean(process.env.DEBUG),
  };
 
  const runner = new Listr<MakeContext>(

packages/api/core/src/api/package.ts

@@ -165,11 +165,6 @@ export const listrPackage = ({
 
  task.output = 'Determining targets...';
 
- let provideTargets: (targets: TargetDefinition[]) => void;
- const targetsPromise = new Promise<InternalTargetDefinition[]>((resolve) => {
- provideTargets = resolve;
- });
-
  type StepDoneSignalMap = Map<string, (() => void)[]>;
  const signalCopyDone: StepDoneSignalMap = new Map();
  const signalRebuildDone: StepDoneSignalMap = new Map();
@@ -186,6 +181,12 @@ export const listrPackage = ({
  });
  };
 
+ let provideTargets: (targets: TargetDefinition[]) => void;
+ const targetsPromise = new Promise<InternalTargetDefinition[]>((resolve, reject) => {
+ provideTargets = resolve;
+ rejects.push(reject);
+ });
+
  const rebuildTasks = new Map<string, Promise<ForgeListrTask<never>>[]>();
  const signalRebuildStart = new Map<string, ((task: ForgeListrTask<never>) => void)[]>();
 
@@ -309,7 +310,9 @@ export const listrPackage = ({
  // rejects is populated by the reject handlers for every
  // signal based promise in every subtask
  ctx.packagerPromise.catch((err) => {
- for (const reject of rejects) reject(err);
+ for (const reject of rejects) {
+ reject(err);
+ }
  });
 
  const targets = await targetsPromise;
@@ -430,7 +433,7 @@ export const listrPackage = ({
  {
  concurrent: false,
  rendererSilent: !interactive,
- rendererFallback: Boolean(process.env.DEBUG && process.env.DEBUG.includes('electron-forge')),
+ rendererFallback: Boolean(process.env.DEBUG),
  rendererOptions: {
  collapse: false,
  collapseErrors: false,

packages/api/core/src/api/publish.ts

@@ -85,7 +85,7 @@ const publish = async ({
  collapseErrors: false,
  },
  rendererSilent: !interactive,
- rendererFallback: Boolean(process.env.DEBUG && process.env.DEBUG.includes('electron-forge')),
+ rendererFallback: Boolean(process.env.DEBUG),
  };
 
  const publishDistributablesTasks = [

packages/api/core/src/api/start.ts

@@ -41,7 +41,7 @@ export default async ({
  collapseErrors: false,
  },
  rendererSilent: !interactive,
- rendererFallback: Boolean(process.env.DEBUG && process.env.DEBUG.includes('electron-forge')),
+ rendererFallback: Boolean(process.env.DEBUG),
  };
 
  const runner = new Listr<StartContext>(

packages/api/core/src/util/plugin-interface.ts

@@ -98,7 +98,7 @@ export default class PluginInterface implements IForgePluginInterface {
  task: async (_, task) => {
  if ((hook as any).__hookName) {
  // Also give it the task
- await (hook as any).call(task, ...(hookArgs as any[]));
+ await (hook as any).call(task, this.config, ...(hookArgs as any[]));
  } else {
  await hook(this.config, ...hookArgs);
  }

packages/external/create-electron-app/package.json

@@ -1,13 +1,13 @@
 {
  "name": "create-electron-app",
- "version": "6.0.4",
+ "version": "6.0.5",
  "description": "Create Electron App",
  "main": "dist/index.js",
  "typings": "dist/index.d.ts",
  "author": "Samuel Attard",
  "license": "MIT",
  "dependencies": {
- "@electron-forge/cli": "6.0.4"
+ "@electron-forge/cli": "6.0.5"
  },
  "bin": {
  "create-electron-app": "dist/index.js"

packages/maker/appx/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@electron-forge/maker-appx",
- "version": "6.0.4",
+ "version": "6.0.5",
  "description": "AppX maker for Electron Forge",
  "repository": "https://github.com/electron/forge",
  "author": "Samuel Attard",
@@ -15,8 +15,8 @@
  "node": ">= 14.17.5"
  },
  "dependencies": {
- "@electron-forge/maker-base": "6.0.4",
- "@electron-forge/shared-types": "6.0.4",
+ "@electron-forge/maker-base": "6.0.5",
+ "@electron-forge/shared-types": "6.0.5",
  "cross-spawn": "^7.0.3",
  "fs-extra": "^10.0.0",
  "parse-author": "^2.0.0"