Skip to content

Commit d4793f4

Browse files
committed
update docs for v3
1 parent 2d338d2 commit d4793f4

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Download-Artifact v2
1+
# Download-Artifact v3
22

33
This downloads artifacts from your build
44

@@ -10,7 +10,7 @@ See also [upload-artifact](https://github.com/actions/upload-artifact).
1010
- Output parameter for the download path
1111
- Port entire action to typescript from a runner plugin so it is easier to collaborate and accept contributions
1212

13-
Refer [here](https://github.com/actions/download-artifact/tree/v1) for the previous version
13+
Refer [here](https://github.com/actions/download-artifact/tree/v2) for the previous version
1414

1515
# Usage
1616

@@ -23,7 +23,7 @@ Basic (download to the current working directory):
2323
steps:
2424
- uses: actions/checkout@v2
2525

26-
- uses: actions/download-artifact@v2
26+
- uses: actions/download-artifact@v3
2727
with:
2828
name: my-artifact
2929

@@ -36,7 +36,7 @@ Download to a specific directory:
3636
steps:
3737
- uses: actions/checkout@v2
3838

39-
- uses: actions/download-artifact@v2
39+
- uses: actions/download-artifact@v3
4040
with:
4141
name: my-artifact
4242
path: path/to/artifact
@@ -48,13 +48,13 @@ steps:
4848
4949
Basic tilde expansion is supported for the `path` input:
5050
```yaml
51-
- uses: actions/download-artifact@v2
51+
- uses: actions/download-artifact@v3
5252
with:
5353
name: my-artifact
5454
path: ~/download/path
5555
```
5656

57-
## Compatibility between `v1` and `v2`
57+
## Compatibility between `v1` and `v2`/`v3`
5858

5959
When using `download-artifact@v1`, a directory denoted by the name of the artifact would be created if the `path` input was not provided. All of the contents would be downloaded to this directory.
6060
```
@@ -63,13 +63,13 @@ When using `download-artifact@v1`, a directory denoted by the name of the artifa
6363
... contents of my-artifact
6464
```
6565
66-
With `v2`, when an artifact is specified by the `name` input, there is no longer an extra directory that is created if the `path` input is not provided. All the contents are downloaded to the current working directory.
66+
With `v2` and `v3`, when an artifact is specified by the `name` input, there is no longer an extra directory that is created if the `path` input is not provided. All the contents are downloaded to the current working directory.
6767
```
6868
current/working/directory/
6969
... contents of my-artifact
7070
```
7171
72-
To maintain the same behavior for `v2`, you can set the `path` to the name of the artifact so an extra directory gets created.
72+
To maintain the same behavior for `v2` and `v3`, you can set the `path` to the name of the artifact so an extra directory gets created.
7373
```
7474
- uses: actions/download-artifact@v2
7575
with:
@@ -95,7 +95,7 @@ Download all artifacts to a specific directory
9595
steps:
9696
- uses: actions/checkout@v2
9797
98-
- uses: actions/download-artifact@v2
98+
- uses: actions/download-artifact@v3
9999
with:
100100
path: path/to/artifacts
101101
@@ -109,7 +109,7 @@ Download all artifacts to the current working directory
109109
steps:
110110
- uses: actions/checkout@v2
111111

112-
- uses: actions/download-artifact@v2
112+
- uses: actions/download-artifact@v3
113113

114114
- name: Display structure of downloaded files
115115
run: ls -R
@@ -123,7 +123,7 @@ The `download-path` step output contains information regarding where the artifac
123123
steps:
124124
- uses: actions/checkout@v2
125125
126-
- uses: actions/download-artifact@v2
126+
- uses: actions/download-artifact@v3
127127
id: download
128128
with:
129129
name: 'my-artifact'

0 commit comments

Comments
 (0)