Skip to content

feat: single apify-cli bundle + native Windows ARM64 (supersedes #1057) #1169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vladfrangu wants to merge 6 commits into
base: master
Choose a base branch
from
Open

feat: single apify-cli bundle + native Windows ARM64 (supersedes #1057) #1169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6884cd9
feat: ship a single apify-cli bundle with apify/actor wrapper scripts
vladfrangu May 29, 2026
70607d5
feat: native Windows ARM64 bundles (adapted from #1057)
vladfrangu May 29, 2026
4db6ced
refactor(build): drop the 'as never' bun target casts
vladfrangu May 29, 2026
3d06e98
chore(build): stop building redundant arm64 baseline bundles
vladfrangu May 29, 2026
c80db3e
ci: don't build arm64-baseline on windows on arm
vladfrangu May 30, 2026
cfa9e18
refactor(install): centralize wrapper-shim creation in the bundle
vladfrangu May 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 6 additions & 16 deletions .github/workflows/check.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,10 @@ jobs:
label: unix
- os: windows-latest
label: windows-x64
bun-target-arch: x64
- os: windows-11-arm
label: windows-arm64
bun-target-arch: arm64

runs-on: ${{ matrix.os }}

Expand All @@ -227,33 +229,21 @@ jobs:

- name: Install bun
uses: oven-sh/setup-bun@v2
if: ${{ matrix.os != 'windows-11-arm' }}
with:
bun-version-file: .bun-version
no-cache: true

- name: Install bun (Windows ARM)
if: ${{ matrix.os == 'windows-11-arm' }}
run: |
$bunVersion = (Get-Content .bun-version).Trim()
irm bun.sh/install.ps1 -OutFile install.ps1

# Bun doesn't have Windows ARM64 builds, so the setup-bun action fails. The install script however,
# does "support" it.

.\install.ps1 -Version $bunVersion

Join-Path (Resolve-Path ~).Path ".bun\bin" >> $env:GITHUB_PATH

# https://github.com/oven-sh/bun/issues/11198
- name: Fix cross-platform building on Actions
if: ${{ matrix.os != 'ubuntu-latest' }}
run: |
mkdir C:\test
cd C:\test
bun init -y
bun build --compile --target=bun-windows-x64 --outfile test index.ts
bun build --compile --target=bun-windows-x64-baseline --outfile test index.ts
bun build --compile --target=bun-windows-${{ matrix.bun-target-arch }} --outfile test index.ts
if ("${{ matrix.bun-target-arch }}" -eq "x64") {
bun build --compile --target=bun-windows-x64-baseline --outfile test index.ts
}

- name: Build Bundles
run: pnpm run insert-cli-metadata && pnpm run build-bundles
Expand Down
22 changes: 6 additions & 16 deletions .github/workflows/pre_release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,10 @@ jobs:
label: unix
- os: windows-latest
label: windows-x64
bun-target-arch: x64
- os: windows-11-arm
label: windows-arm64
bun-target-arch: arm64

runs-on: ${{ matrix.os }}

Expand All @@ -125,32 +127,20 @@ jobs:

- name: Install bun
uses: oven-sh/setup-bun@v2
if: ${{ matrix.os != 'windows-11-arm' }}
with:
bun-version-file: .bun-version

- name: Install bun (Windows ARM)
if: ${{ matrix.os == 'windows-11-arm' }}
run: |
$bunVersion = (Get-Content .bun-version).Trim()
irm bun.sh/install.ps1 -OutFile install.ps1

# Bun doesn't have Windows ARM64 builds, so the setup-bun action fails. The install script however,
# does "support" it.

.\install.ps1 -Version $bunVersion

Join-Path (Resolve-Path ~).Path ".bun\bin" >> $env:GITHUB_PATH

# https://github.com/oven-sh/bun/issues/11198
- name: Fix cross-platform building on Actions
if: ${{ matrix.os != 'ubuntu-latest' }}
run: |
mkdir C:\test
cd C:\test
bun init -y
bun build --compile --target=bun-windows-x64 --outfile test index.ts
bun build --compile --target=bun-windows-x64-baseline --outfile test index.ts
bun build --compile --target=bun-windows-${{ matrix.bun-target-arch }} --outfile test index.ts
if ("${{ matrix.bun-target-arch }}" -eq "x64") {
bun build --compile --target=bun-windows-x64-baseline --outfile test index.ts
}

- name: Set pre-release version
run: pnpm version ${{ needs.update_changelog.outputs.pre_release_version }} --no-git-tag-version --allow-same-version
Expand Down
22 changes: 6 additions & 16 deletions .github/workflows/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,10 @@ jobs:
label: unix
- os: windows-latest
label: windows-x64
bun-target-arch: x64
- os: windows-11-arm
label: windows-arm64
bun-target-arch: arm64

runs-on: ${{ matrix.os }}

Expand All @@ -153,32 +155,20 @@ jobs:

- name: Install bun
uses: oven-sh/setup-bun@v2
if: ${{ matrix.os != 'windows-11-arm' }}
with:
bun-version-file: .bun-version

- name: Install bun (Windows ARM)
if: ${{ matrix.os == 'windows-11-arm' }}
run: |
$bunVersion = (Get-Content .bun-version).Trim()
irm bun.sh/install.ps1 -OutFile install.ps1

# Bun doesn't have Windows ARM64 builds, so the setup-bun action fails. The install script however,
# does "support" it.

.\install.ps1 -Version $bunVersion

Join-Path (Resolve-Path ~).Path ".bun\bin" >> $env:GITHUB_PATH

# https://github.com/oven-sh/bun/issues/11198
- name: Fix cross-platform building on Actions
if: ${{ matrix.os != 'ubuntu-latest' }}
run: |
mkdir C:\test
cd C:\test
bun init -y
bun build --compile --target=bun-windows-x64 --outfile test index.ts
bun build --compile --target=bun-windows-x64-baseline --outfile test index.ts
bun build --compile --target=bun-windows-${{ matrix.bun-target-arch }} --outfile test index.ts
if ("${{ matrix.bun-target-arch }}" -eq "x64") {
bun build --compile --target=bun-windows-x64-baseline --outfile test index.ts
}

- name: Set version
run: pnpm version ${{ needs.release_metadata.outputs.version_number }} --no-git-tag-version --allow-same-version
Expand Down
76 changes: 36 additions & 40 deletions scripts/build-cli-bundles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ When node stabilizes SEA (https://nodejs.org/api/single-executable-applications.
*/

import { readFileSync } from 'node:fs';
import { readFile, rm, writeFile } from 'node:fs/promises';
import { copyFile, readFile, rm, writeFile } from 'node:fs/promises';
import { basename } from 'node:path';

import { $, type Build, build, fileURLToPath } from 'bun';
import { type Build, build, fileURLToPath } from 'bun';

import { version } from '../package.json' with { type: 'json' };

Expand All @@ -21,48 +21,51 @@ const targets = (() => {
//
'bun-windows-x64',
'bun-windows-x64-baseline',
'bun-windows-arm64',
'bun-linux-x64',
'bun-linux-x64-baseline',
'bun-linux-arm64',
'bun-linux-arm64-baseline',
'bun-darwin-x64',
'bun-darwin-x64-baseline',
'bun-darwin-arm64',
'bun-darwin-arm64-baseline',
'bun-linux-x64-musl',
'bun-linux-arm64-musl',
// TODO: when adding native windows arm64 builds, remove these too
'bun-linux-x64-musl-baseline' as never,
'bun-linux-arm64-musl-baseline' as never,
'bun-linux-x64-baseline-musl',
] satisfies Build.CompileTarget[];
}

if (process.platform === 'win32') {
if (process.arch === 'arm64') {
return ['bun-windows-arm64'] satisfies Build.CompileTarget[];
}

return ['bun-windows-x64', 'bun-windows-x64-baseline'] satisfies Build.CompileTarget[];
}

return [
'bun-linux-x64',
'bun-linux-x64-baseline',
'bun-linux-arm64',
'bun-linux-arm64-baseline',
'bun-darwin-x64',
'bun-darwin-x64-baseline',
'bun-darwin-arm64',
'bun-darwin-arm64-baseline',
'bun-linux-x64-musl',
'bun-linux-arm64-musl',
'bun-linux-x64-musl-baseline' as never,
'bun-linux-arm64-musl-baseline' as never,
'bun-linux-x64-baseline-musl',
] satisfies Build.CompileTarget[];
})();

// We now build a single `apify-cli` bundle. The `apify` and `actor` CLIs are wrapper scripts (created on
// install/upgrade) that invoke this bundle with `APIFY_CLI_ENTRYPOINT` set to pick the command set.
const entryPoints = [
//
fileURLToPath(new URL('../src/entrypoints/apify.ts', import.meta.url)),
fileURLToPath(new URL('../src/entrypoints/actor.ts', import.meta.url)),
fileURLToPath(new URL('../src/entrypoints/apify-cli.ts', import.meta.url)),
];

// Names under which a copy of the single bundle is also published, so that installs using the old
// two-bundle upgrade flow can still pull the new bundle. These can be dropped once everyone has migrated.
const backupBundleNames = ['apify', 'actor'];

await rm(new URL('../bundles/', import.meta.url), { recursive: true, force: true });

// #region Inject the fact the CLI is ran in a bundle, instead of installed through npm/volta
Expand Down Expand Up @@ -109,33 +112,16 @@ for (const entryPoint of entryPoints) {
}

for (const target of targets) {
// eslint-disable-next-line prefer-const -- somehow it cannot tell that os and arch cannot be "const" while the rest are let
let [, os, arch, musl, baseline] = target.split('-');

if (musl === 'baseline') {
musl = '';
baseline = 'baseline';
}

// If we are building on Windows ARM64, even though the target is x64, we mark it as "arm64" (there are some weird errors when compiling on x64
// and running on arm64). Hopefully bun will get arm64 native builds
// TODO: Vlad remove this in a subsequent PR as Bun now has native arm64 windows builds
if (os === 'windows' && process.platform === 'win32') {
const systemType = await $`pwsh -c "(Get-CimInstance Win32_ComputerSystem).SystemType"`.text();

if (systemType.toLowerCase().includes('arm')) {
arch = 'arm64';
// `target` is a bun compile target like `bun-linux-x64-baseline-musl`. The trailing modifiers (libc
// and/or SIMD level) can appear in any order, so collect them and emit the asset suffix in a stable
// `-musl-baseline` order (which the install/upgrade asset matchers rely on).
const [, os, arch, ...modifiers] = target.split('-');

// On arm, process.arch will still return x64, which will break the upgrade command.
// So we override the arch to arm64
const isMusl = modifiers.includes('musl');
const isBaseline = modifiers.includes('baseline');

const newNewContent = newContent.replace('process.env.APIFY_BUNDLE_ARCH', '"arm64"');

await writeFile(metadataFile, newNewContent);
}
}

const fileName = `${cliName}-${version}-${os}-${arch}${musl ? '-musl' : ''}${baseline ? '-baseline' : ''}`;
const versionSuffix = `${version}-${os}-${arch}${isMusl ? '-musl' : ''}${isBaseline ? '-baseline' : ''}`;
const fileName = `${cliName}-${versionSuffix}`;

const outFile = fileURLToPath(new URL(`../bundles/${fileName}`, import.meta.url));

Expand All @@ -156,8 +142,18 @@ for (const entryPoint of entryPoints) {
bytecode: true,
});

// Remove the arch override
await writeFile(metadataFile, newContent);
// Bun appends `.exe` to the output file for Windows targets
const isWindowsTarget = os === 'windows';
const compiledFile = `${outFile}${isWindowsTarget ? '.exe' : ''}`;

// Publish copies of the single bundle under the legacy `apify`/`actor` names as a backup
for (const backupName of backupBundleNames) {
const backupFile = fileURLToPath(
new URL(`../bundles/${backupName}-${versionSuffix}${isWindowsTarget ? '.exe' : ''}`, import.meta.url),
);

await copyFile(compiledFile, backupFile);
}
}
}

Expand Down
Loading
Loading