From 68e2836542a096b56acb6543c8b0c91e1d252f73 Mon Sep 17 00:00:00 2001 From: Kim Tao Date: Fri, 10 Jan 2025 12:44:54 -0500 Subject: [PATCH] DEVPROD-13995: document project variable limitations --- .../Project-and-Distro-Settings.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/Project-Configuration/Project-and-Distro-Settings.md b/docs/Project-Configuration/Project-and-Distro-Settings.md index 3855c00aca..f218c97182 100644 --- a/docs/Project-Configuration/Project-and-Distro-Settings.md +++ b/docs/Project-Configuration/Project-and-Distro-Settings.md @@ -138,6 +138,18 @@ Options: - Checking **admin only** ensures that the variable can only be used by admins and mainline commits. +Project variables have some limitations: + +* Project variable names can consist of alphanumeric characters, dashes (`-`), + underscores (`_`), and periods (`.`). Other special characters are not + allowed. +* Project variable names cannot contain the suffix `.gz`. +* Project variable names must be unique. +* Project variable names and values cannot be an empty string. +* A project variable's value cannot exceed 8 KB in length. If you need to store + a value longer than 8 KB, you can store it in multiple variables and + concatenate them together in a script when your task runs. + ### Aliases Aliases can be used for patch testing, merge queue testing, GitHub PRs,