From 7ede1c07b6d6ce6d783e8d78afd1a3179c8b69ec Mon Sep 17 00:00:00 2001 From: Konrad Pabjan Date: Fri, 21 Feb 2020 09:34:39 -0500 Subject: [PATCH] Update README.md --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 43 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d59b5da..b1498b2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# download-artifact +# Download-Artifact v2 Preview -This downloads artifacts from your build. +This downloads artifacts from your build See also [upload-artifact](https://github.com/actions/upload-artifact). @@ -8,31 +8,66 @@ See also [upload-artifact](https://github.com/actions/upload-artifact). See [action.yml](action.yml) -Basic (download to current working directory): +# Download a Single Artifact + +Basic (download to the current working directory): ```yaml steps: -- uses: actions/checkout@v1 +- uses: actions/checkout@v2 -- uses: actions/download-artifact@v1 +- uses: actions/download-artifact@v2-preview with: name: my-artifact - run: cat my-artifact ``` -Download to specific directory: +Download to a specific directory: ```yaml steps: -- uses: actions/checkout@v1 +- uses: actions/checkout@v2 -- uses: actions/download-artifact@v1 +- uses: actions/download-artifact@v2-preview with: name: my-artifact path: path/to/artifact - run: cat path/to/artifact ``` +# Download All Artifacts + +If the `name` input parameter is not provided, all artifacts will be downloaded. To differentiate between downloaded artifacts, a directory denoted by the artifacts name will be created for each individual artifact. + +Example, if there are two artfiacts `Artifact-A` and `Artifact-B`, and the directory is `etc/usr/artifacts/`, the directory structure will look like this: +``` + etc/usr/artifacts/ + Artifact-A/ + ... contents of Artifact-A + Artifact-B/ + ... contents of Artifact-B +``` + +Download all artifacts to a specific directory +```yaml +steps: +- uses: actions/checkout@v2 + +- uses: actions/download-artifact@v2-preview + with: + path: path/to/artifacts + +- run: cat path/to/artifacts +``` + +Download all artifacts to the current working directory +```yaml +steps: +- uses: actions/checkout@v2 + +- uses: actions/download-artifact@v2-preview +``` + # License