From ea71f332a90fd52416b1629b933dcf7e0ccd421d Mon Sep 17 00:00:00 2001 From: Sara Tavares <29093946+stavares843@users.noreply.github.com> Date: Tue, 2 Aug 2022 07:30:07 +0100 Subject: [PATCH] Update README.md (#182) --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c42474b3..a884f204 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Download workflow artifact GitHub Action -An action that downloads and extracts uploaded artifact associated with given workflow and commit or other criteria. +An action that downloads and extracts uploaded artifacts associated with a given workflow and commit or other criteria. Let's suppose you have a workflow with a job in it that at the end uploads an artifact using `actions/upload-artifact` action and you want to download this artifact in another workflow that is run after the first one. Official `actions/download-artifact` does not allow this. That's why I decided to create this action. By knowing only the workflow name and commit SHA, you can download the previously uploaded artifact from different workflow associated with that commit and use it. @@ -15,8 +15,8 @@ Let's suppose you have a workflow with a job in it that at the end uploads an ar uses: dawidd6/action-download-artifact@v2 with: # Optional, GitHub token, a Personal Access Token with `public_repo` scope if needed - # Required, if artifact is from a different repo - # Required, if repo is private a Personal Access Token with `repo` scope is needed + # Required, if the artifact is from a different repo + # Required, if the repo is private a Personal Access Token with `repo` scope is needed github_token: ${{secrets.GITHUB_TOKEN}} # Optional, workflow file name or ID # If not specified, will be inferred from run_id (if run_id is specified), or will be the current workflow @@ -41,15 +41,15 @@ Let's suppose you have a workflow with a job in it that at the end uploads an ar run_number: 34 # Optional, uploaded artifact name, # will download all artifacts if not specified - # and extract them in respective subdirectories + # and extract them into respective subdirectories # https://github.com/actions/download-artifact#download-all-artifacts name: artifact_name - # Optional, directory where to extract artifact(s), defaults to current directory + # Optional, a directory where to extract artifact(s), defaults to the current directory path: extract_here # Optional, defaults to current repo repo: ${{github.repository}} - # Optional, check the workflow run whether it has an artifact - # then will get the last available artifact from previous workflow + # Optional, check the workflow run to whether it has an artifact + # then will get the last available artifact from the previous workflow # default false, just try to download from the last one check_artifacts: false # Optional, search for the last workflow run whose stored an artifact named as in `name` input