mirror of
https://github.com/actions/download-artifact.git
synced 2025-07-24 23:48:29 +02:00
refactor: rename waitTimeout to wait-timeout
This commit is contained in:
parent
6e62761105
commit
3682b366b0
5 changed files with 7 additions and 9 deletions
4
.github/workflows/test.yml
vendored
4
.github/workflows/test.yml
vendored
|
@ -163,7 +163,7 @@ jobs:
|
|||
with:
|
||||
name: 'Artifact-wait-${{ matrix.runs-on }}'
|
||||
path: some/new/path
|
||||
waitTimeout: 600
|
||||
wait-timeout: 600
|
||||
|
||||
# Test downloading an artifact using tilde expansion
|
||||
- name: Download artifact A
|
||||
|
@ -214,7 +214,7 @@ jobs:
|
|||
uses: ./
|
||||
with:
|
||||
path: some/other/path
|
||||
waitTimeout: 600
|
||||
wait-timeout: 600
|
||||
|
||||
- name: Verify successful download
|
||||
run: |
|
||||
|
|
|
@ -137,7 +137,7 @@ steps:
|
|||
|
||||
# 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.
|
||||
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
|
||||
path: output-path
|
||||
# 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
|
||||
|
||||
### Permission Loss
|
||||
|
|
|
@ -8,7 +8,7 @@ inputs:
|
|||
path:
|
||||
description: 'Destination path'
|
||||
required: false
|
||||
waitTimeout:
|
||||
wait-timeout:
|
||||
description: 'Wait for the artifact to become available (timeout in seconds)'
|
||||
required: false
|
||||
runs:
|
||||
|
|
2
dist/index.js
vendored
2
dist/index.js
vendored
|
@ -6954,7 +6954,7 @@ var Inputs;
|
|||
(function (Inputs) {
|
||||
Inputs["Name"] = "name";
|
||||
Inputs["Path"] = "path";
|
||||
Inputs["WaitTimeout"] = "waitTimeout";
|
||||
Inputs["WaitTimeout"] = "wait-timeout";
|
||||
})(Inputs = exports.Inputs || (exports.Inputs = {}));
|
||||
var Outputs;
|
||||
(function (Outputs) {
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
export enum Inputs {
|
||||
Name = 'name',
|
||||
Path = 'path',
|
||||
WaitTimeout = 'waitTimeout'
|
||||
WaitTimeout = 'wait-timeout'
|
||||
}
|
||||
export enum Outputs {
|
||||
DownloadPath = 'download-path'
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue