Skip to content

CI variable doc improvements

Ben Prescott_ requested to merge docs-bprescott-cizd134321-20200414 into master

What does this MR do?

A customer raised two tickets (internal: 1, 2) as a result of exploring CI yaml syntax, and drew attention to some improvements in the documentation.

This change was originally part of another MR. See MR 19098 for full discussion around these changes.

Environment variables expressions

Using variables in pipeline creation logic is documented for only/except, but we would recommend using rules as only/except will get deprecated at some point.

Pattern matching against a variable

Documentation currently a single sentence. I opened an issue for this.

Customer spent a lot of time trying different incantations in their .gitlab-ci.yml and assumed it was just lack of documentation. Revision ensures the known limitation is in our docs.

Conjunction / Disjunction

A customer thought referring to Ruby docs was unfriendly, and a group of support engineers who swarmed on this ticket did not agree on how the precedence works.

Related issues

Author's checklist

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

  • Optional: 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.

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.
Edited by 🤖 GitLab Bot 🤖

Merge request reports