Document that secrets can be CSV (#307)

Closes #306
google-github-actions · Oct 25, 2024 · 2715e4c · 2715e4c
1 parent 0eee3cd
commit 2715e4c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -61,11 +61,11 @@ jobs:
 
 <!-- BEGIN_AUTOGEN_INPUTS -->
 
--   <a name="secrets"></a><a href="#user-content-secrets"><code>secrets</code></a>: _(Required)_ The list of secrets to access and inject into the
-    environment. Due to limitations with GitHub Actions inputs, this is
-    specified as a string.
-
-    You can specify multiple secrets by putting each secret on its own line:
+-   <a name="secrets"></a><a href="#user-content-secrets"><code>secrets</code></a>: _(Required)_ List of secrets to access and inject into the environment. These are
+    comma-separated or newline-separated `OUTPUTNAME:SECRET`. Output names or
+    secret names that contain separators must be escaped with a backslash
+    (e.g. `\,` or `\\n`) unless quoted. Any leading or trailing whitespace is
+    trimmed unless values are quoted.
 
     ```yaml
     secrets: |-

diff --git a/action.yml b/action.yml
@@ -21,11 +21,11 @@ description: |-
 inputs:
   secrets:
     description: |-
-      The list of secrets to access and inject into the
-      environment. Due to limitations with GitHub Actions inputs, this is
-      specified as a string.
-
-      You can specify multiple secrets by putting each secret on its own line:
+      List of secrets to access and inject into the environment. These are
+      comma-separated or newline-separated `OUTPUTNAME:SECRET`. Output names or
+      secret names that contain separators must be escaped with a backslash
+      (e.g. `\,` or `\\n`) unless quoted. Any leading or trailing whitespace is
+      trimmed unless values are quoted.
 
       ```yaml
       secrets: |-