Skip to content

Add a warning message about CI_COMMIT_REF_NAME in include:rules

Furkan Ayhan requested to merge doc-ci_commit_ref_name_include_rules into master

What does this MR do?

This MR adds an information about the problem stated in: #337633 (comment 684159945)

From the Slack conversation:

include:rules only works with some variables: https://docs.gitlab.com/ee/ci/yaml/index.html#variables-with-include

And CI_COMMIT_REF_NAME is one of them... Normally, CI_COMMIT_REF_NAME returns just the branch name like "main" or "feature". However, when implementing support of that variable, we used the "ref path" instead of the "ref". So it returns a string like refs/heads/main.

Workaround: you can use if: $CI_COMMIT_REF_NAME =~ /main/.

I think we can solve this problem in this issue when we support all pipeline predefined variables.

I decided to open this MR after seeing this last comment: #276515 (comment 703550311)

Related issues

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • 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.
Edited by Furkan Ayhan

Merge request reports

Loading