actions/download-artifact
1
0
Fork 0
mirror of https://github.com/actions/download-artifact.git synced 2025-07-26 00:18:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor: rename waitTimeout to wait-timeout

Browse source
This commit is contained in:
Ivan Dlugos 2022-03-04 14:43:50 +01:00
parent 6e62761105
commit 3682b366b0
5 changed files with 7 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

4
.github/workflows/test.yml vendored
View file

@ -163,7 +163,7 @@ jobs:
with: with:
name: 'Artifact-wait-${{ matrix.runs-on }}' name: 'Artifact-wait-${{ matrix.runs-on }}'
path: some/new/path path: some/new/path
waitTimeout: 600 wait-timeout: 600
# Test downloading an artifact using tilde expansion # Test downloading an artifact using tilde expansion
- name: Download artifact A - name: Download artifact A
@ -214,7 +214,7 @@ jobs:
uses: ./ uses: ./
with: with:
path: some/other/path path: some/other/path
waitTimeout: 600 wait-timeout: 600
- name: Verify successful download - name: Verify successful download
run: | run: |

6
README.md
View file

@ -137,7 +137,7 @@ steps:
# Waiting for the artifact to be available # Waiting for the artifact to be available
You can specify `waitTimeout` (seconds) to instruct the download/artifact to retry until the artifact is available. You can specify `wait-timeout` (seconds) to instruct the download-artifact action to retry until the artifact is available.
This is useful if you want to launch the job before its dependency job has finished, e.g. if the dependant requires some time-consuming steps. This is useful if you want to launch the job before its dependency job has finished, e.g. if the dependant requires some time-consuming steps.
You can do this by removing the `needs` dependency and relying on the retry logic of download-artifact to fetch the artifact after it's uploaded. You can do this by removing the `needs` dependency and relying on the retry logic of download-artifact to fetch the artifact after it's uploaded.
@ -169,11 +169,9 @@ jobs:
name: artifact-name name: artifact-name
path: output-path path: output-path
# wait for 300 seconds # wait for 300 seconds
waitTimeout: 300 wait-timeout: 300
``` ```
> Note: The `id` defined in the `download/artifact` step must match the `id` defined in the `echo` step (i.e `steps.[ID].outputs.download-path`)
# Limitations # Limitations
### Permission Loss ### Permission Loss

2
action.yml
View file

@ -8,7 +8,7 @@ inputs:
path: path:
description: 'Destination path' description: 'Destination path'
required: false required: false
waitTimeout: wait-timeout:
description: 'Wait for the artifact to become available (timeout in seconds)' description: 'Wait for the artifact to become available (timeout in seconds)'
required: false required: false
runs: runs:

2
dist/index.js vendored
View file

@ -6954,7 +6954,7 @@ var Inputs;
(function (Inputs) { (function (Inputs) {
Inputs["Name"] = "name"; Inputs["Name"] = "name";
Inputs["Path"] = "path"; Inputs["Path"] = "path";
Inputs["WaitTimeout"] = "waitTimeout"; Inputs["WaitTimeout"] = "wait-timeout";
})(Inputs = exports.Inputs || (exports.Inputs = {})); })(Inputs = exports.Inputs || (exports.Inputs = {}));
var Outputs; var Outputs;
(function (Outputs) { (function (Outputs) {

2
src/constants.ts
View file

@ -1,7 +1,7 @@
export enum Inputs { export enum Inputs {
Name = 'name', Name = 'name',
Path = 'path', Path = 'path',
WaitTimeout = 'waitTimeout' WaitTimeout = 'wait-timeout'
} }
export enum Outputs { export enum Outputs {
DownloadPath = 'download-path' DownloadPath = 'download-path'