Skip to content

docs: Fix section that documents storing regex in variables

Ben Prescott_ requested to merge bprescott/docs/20210611-ciregex into master

What does this MR do?

Fixes the section of our documentation that states that regular expressions can be stored in variables, and comparisons can then be performed against the variables.

Linked to this MR are bug issues raised 7 and 19 months ago. Rather than continuing to document (at best) a buggy feature, I propose removing it from the documentation.

history

11.10 introduced a single line into the docs: (gitlab-foss!18902 (merged), gitlab-foss#43601 (closed))

It is possible perform pattern matching against a variable and regular expression.

A customer tried to make this work, and encountered issues. (ticket link for GitLab team members)

I expanded the documentation to try and make it clear that the feature was limited (!29473 (merged)) and also raised #35438 (closed) to cover at least one case where it did not work.

More recent investigation in #284136 (comment 567847184) indicates that while this feature can appear to work, the circumstances are quite specific.

My interpretation if the thread and the feedback from customers is that the code is insufficient to provide a usable feature.

Quoting @mbobin (#284136 (comment 576859994))

When the regular expression is used as string, it's possible to get a partial match. It also works is the value that it's matching is empty.

But when converted to a regular expression it matches only the full values:

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 Ben Prescott_

Merge request reports