tweak: stop GitHub from wrapping generated ZIP artifacts in another ZIP

Author: AlexTMjugador

.github/workflows/test_all_inputs_override.yml

@@ -22,7 +22,7 @@ jobs:
         with:
           packsquash_version: latest
           system_id: c5eb0603-093c-41fd-9c21-88c34a429e3b # <- (Automatically generated)
-          artifact_name: Test Artifact Name # <- Optimized pack
+          artifact_name: Test Artifact Name.zip # <- Optimized pack.zip
           show_emoji_in_packsquash_logs: false # <- true
           enable_color_in_packsquash_logs: false # <- true
           token: ${{ secrets.GITHUB_TOKEN }} # <- ${{ github.token }}

.github/workflows/test_run_in_multiple_steps.yml

@@ -21,13 +21,13 @@ jobs:
         uses: ./ # Uses an action in the root directory
         with:
           packsquash_version: latest
-          artifact_name: 'Optimized pack 1'
+          artifact_name: Optimized pack 1.zip
           options: |
             pack_directory = 'test/empty_resource_pack'
       - name: Run PackSquash
         uses: ./
         with:
           packsquash_version: latest
-          artifact_name: 'Optimized pack 2'
+          artifact_name: Optimized pack 2.zip
           options: |
             pack_directory = 'test/empty_resource_pack'

CHANGELOG.md

@@ -8,7 +8,9 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
-No changes yet.
+### Changed
+
+- Uploaded pack file ZIP artifacts are no longer wrapped in an additional ZIP file by GitHub. This leverages a recently introduced feature for disabling that behavior added in a [pull request to `actions/toolkit`](https://github.com/actions/toolkit/pull/2256).
 
 ## [4.0.4] - 2026-01-01
 

README.md

@@ -370,7 +370,7 @@ repositories.
 
 **Default value**
 
-`Optimized pack`
+`Optimized pack.zip`
 
 **Description**
 

action.yml

@@ -24,7 +24,7 @@ inputs:
   artifact_name:
     description: 'The name of the workflow artifact containing the generated ZIP file that the action will upload. Later steps in the workflow will be able to download it by this name. Changing this may be needed in complex workflows, where the action runs several times.'
     required: false
-    default: 'Optimized pack'
+    default: 'Optimized pack.zip'
   show_emoji_in_packsquash_logs:
     description: 'If true, the action will instruct PackSquash to use emojis in the logs it generates, which look prettier. Otherwise, plain ASCII decoration characters will be used instead.'
     required: false

dist/cleanup_working_directory/index.js

@@ -4,7 +4,7 @@ import { context } from "@actions/github";
 import { getInputValue } from "./action_input";
 import type { PackSquashOptions } from "./packsquash_options";
 import { getBranchName, md5Hash } from "./util";
-import { downloadLatestArtifact, getCurrentWorkflowId } from "./workflow";
+import { downloadLatestPackArtifact, getCurrentWorkflowId } from "./workflow";
 import type WorkingDirectory from "./working_directory";
 
 export async function computeCacheKeys(packSquashOptions: PackSquashOptions) {
@@ -51,8 +51,7 @@ export async function restorePackSquashCache(
           throw new Error("Could not get current workflow ID");
         }
 
-        await downloadLatestArtifact(
-          workingDirectory,
+        await downloadLatestPackArtifact(
           owner,
           repo,
           branch,

dist/main/index.js

@@ -6,7 +6,7 @@ import setPackFilesModificationTimesFromCommits from "./git_set_file_times";
 import { printPackSquashVersion, runPackSquash } from "./packsquash";
 import { PackSquashOptions } from "./packsquash_options";
 import { getEnvOrThrow } from "./util";
-import { uploadArtifact } from "./workflow";
+import { uploadPackArtifact } from "./workflow";
 import WorkingDirectory from "./working_directory";
 
 async function run() {
@@ -41,7 +41,7 @@ async function run() {
 
   await runPackSquash(packSquashOptions, binaryEnvironment, workingDirectory);
 
-  await uploadArtifact(packSquashOptions);
+  await uploadPackArtifact(workingDirectory, packSquashOptions);
 
   if (packSquashOptions.mayCacheBeUsed() && !cacheRestored) {
     await savePackSquashCache(workingDirectory, key);

src/cache.ts

@@ -1,3 +1,5 @@
+import { createWriteStream } from "node:fs";
+import { copyFile } from "node:fs/promises";
 import { dirname } from "node:path";
 import { pipeline } from "node:stream/promises";
 import { default as artifactClient } from "@actions/artifact";
@@ -6,7 +8,6 @@ import { HttpClient } from "@actions/http-client";
 import { getInputValue } from "./action_input";
 import octokit from "./octokit";
 import type { PackSquashOptions } from "./packsquash_options";
-import { extractFirstFileFromZip } from "./util";
 import type WorkingDirectory from "./working_directory";
 
 export async function getCurrentWorkflowId(owner: string, repo: string, workflow: string) {
@@ -17,28 +18,30 @@ export async function getCurrentWorkflowId(owner: string, repo: string, workflow
   return workflows.data.workflows.find(w => w.name === workflow)?.id;
 }
 
-export async function uploadArtifact(packSquashOptions: PackSquashOptions) {
+export async function uploadPackArtifact(workingDirectory: WorkingDirectory, packSquashOptions: PackSquashOptions) {
   if ("ACT" in process.env) {
     debug("Local act test environment detected. Skipping artifact upload");
     return;
   }
 
   startGroup("Upload generated ZIP file as artifact");
+  const artifactName = getInputValue("artifact_name");
   const outputFilePath = packSquashOptions.getOutputFilePath();
-  const response = await artifactClient.uploadArtifact(
-    getInputValue("artifact_name"),
-    [outputFilePath],
-    dirname(outputFilePath),
-  );
+  const artifactFilePath = workingDirectory.temporaryFile("pack_artifact_upload", artifactName);
+
+  await copyFile(outputFilePath, artifactFilePath);
+
+  const response = await artifactClient.uploadArtifact(artifactName, [artifactFilePath], dirname(artifactFilePath), {
+    skipArchive: true,
+  });
   endGroup();
 
-  if (!response.size) {
+  if (!response?.size) {
     throw new Error("Artifact upload failed");
   }
 }
 
-export async function downloadLatestArtifact(
-  workingDirectory: WorkingDirectory,
+export async function downloadLatestPackArtifact(
   owner: string,
   repo: string,
   branch: string,
@@ -85,13 +88,12 @@ export async function downloadLatestArtifact(
     artifact_id: artifact.id,
   });
 
-  debug(`Extracting ${artifactName} artifact archive (#${latestRun.run_number})`);
+  debug(`Downloading ${artifactName} artifact (#${latestRun.run_number})`);
   try {
-    await pipeline((await new HttpClient().get(zip.url)).message, workingDirectory.temporaryDownloadFileWriteStream);
+    await pipeline((await new HttpClient().get(zip.url)).message, createWriteStream(destinationPath));
   } catch {
     throw new Error(`Could not download the latest ${artifactName} artifact`);
   }
-  await extractFirstFileFromZip(workingDirectory.temporaryDownloadFile, destinationPath);
 
   info(`Successfully downloaded the latest ${artifactName} artifact`);
 }