You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/references/deploy.yml.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -7,20 +7,20 @@ sidebar_position: 1
7
7
8
8
Field |Type |Required |Description
9
9
--- |---- |--- |---
10
-
`envs` |*[\][Env](#env)* |`true`|Thie field configures the pipeline for each environment, respectively.
10
+
`envs` |*[\][Env](#env)* |`true` |Thie field configures the pipeline for each environment, respectively.
11
11
12
12
## Env
13
13
14
14
15
15
Field |Type |Required |Description
16
16
--- |---- |--- |---
17
17
`name` |*string* |`true` |This field is the runtime environment such as `production`, `staging`, and `qa`.
18
-
`task` |*string* |`false` |This field is used by the deployment system to distinguish the kind of deployment. (*Only for `GitHub`*)
19
-
`description` |*string* |`false` |This field is the short description of the deployment. (*Only for `GitHub`*)
20
-
`auto_merge` |*boolean* |`false` |This field is used to ensure that the requested ref is not behind the repository's default branch. If you deploy with the commit or the tag you need to set `false`. For rollback, Gitploy set the field `false`. (*Only for `GitHub`*)
21
-
`required_contexts` |*[]string* |`false` |This field allows you to specify a subset of contexts that must be success. (*Only for `GitHub`*)
22
-
`payload` |*object* or *string* |`false` |This field is JSON payload with extra information about the deployment. (*Only for `GitHub`*)
23
-
`production_environment` |*boolean* |`false` |This field specifies whether this runtime environment is production or not.
18
+
`task` |*string* |`false` |This field is used by the deployment system to distinguish the kind of deployment. Default is `deploy`. (*Only for GitHub*)
19
+
`description` |*string* |`false` |This field is the short description of the deployment. (*Only for GitHub*)
20
+
`auto_merge` |*boolean* |`false` |This field is used to ensure that the requested ref is not behind the repository's default branch. If the ref is behind the default branch for the repository, we will attempt to merge it for you. Default is `true`, but Gitploy set `false` for rollback. (*Only for GitHub*)
21
+
`required_contexts` |*[]string* |`false` |This field allows you to specify a subset of contexts that must be success. Defaults to all unique contexts. (*Only for GitHub*)
22
+
`payload` |*object* or *string* |`false` |This field is JSON payload with extra information about the deployment. Default is `null`. (*Only for GitHub*)
23
+
`production_environment` |*boolean* |`false` |This field specifies whether this runtime environment is production or not. Default is `true`.
24
24
`deployable_ref` |*string* |`false` |This field specifies which the ref(branch, SHA, tag) is deployable or not. It supports the regular expression `re2`.
25
25
`auto_deploy_on` |*string* |`false` |This field controls auto-deployment behaviour given a ref(branch, SHA, tag). If any new push events are detected on this event, the deployment will be triggered. It supports the regular expression ([re2](https://github.com/google/re2/wiki/Syntax)). E.g. `refs/heads/main` or `refs/tags/v.*`
26
26
`review` |*[Review](#review)* |`false` |This field configures reviewers.
@@ -30,16 +30,16 @@ Field |Type |Required |Description
30
30
31
31
Field |Type |Required |Description
32
32
--- |--- |--- |---
33
-
`enabled` |*boolean* |`false` |This field makes to enables the review feature. The default value is `false`.
34
-
`reviewers` |*[]string* |`false` |This field list up reviewers. The default value is `[]`. You should specify the maintainers of the project.
33
+
`enabled` |*boolean* |`false` |This field makes to enables the review feature. Default is `false`.
34
+
`reviewers` |*[]string* |`false` |This field list up reviewers. Default is `[]`. You should specify the maintainers of the project.
35
35
36
36
## Frozen Window
37
37
38
38
Field |Type |Required |Description
39
39
--- |--- |--- |---
40
40
`start` |*string* |`true` |This field is a cron expression to indicate when the window starts. For example, `55 23 * * *` means it starts to freeze a window before 5 minutes of midnight. You can check the [documentation](https://github.com/gitploy-io/cronexpr) for details.
41
41
`duration` |*string* |`true` |This field configures how long the window is frozen from the starting. The duration string is a possibly signed sequence of decimal numbers and a unit suffix such as `5m`, or `1h30m`. Valid time units are `ns`, `us`, `ms`, `s`, `m`, `h`.
42
-
`location` |*string* |`false` |This field configures the location of the `start` time. The value is taken to be a location name corresponding to a file in the IANA Time Zone database, such as `America/New_York`. The default value is `UTC`. You can check the [document](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the Time Zone database name.
42
+
`location` |*string* |`false` |This field configures the location of the `start` time. The value is taken to be a location name corresponding to a file in the IANA Time Zone database, such as `America/New_York`. Default is `UTC`. You can check the [document](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the Time Zone database name.
0 commit comments