From 7df5120d6bffb9c03e98f178f4a7e7fbd29789b1 Mon Sep 17 00:00:00 2001 From: Konrad Pabjan Date: Thu, 30 Apr 2020 21:09:07 +0200 Subject: [PATCH] Update README with compatibilty differences between v1 and v2 --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 2015d45..3539f28 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,22 @@ steps: run: ls -R working-directory: path/to/artifact ``` + +## Compatibility between `v1` and `v2` + +When using `download-artifact@v1`, a directory denoted by the name of the artifact would be created. All of the contents would ne downloaded to this directory. +``` + path/to/artifact/ + my-artifact/ + ... contents of my-artifact +``` + +With `v2`, there is no longer an extra directory that is created. All the contents are downloaded to the current working directory or to `path` if specified. +``` + path/to/artifact/ + ... contents of my-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.