Skip to content

docs/ci/yaml: add warning about needs: & parallel: clobbering artifacts:

What does this MR do?

There is a "quirk" when using needs: to get the artifacts: of a job in a parallel: group.
Specifically, it is currently not possible to refer to a single job, but only its group, which has two consequences:

  • The DAG creates a dependency on all the jobs in the group, regardless of how many are actually needed.
  • All the artifacts of the group are clobbered.

This MR addresses this second issue, by documenting this behaviour, as well as a workaround.
Thanks to @mbobin for helping me figure this out 🙏

Related issues

The DAG part of this issue is covered by #254821 (closed), and is not affected by this MR.

#296909 (closed) covers the artifact loss, and therefore this MR:

Closes #296909 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

documentation
/cc @marcel.amirault

Edited by Eric Engestrom

Merge request reports