Skip to content

Add a note about Psych parsing

Chris Stone requested to merge cms-master-patch-86876 into master

What does this MR do?

A user (internal link) was confused by the behaviour of their pipeline variables after specifying:

  variables:
    ACCOUNT_ID1: 011111111111
    ACCOUNT_ID2: 022222222222
    ACCOUNT_ID3: 033333333333
    ACCOUNT_ID4: 044444444444
    ACCOUNT_ID5: 055555555555
    ACCOUNT_ID6: 066666666666
    ACCOUNT_ID7: 077777777777
    ACCOUNT_ID8: 088888888888

Resulting in:

$ echo $ACCOUNT_ID1
1227133513
$ echo $ACCOUNT_ID2
2454267026
$ echo $ACCOUNT_ID3
3681400539
$ echo $ACCOUNT_ID4
4908534052
$ echo $ACCOUNT_ID5
6135667565
$ echo $ACCOUNT_ID6
7362801078
$ echo $ACCOUNT_ID7
8589934591
$ echo $ACCOUNT_ID8
088888888888

I couldn't find anywhere in our documentation that documents this behaviour, hence adding the hint to https://docs.gitlab.com/ee/ci/variables/.

I wasn't sure if it should be a warning or otherwise, I'm open to suggestions/improvements or pointers to where it may already be documented.

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

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

Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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.
    • Ensure a release milestone is set.
    • 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 reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports