Add docs for options of SCRIPT_RUN (#4738)

Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com>
pipe-cd · Dec 27, 2023 · 1864cdb · 1864cdb
1 parent 26f8ecb
commit 1864cdb
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/content/en/docs-dev/user-guide/configuration-reference.md b/docs/content/en/docs-dev/user-guide/configuration-reference.md
@@ -654,6 +654,13 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c
 | envs | map[string]string | Environment variables used with scripts. | No |
 | run | string | Script run on this stage. | Yes |
 
+### ScriptRunStageOptions
+| Field | Type | Description | Required |
+|-|-|-|-|
+| run | string | Script run on this stage. | Yes |
+| env | map[string]string | Environment variables used with scripts. | No |
+| timeout | duration | The maximum time the stage can be taken to run. Default is `6h`| No |
+
 ## PostSync
 
 | Field | Type | Description | Required |