Merge pull request #2537 from github/henrymercer/no-zstd-windows

Don't use Zstandard bundles on Windows
github · Oct 10, 2024 · 38469af · 38469af
2 parents 9d1e406 + 5b6984e
commit 38469af
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 12 deletions.
diff --git a/.github/workflows/__zstd-bundle-fallback.yml b/.github/workflows/__zstd-bundle-fallback.yml
diff --git a/.github/workflows/__zstd-bundle.yml b/.github/workflows/__zstd-bundle.yml
diff --git a/lib/setup-codeql.js b/lib/setup-codeql.js
diff --git a/lib/setup-codeql.js.map b/lib/setup-codeql.js.map
diff --git a/pr-checks/checks/zstd-bundle-fallback.yml b/pr-checks/checks/zstd-bundle-fallback.yml
@@ -4,7 +4,6 @@ versions:
   - linked
 operatingSystems:
   - macos
-  - windows
   - ubuntu
 env:
   CODEQL_ACTION_ZSTD_BUNDLE: true

diff --git a/pr-checks/checks/zstd-bundle.yml b/pr-checks/checks/zstd-bundle.yml
@@ -4,8 +4,8 @@ versions:
   - linked
 operatingSystems:
   - macos
-  - windows
   - ubuntu
+  - windows
 env:
   CODEQL_ACTION_ZSTD_BUNDLE: true
 steps:
@@ -59,8 +59,10 @@ steps:
         const toolsUrl = downloadTelemetryNotifications[0].properties.attributes.toolsUrl;
         console.log(`Found tools URL: ${toolsUrl}`);
 
-        if (!toolsUrl.endsWith('.tar.zst')) {
+        const expectedExtension = process.env['RUNNER_OS'] === 'Windows' ? '.tar.gz' : '.tar.zst';
+
+        if (!toolsUrl.endsWith(expectedExtension)) {
           core.setFailed(
-            `Expected the tools URL to be a .tar.zst file, but found ${toolsUrl}.`
+            `Expected the tools URL to be a ${expectedExtension} file, but found ${toolsUrl}.`
           );
         }
diff --git a/src/setup-codeql.ts b/src/setup-codeql.ts
@@ -823,6 +823,8 @@ async function useZstdBundle(
   tarSupportsZstd: boolean,
 ): Promise<boolean> {
   return (
+    // In testing, gzip performs better than zstd on Windows.
+    process.platform !== "win32" &&
     tarSupportsZstd &&
     semver.gte(cliVersion, CODEQL_VERSION_ZSTD_BUNDLE) &&
     !!(await features.getValue(Feature.ZstdBundle))
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,6 @@ versions: @@
       - linked
     operatingSystems:
       - macos
-      - windows
       - ubuntu
     env:
       CODEQL_ACTION_ZSTD_BUNDLE: true
@@ Expand Down @@