| Property | Value |
|---|---|
| Upload method | archive: false |
| Content-Type | text/html |
| File | report.html |
✔ Single file upload is working!
+ + + EOF + + - name: Upload HTML report (no archive) + uses: ./ + with: + name: 'test-report' + path: report.html + archive: false + merge: name: Merge needs: build @@ -230,7 +329,7 @@ jobs: # easier to identify each of the merged artifacts separate-directories: true - name: 'Download merged artifacts' - uses: actions/download-artifact@v4 + uses: actions/download-artifact@main with: name: merged-artifacts path: all-merged-artifacts @@ -266,7 +365,7 @@ jobs: # Download merged artifacts and verify the correctness of the content - name: 'Download merged artifacts' - uses: actions/download-artifact@v4 + uses: actions/download-artifact@main with: name: Merged-Artifact-As path: merged-artifact-a @@ -290,3 +389,40 @@ jobs: } shell: pwsh + cleanup: + name: Cleanup Artifacts + needs: [build, merge] + runs-on: ubuntu-latest + + steps: + - name: Delete test artifacts + uses: actions/github-script@v8 + with: + script: | + const keep = ['report.html']; + const owner = context.repo.owner; + const repo = context.repo.repo; + const runId = context.runId; + + const {data: {artifacts}} = await github.rest.actions.listWorkflowRunArtifacts({ + owner, + repo, + run_id: runId + }); + + for (const a of artifacts) { + if (keep.includes(a.name)) { + console.log(`Keeping artifact '${a.name}'`); + continue; + } + try { + await github.rest.actions.deleteArtifact({ + owner, + repo, + artifact_id: a.id + }); + console.log(`Deleted artifact '${a.name}'`); + } catch (err) { + console.log(`Could not delete artifact '${a.name}': ${err.message}`); + } + } diff --git a/__tests__/upload.test.ts b/__tests__/upload.test.ts index 6e0c26a..de81a1c 100644 --- a/__tests__/upload.test.ts +++ b/__tests__/upload.test.ts @@ -72,6 +72,7 @@ const mockInputs = ( [Inputs.RetentionDays]: 0, [Inputs.CompressionLevel]: 6, [Inputs.Overwrite]: false, + [Inputs.Archive]: true, ...overrides } @@ -273,4 +274,57 @@ describe('upload', () => { `Skipping deletion of '${fixtures.artifactName}', it does not exist` ) }) + + test('passes skipArchive when archive is false', async () => { + mockInputs({ + [Inputs.Archive]: false + }) + + mockFindFilesToUpload.mockResolvedValue({ + filesToUpload: [fixtures.filesToUpload[0]], + rootDirectory: fixtures.rootDirectory + }) + + await run() + + expect(artifact.default.uploadArtifact).toHaveBeenCalledWith( + fixtures.artifactName, + [fixtures.filesToUpload[0]], + fixtures.rootDirectory, + {compressionLevel: 6, skipArchive: true} + ) + }) + + test('does not pass skipArchive when archive is true', async () => { + mockInputs({ + [Inputs.Archive]: true + }) + + mockFindFilesToUpload.mockResolvedValue({ + filesToUpload: [fixtures.filesToUpload[0]], + rootDirectory: fixtures.rootDirectory + }) + + await run() + + expect(artifact.default.uploadArtifact).toHaveBeenCalledWith( + fixtures.artifactName, + [fixtures.filesToUpload[0]], + fixtures.rootDirectory, + {compressionLevel: 6} + ) + }) + + test('fails when archive is false and multiple files are provided', async () => { + mockInputs({ + [Inputs.Archive]: false + }) + + await run() + + expect(core.setFailed).toHaveBeenCalledWith( + `When 'archive' is set to false, only a single file can be uploaded. Found ${fixtures.filesToUpload.length} files to upload.` + ) + expect(artifact.default.uploadArtifact).not.toHaveBeenCalled() + }) }) diff --git a/action.yml b/action.yml index 28f04cc..7cb4d1e 100644 --- a/action.yml +++ b/action.yml @@ -3,10 +3,10 @@ description: 'Upload a build artifact that can be used by subsequent workflow st author: 'GitHub' inputs: name: - description: 'Artifact name' + description: 'Artifact name. If the `archive` input is `false`, the name of the file uploaded will be the artifact name.' default: 'artifact' path: - description: 'A file, directory or wildcard pattern that describes what to upload' + description: 'A file, directory or wildcard pattern that describes what to upload.' required: true if-no-files-found: description: > @@ -45,6 +45,12 @@ inputs: If true, hidden files will be included in the artifact. If false, hidden files will be excluded from the artifact. default: 'false' + archive: + description: > + If true, the artifact will be archived (zipped) before uploading. + If false, the artifact will be uploaded as-is without archiving. + When `archive` is `false`, only a single file can be uploaded. The name of the file will be used as the artifact name (ignoring the `name` parameter). + default: 'true' outputs: artifact-id: diff --git a/dist/upload/index.js b/dist/upload/index.js index f08f27c..a4ca651 100644 --- a/dist/upload/index.js +++ b/dist/upload/index.js @@ -130457,6 +130457,7 @@ var Inputs; Inputs["CompressionLevel"] = "compression-level"; Inputs["Overwrite"] = "overwrite"; Inputs["IncludeHiddenFiles"] = "include-hidden-files"; + Inputs["Archive"] = "archive"; })(Inputs || (Inputs = {})); var NoFileOptions; (function (NoFileOptions) { @@ -130485,6 +130486,7 @@ function getInputs() { const path = getInput(Inputs.Path, { required: true }); const overwrite = getBooleanInput(Inputs.Overwrite); const includeHiddenFiles = getBooleanInput(Inputs.IncludeHiddenFiles); + const archive = getBooleanInput(Inputs.Archive); const ifNoFilesFound = getInput(Inputs.IfNoFilesFound); const noFileBehavior = NoFileOptions[ifNoFilesFound]; if (!noFileBehavior) { @@ -130495,7 +130497,8 @@ function getInputs() { searchPath: path, ifNoFilesFound: noFileBehavior, overwrite: overwrite, - includeHiddenFiles: includeHiddenFiles + includeHiddenFiles: includeHiddenFiles, + archive: archive }; const retentionDaysStr = getInput(Inputs.RetentionDays); if (retentionDaysStr) { @@ -130576,6 +130579,11 @@ async function run() { const s = searchResult.filesToUpload.length === 1 ? '' : 's'; info(`With the provided path, there will be ${searchResult.filesToUpload.length} file${s} uploaded`); core_debug(`Root artifact directory is ${searchResult.rootDirectory}`); + // Validate that only a single file is uploaded when archive is false + if (!inputs.archive && searchResult.filesToUpload.length > 1) { + setFailed(`When 'archive' is set to false, only a single file can be uploaded. Found ${searchResult.filesToUpload.length} files to upload.`); + return; + } if (inputs.overwrite) { await deleteArtifactIfExists(inputs.artifactName); } @@ -130586,6 +130594,9 @@ async function run() { if (typeof inputs.compressionLevel !== 'undefined') { options.compressionLevel = inputs.compressionLevel; } + if (!inputs.archive) { + options.skipArchive = true; + } await upload_artifact_uploadArtifact(inputs.artifactName, searchResult.filesToUpload, searchResult.rootDirectory, options); } } diff --git a/package-lock.json b/package-lock.json index a0c89f3..5739b1d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "7.0.0", "license": "MIT", "dependencies": { - "@actions/artifact": "^6.1.0", + "@actions/artifact": "^6.2.0", "@actions/core": "^3.0.0", "@actions/github": "^9.0.0", "@actions/glob": "^0.6.1", diff --git a/package.json b/package.json index c668d43..b71533f 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "node": ">=24" }, "dependencies": { - "@actions/artifact": "^6.1.0", + "@actions/artifact": "^6.2.0", "@actions/core": "^3.0.0", "@actions/github": "^9.0.0", "@actions/glob": "^0.6.1", diff --git a/src/upload/constants.ts b/src/upload/constants.ts index 8407bc1..61ec717 100644 --- a/src/upload/constants.ts +++ b/src/upload/constants.ts @@ -6,7 +6,8 @@ export enum Inputs { RetentionDays = 'retention-days', CompressionLevel = 'compression-level', Overwrite = 'overwrite', - IncludeHiddenFiles = 'include-hidden-files' + IncludeHiddenFiles = 'include-hidden-files', + Archive = 'archive' } export enum NoFileOptions { diff --git a/src/upload/input-helper.ts b/src/upload/input-helper.ts index 527ce6c..29605c6 100644 --- a/src/upload/input-helper.ts +++ b/src/upload/input-helper.ts @@ -10,6 +10,7 @@ export function getInputs(): UploadInputs { const path = core.getInput(Inputs.Path, {required: true}) const overwrite = core.getBooleanInput(Inputs.Overwrite) const includeHiddenFiles = core.getBooleanInput(Inputs.IncludeHiddenFiles) + const archive = core.getBooleanInput(Inputs.Archive) const ifNoFilesFound = core.getInput(Inputs.IfNoFilesFound) const noFileBehavior: NoFileOptions = NoFileOptions[ifNoFilesFound] @@ -29,7 +30,8 @@ export function getInputs(): UploadInputs { searchPath: path, ifNoFilesFound: noFileBehavior, overwrite: overwrite, - includeHiddenFiles: includeHiddenFiles + includeHiddenFiles: includeHiddenFiles, + archive: archive } as UploadInputs const retentionDaysStr = core.getInput(Inputs.RetentionDays) diff --git a/src/upload/upload-artifact.ts b/src/upload/upload-artifact.ts index 1cffa3d..432ec11 100644 --- a/src/upload/upload-artifact.ts +++ b/src/upload/upload-artifact.ts @@ -57,6 +57,14 @@ export async function run(): Promise