Clarify --include-retries docs and fixes #1341
Conversation
| 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: |
There was a problem hiding this comment.
I wonder if this makes it clearer? “Retried” really feels like it does double duty here:
| 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: | |
| By default, only artifacts from the last job in a chain of retried jobs are downloaded. | |
| To include artifacts from superseded jobs, use the "--include-retried-jobs" flag: |
There was a problem hiding this comment.
I'm less keen on superseded, because if I read that I'd be wondering if it meant something specific in this context. We could just use "from previous jobs"
Huh, that was unintentional:
There was a problem hiding this comment.
I’m just not sure “previous jobs” conveys “previous tries of this step” though, it seems ambiguous whether this means “prior jobs in the build” or something else
Co-authored-by: Jessica Stokes <[email protected]>
| 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: |
There was a problem hiding this comment.
Yeah, I agree. How about
| To include artifacts from previous retried jobs, use the "--include-retried-jobs" flag: | |
| To include artifacts also from all retried jobs belonging to this step, use the "--include-retried-jobs" flag: |
"Also", to make clear that it is as well as the last one. What do you reckon?
There was a problem hiding this comment.
I’m not sure this solves for the ambiguity in “retried,” and do we otherwise expose the step/job dichotomy to users?
There was a problem hiding this comment.
Good point. I'll ponder and reword tomorrow.
There was a problem hiding this comment.
We expose step just a couple of lines above, on line 35. But if we're not specifying a job ID, we're just using the artifact path, right, so this flag is just saying "get all the stuff, not just the most recent stuff", so mentioning the step isn't helpful. This might be better:
| To include artifacts from previous retried jobs, use the "--include-retried-jobs" flag: | |
| To include matching artifacts also from previous retried jobs as well as the most recent, use the "--include-retried-jobs" flag: |
CC: @jayco