Clarify syntax of dotenv report

• Please check this box if this contribution uses AI-generated content (including content generated by GitLab Duo features) as outlined in the GitLab DCO & CLA. As a benefit of being a GitLab Community Contributor, you receive complimentary access to GitLab Duo.

What does this MR do and why?

Clarify syntax of dotenv report

The current documentation for dotenv reports is incomplete, confusing and not answering all questions:

• Sometimes the file is called "dotenv file", sometimes .env. Rename every occurrence to "dotenv file" for consistency as the file might be named other than .env.

• The ruby-gem is mentioned, which already only implements a sub-set of the original implementation. While GitLab claims to use that rugy-gem, it adds additional restrictions on top. Clarify that the listed restrictions are not from the rugy-gem, but from GitLab and are on-top.

• There are many restrictions and at the end it is unclear, what remains as allowed.

  • Re-order the restrictions from more-generic (file size, file content) to more specific restrictions (on key, on value).

• UTF-8 encoding is explicitly mentioned, but then the restriction for variable names talks about "letters" and "digits". Other Unicode alphabets declare additional characters as "L[ultmo]=Letter" and "N[dlo]=Number". Clarify that only ASCII letters and digits are accepted.

• What does "not supported" mean?

  • for quoting, single- and double-quotes are kept as-is.
  • leading and trailing blanks are stripped.
  • variable substitution just substitutes with the empty string As they do not result in syntax errors, they are usable, but do act differently from the specification. Clarify how they work and that they may be used, but act differently.

• The current documentation forbids any "spaces or newline characters", but actually leading and trailing blanks can be inserted, but are stripped. Intermediate blanks are kept. Newlines are generally forbidden and rejected by GitLab on upload with a "syntax error".

• Talk about variable "names" and "values", not "Key values".

Signed-off-by: Philipp Hahn p.hahn@avm.de

References

• artifacts:reports:dotenv
• example pipeline shows, what happens which each mentioned special case. Only using new-lines aborts the job and GitLab refused to upload the report.

How to set up and validate locally

Only documentation changes

MR acceptance checklist

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.