diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 1a69539..2f96b7d 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -131,3 +131,15 @@ jobs: Write-Error "File contents of downloaded artifacts are incorrect" } shell: pwsh + + - name: Download non-existent Artifact + id: not-existent-artifact + uses: ./ + with: + name: Artifact-C-${{ matrix.runs-on }} + allow-not-found: true + + - name: Verify empty download-path output + if: ${{ steps.not-existent-artifact.outputs.download-path != '' }} + run: | + Write-Error "Expected download-path output is not empty" diff --git a/README.md b/README.md index 6ed23d8..6b619ad 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,12 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md). # If github-token is specified, this is the run that artifacts will be downloaded from. # Optional. Default is ${{ github.run_id }} run-id: + + # When an artifact was not found, this changes the behavior of the download-artifact action. + # If true, this will not cause the action to fail. Instead, the 'download-path' output will be empty. + # If false, this action will raise an error and quit. + # Optional. Default is 'false'. + allow-not-found: ``` ### Outputs diff --git a/action.yml b/action.yml index 54a3eb6..3760fca 100644 --- a/action.yml +++ b/action.yml @@ -17,6 +17,10 @@ inputs: If false, the downloaded artifacts will be extracted into individual named directories within the specified path.' required: false default: 'false' + allow-not-found: + description: 'If an artifact was not found, do not cause the action to fail.' + required: false + default: 'false' github-token: description: 'The GitHub token used to authenticate with the GitHub API. This is required when downloading artifacts from a different repository or from a different workflow run. diff --git a/dist/index.js b/dist/index.js index d0a4ebc..ff083d1 100644 --- a/dist/index.js +++ b/dist/index.js @@ -50930,8 +50930,8 @@ utils.walkdir = function(dirpath, base, callback) { res.forEach(function(dirEntry) { results.push(dirEntry); }); - - next(); + + next(); }); } else { next(); @@ -118710,6 +118710,7 @@ var Inputs; Inputs["RunID"] = "run-id"; Inputs["Pattern"] = "pattern"; Inputs["MergeMultiple"] = "merge-multiple"; + Inputs["AllowNotFound"] = "allow-not-found"; })(Inputs || (exports.Inputs = Inputs = {})); var Outputs; (function (Outputs) { @@ -118783,7 +118784,10 @@ function run() { repository: core.getInput(constants_1.Inputs.Repository, { required: false }), runID: parseInt(core.getInput(constants_1.Inputs.RunID, { required: false })), pattern: core.getInput(constants_1.Inputs.Pattern, { required: false }), - mergeMultiple: core.getBooleanInput(constants_1.Inputs.MergeMultiple, { required: false }) + mergeMultiple: core.getBooleanInput(constants_1.Inputs.MergeMultiple, { + required: false + }), + allowNotFound: core.getBooleanInput(constants_1.Inputs.AllowNotFound, { required: false }) }; if (!inputs.path) { inputs.path = process.env['GITHUB_WORKSPACE'] || process.cwd(); @@ -118792,7 +118796,7 @@ function run() { inputs.path = inputs.path.replace('~', os.homedir()); } const isSingleArtifactDownload = !!inputs.name; - const resolvedPath = path.resolve(inputs.path); + let resolvedPath = path.resolve(inputs.path); core.debug(`Resolved path is ${resolvedPath}`); const options = {}; if (inputs.token) { @@ -118810,12 +118814,23 @@ function run() { let artifacts = []; if (isSingleArtifactDownload) { core.info(`Downloading single artifact`); - const { artifact: targetArtifact } = yield artifact_1.default.getArtifact(inputs.name, options); + const targetArtifact = yield artifact_1.default + .getArtifact(inputs.name, options) + .catch(() => null); if (!targetArtifact) { - throw new Error(`Artifact '${inputs.name}' not found`); + const message = `Artifact '${inputs.name}' not found`; + if (!inputs.allowNotFound) { + throw new Error(message); + } + else { + core.warning(message); + resolvedPath = ''; + } + } + else { + core.debug(`Found named artifact '${inputs.name}' (ID: ${targetArtifact.artifact.id}, Size: ${targetArtifact.artifact.size})`); + artifacts = [targetArtifact.artifact]; } - core.debug(`Found named artifact '${inputs.name}' (ID: ${targetArtifact.id}, Size: ${targetArtifact.size})`); - artifacts = [targetArtifact]; } else { const listArtifactResponse = yield artifact_1.default.listArtifacts(Object.assign({ latest: true }, options)); @@ -128257,11 +128272,11 @@ class LRUCache { b.__abortController instanceof AC); } async fetch(k, fetchOptions = {}) { - const { + const { // get options - allowStale = this.allowStale, updateAgeOnGet = this.updateAgeOnGet, noDeleteOnStaleGet = this.noDeleteOnStaleGet, + allowStale = this.allowStale, updateAgeOnGet = this.updateAgeOnGet, noDeleteOnStaleGet = this.noDeleteOnStaleGet, // set options - ttl = this.ttl, noDisposeOnSet = this.noDisposeOnSet, size = 0, sizeCalculation = this.sizeCalculation, noUpdateTTL = this.noUpdateTTL, + ttl = this.ttl, noDisposeOnSet = this.noDisposeOnSet, size = 0, sizeCalculation = this.sizeCalculation, noUpdateTTL = this.noUpdateTTL, // fetch exclusive options noDeleteOnFetchRejection = this.noDeleteOnFetchRejection, allowStaleOnFetchRejection = this.allowStaleOnFetchRejection, ignoreFetchAbort = this.ignoreFetchAbort, allowStaleOnFetchAbort = this.allowStaleOnFetchAbort, context, forceRefresh = false, status, signal, } = fetchOptions; if (!this.#hasFetchMethod) { @@ -128886,10 +128901,10 @@ module.exports = JSON.parse('[[[0,44],"disallowed_STD3_valid"],[[45,46],"valid"] /******/ } finally { /******/ if(threw) delete __webpack_module_cache__[moduleId]; /******/ } -/******/ +/******/ /******/ // Flag the module as loaded /******/ module.loaded = true; -/******/ +/******/ /******/ // Return the exports of the module /******/ return module.exports; /******/ } @@ -128903,7 +128918,7 @@ module.exports = JSON.parse('[[[0,44],"disallowed_STD3_valid"],[[45,46],"valid"] /******/ return module; /******/ }; /******/ })(); -/******/ +/******/ /******/ /* webpack/runtime/compat */ /******/ /******/ if (typeof __nccwpck_require__ !== 'undefined') __nccwpck_require__.ab = __dirname + "/"; diff --git a/src/constants.ts b/src/constants.ts index 17c7d34..06873e0 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -5,7 +5,8 @@ export enum Inputs { Repository = 'repository', RunID = 'run-id', Pattern = 'pattern', - MergeMultiple = 'merge-multiple' + MergeMultiple = 'merge-multiple', + AllowNotFound = 'allow-not-found' } export enum Outputs { diff --git a/src/download-artifact.ts b/src/download-artifact.ts index 1beef4d..ffbdf24 100644 --- a/src/download-artifact.ts +++ b/src/download-artifact.ts @@ -23,7 +23,10 @@ export async function run(): Promise { repository: core.getInput(Inputs.Repository, {required: false}), runID: parseInt(core.getInput(Inputs.RunID, {required: false})), pattern: core.getInput(Inputs.Pattern, {required: false}), - mergeMultiple: core.getBooleanInput(Inputs.MergeMultiple, {required: false}) + mergeMultiple: core.getBooleanInput(Inputs.MergeMultiple, { + required: false + }), + allowNotFound: core.getBooleanInput(Inputs.AllowNotFound, {required: false}) } if (!inputs.path) { @@ -35,7 +38,7 @@ export async function run(): Promise { } const isSingleArtifactDownload = !!inputs.name - const resolvedPath = path.resolve(inputs.path) + let resolvedPath = path.resolve(inputs.path) core.debug(`Resolved path is ${resolvedPath}`) const options: FindOptions = {} @@ -60,20 +63,25 @@ export async function run(): Promise { if (isSingleArtifactDownload) { core.info(`Downloading single artifact`) - const {artifact: targetArtifact} = await artifactClient.getArtifact( - inputs.name, - options - ) + const targetArtifact = await artifactClient + .getArtifact(inputs.name, options) + .catch(() => null) if (!targetArtifact) { - throw new Error(`Artifact '${inputs.name}' not found`) + const message = `Artifact '${inputs.name}' not found` + if (!inputs.allowNotFound) { + throw new Error(message) + } else { + core.warning(message) + resolvedPath = '' + } + } else { + core.debug( + `Found named artifact '${inputs.name}' (ID: ${targetArtifact.artifact.id}, Size: ${targetArtifact.artifact.size})` + ) + + artifacts = [targetArtifact.artifact] } - - core.debug( - `Found named artifact '${inputs.name}' (ID: ${targetArtifact.id}, Size: ${targetArtifact.size})` - ) - - artifacts = [targetArtifact] } else { const listArtifactResponse = await artifactClient.listArtifacts({ latest: true,