feat: Portable build & CLI command execution for CI pipelines by malec-palec · Pull Request #8587 · 4ian/GDevelop

malec-palec · 2026-05-11T16:02:06Z

Portable self-contained zip bundle (npm run build-portable) without code-signing, plus headless --run-command CLI flag that executes any Command Palette command after loading a project.
In CLI mode all blocking dialogs (autosave, changelog, confirmations) are auto-resolved, the window is hidden, and the process exits with a meaningful exit code.
Enables CI pipelines to run exports (e.g. EXPORT_HTML5_EXTERNAL) using only the editor distribution - no installation or display required.

4ian

Looks solid overall. Added various comments but I think this is a good approach and implementation will be clean 👍

4ian · 2026-05-12T06:52:11Z

         - Change the number of the animation of MySpriteObject: = 1
         - Show GroupOfObjects
-         - Activate behavior PlatformerObject of GroupOfSpriteObjectsWithBehaviors: no
+         - Activate behavior PlatformerObject of GroupOfSpriteObjectsWithBehaviors: 


Note: you might have an outdated libGD.js locally, relaunch npm run build in GDevelop.js and that should be solved.

Reverted, thanks.

4ian · 2026-05-12T06:52:32Z

@@ -0,0 +1,74 @@
+// @flow


Nitpicking: files are PascalCase in the IDE codebase.

Renamed exportLocalHtml5Headless.js → ExportLocalHtml5Headless.js, updated all imports

4ian · 2026-05-12T06:54:32Z

+ * Has no React dependencies; accepts a stub i18n like
+ * `{ _: msg => (msg && msg.message) || String(msg) }`.


Suggested change

* Has no React dependencies; accepts a stub i18n like

* `{ _: msg => (msg && msg.message) || String(msg) }`.

I would remove:

React mention unless it's important for something else

The mention of the stub (it's not a module responsibility to be aware that ti's given a stub or not - if it's happen it's the responsibility of the test creating a stub to make it so like the module it's given to is not even noticing it). If anything, we actually prefer to avoid stubs :)

Trimmed JSDoc to /** Headless HTML5 export — no UI, no dialogs. */

4ian · 2026-05-12T06:55:08Z

+import { type I18n as I18nType } from '@lingui/core';
+import { exportLocalHtml5Headless } from '../ExportAndShare/Headless/exportLocalHtml5Headless';
+
+// Commands registered here are awaited by the CLI dispatcher so the process


Very clear 👍

4ian · 2026-05-12T06:55:47Z

      ResourcesLoader.burstAllUrlsCache();
      PixiResourcesLoader.burstCache();

+      // Set the on-disk path before exposing the project via state so that


Sounds good, thanks for the comment.

4ian · 2026-05-12T06:58:02Z

+  // Dispatch `--run-command` once the project is loaded. "Awaitable" commands
+  // (CliCommandRunner.js) are awaited for a proper exit code; others fall back
+  // to fire-and-forget via commandPaletteRef.launchCommand.
+  const cliCommandRanRef = React.useRef(false);


I suggest we move this into newIDE/app/src/MainFrame/CliCommandRunner.js, in a hook like useCliCommandRunner({ project: state.currentProject, ... })

Extracted both useEffect blocks into useCliCommandRunner hook in CliCommandRunner.js, called from MainFrame/index.js

4ian · 2026-05-12T07:05:00Z

+
+      const exitApp = (exitCode: number) => {
+        if (keepOpen) return;
+        const remoteModule = optionalRequire('@electron/remote');


We tend to avoid creating new dependencies to @electron/remote in favor of IPC (https://www.electronjs.org/docs/latest/tutorial/ipc#ipc-channels) (in an ideal world, the renderer process would have 0 calls to Electron or Node.js apis, all optionalRequire would be removed).

Instead, for this kind of "one way" communication, you can use ipcRenderer.send. We don't use yet a "preload.js" script, but it will be easy to migrate everything to a preload.js + exposeInMainWorld once we've reduced all APIs to using ipcRenderer calls.

Replaced optionalRequire('@electron/remote').app.exit() with ipcRenderer.send('app-exit', exitCode), added ipcMain.on('app-exit') handler in main.js

4ian · 2026-05-12T07:05:49Z

+    [state.currentProject, i18n]
+  );
+
+  const CLI_PROJECT_LOAD_TIMEOUT_MS = 120_000;


Same here, this can be part of the hook

Moved timeout useEffect into the same useCliCommandRunner hook

4ian · 2026-05-12T07:07:08Z

+const gotTheLock = isCliRunCommand ? true : app.requestSingleInstanceLock();

 if (!gotTheLock) {
-  // Second instance attempted - quit immediately


Let's keep these comments

Restored // Second instance attempted - quit immediately and // First instance - handle second-instance events

…PC exit

malec-palec · 2026-05-12T14:45:30Z

Looks solid overall. Added various comments but I think this is a good approach and implementation will be clean 👍

@4ian, main question - can the npm run build-portable step be incorporated into the release process, so that the resulting portable ZIP artifacts are automatically published on the GitHub Releases page?

malec-palec added 6 commits May 11, 2026 17:26

feat(ide): add headless EXPORT_HTML5_EXTERNAL command palette action

a8d9b80

feat(electron): add --run-command CLI to invoke command palette commands

786680f

add portable build

969bc75

fix: resolve Flow type errors in headless export and CLI command handler

6a16de4

test: update TextRenderer snapshot for ActivateBehavior rendering change

b45c26e

chore: remove obvious comments from CLI build changes

4ffd9ee

4ian reviewed May 12, 2026

View reviewed changes

malec-palec added 2 commits May 12, 2026 16:31

revert TextRenderer.spec.js to the origin/master version

84112e7

refactor: address PR review - PascalCase, useCliCommandRunner hook, I…

d4cc2e8

…PC exit

malec-palec marked this pull request as ready for review May 12, 2026 14:36

		* Has no React dependencies; accepts a stub i18n like
		* `{ _: msg => (msg && msg.message) \|\| String(msg) }`.

Conversation

malec-palec commented May 11, 2026

Uh oh!

4ian left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

malec-palec May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

malec-palec May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

malec-palec commented May 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

malec-palec May 12, 2026 •

edited

Loading

malec-palec May 12, 2026 •

edited

Loading