Documentation update to clarify that only key includes a step if any conditions match
What does this MR do?
The MR will update the documentation to accurately reflect what the only keyword does when used in a .gitlab-ci.yaml. It removes inaccurate references in the section and will be helpful for users who are getting started with GitLab CI.
Background
The documentation for .gitlab-ci.yaml currently states that
only: means “include this job if all of the conditions match”.
This can be confusing for users who have not used the only key in a pipeline before. The only keyword includes a job if any of the conditions match. The reference page does have a reference to
(any of refs) OR (any of variables) OR (any of changes) OR (if Kubernetes is active)
This only makes it more confusing for users since it seems to contradict the statement available a few lines above. (See issue https://gitlab.com/gitlab-org/gitlab/issues/34013)
Screenshot showing current documentation with ambiguous references
Related issues
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
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
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.