Skip to content

Replace the misleading OR (`||`) with pipe (`|`) in gitlab-ci.yml documentation

What does this MR do?

There is a bug in the demo code snippet of scripting a gitlab-ci job. The OR (||) operator was used when getting the exit code of a previous command:

job:
  script:
    - false || exit_code=$?
    - if [ $exit_code -ne 0 ]; then echo "Previous command failed"; fi;

As the two commands are connected with the OR (||) operator - if the first command is successfully executed, the second command exit_code=$? will not run. In that case, $exit_code will be empty rather than the expected 0, leading to a false alarm in the following if block.

Suggest to replace the OR operator (||) with a pipe (|) operator that ensures the second command exit_code=$? always being executed:

job:
  script:
    - false | exit_code=$?
    - if [ $exit_code -ne 0 ]; then echo "Previous command failed"; fi;

Related issues

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.
Edited by Yingying

Merge request reports