From f6d2d7d8090826001f9bb7c2e49610f8fa65bf87 Mon Sep 17 00:00:00 2001 From: Samuel Wright Date: Fri, 27 Nov 2020 15:06:38 +0100 Subject: [PATCH 1/2] Minor docs fixes --- clicommand/artifact_download.go | 13 +++++++++---- clicommand/artifact_upload.go | 2 +- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/clicommand/artifact_download.go b/clicommand/artifact_download.go index 1584644204..dbfb450819 100644 --- a/clicommand/artifact_download.go +++ b/clicommand/artifact_download.go @@ -22,7 +22,7 @@ Description: Example: - $ buildkite-agent artifact download "pkg/*.tar.gz" . --build xxx + $ buildkite-agent artifact download --build xxx "pkg/*.tar.gz" . This will search across all the artifacts for the build with files that match that part. The first argument is the search query, and the second argument is the download destination. @@ -30,9 +30,14 @@ Example: If you're trying to download a specific file, and there are multiple artifacts from different jobs, you can target the particular job you want to download the artifact from: - $ buildkite-agent artifact download "pkg/*.tar.gz" . --step "tests" --build xxx + $ buildkite-agent artifact download --step "tests" --build xxx "pkg/*.tar.gz" . - You can also use the step's jobs id (provided by the environment variable $BUILDKITE_JOB_ID)` + You can also use the step's jobs id (provided by the environment variable $BUILDKITE_JOB_ID) + + By default, only artifacts from the most recent job in a chain of retried jobs are downloaded. + To include artifacts from previous retried jobs, use the "--include-retried-jobs" flag: + + $ buildkite-agent artifact download --include-retried-jobs "pkg/*.tar.gz" .` type ArtifactDownloadConfig struct { Query string `cli:"arg:0" label:"artifact search query" validate:"required"` @@ -73,7 +78,7 @@ var ArtifactDownloadCommand = cli.Command{ cli.BoolFlag{ Name: "include-retried-jobs", EnvVar: "BUILDKITE_AGENT_INCLUDE_RETRIED_JOBS", - Usage: "Include artifacts from retried jobs in the search", + Usage: "Include artifacts from previous retried jobs in the search", }, // API Flags diff --git a/clicommand/artifact_upload.go b/clicommand/artifact_upload.go index 3207d7346d..759f338e84 100644 --- a/clicommand/artifact_upload.go +++ b/clicommand/artifact_upload.go @@ -22,7 +22,7 @@ Description: You can specify an alternate destination on Amazon S3, Google Cloud Storage or Artifactory as per the examples below. This may be specified in the 'destination' argument, or in the 'BUILDKITE_ARTIFACT_UPLOAD_DESTINATION' - environment variable. Otherwise, artifacts are uploaded to a + environment variable. Otherwise, artifacts are uploaded to a Buildkite-managed Amazon S3 bucket. Example: From 8d4730af9a3014c2d75655b7a4e2b1ca00e860d3 Mon Sep 17 00:00:00 2001 From: Plaindocs Date: Mon, 30 Nov 2020 16:58:06 +0100 Subject: [PATCH 2/2] Update clicommand/artifact_download.go Co-authored-by: Jessica Stokes --- clicommand/artifact_download.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clicommand/artifact_download.go b/clicommand/artifact_download.go index dbfb450819..ae0e0d6a69 100644 --- a/clicommand/artifact_download.go +++ b/clicommand/artifact_download.go @@ -32,7 +32,7 @@ Example: $ buildkite-agent artifact download --step "tests" --build xxx "pkg/*.tar.gz" . - You can also use the step's jobs id (provided by the environment variable $BUILDKITE_JOB_ID) + You can also use the step's job id (provided by the environment variable $BUILDKITE_JOB_ID) By default, only artifacts from the most recent job in a chain of retried jobs are downloaded. To include artifacts from previous retried jobs, use the "--include-retried-jobs" flag: