Skip to content

Commit 4871c25

Browse files
author
Noah Lee
authored
Add default for GitHub fields (#49)
1 parent cc0a1d5 commit 4871c25

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/references/deploy.yml.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ sidebar_position: 1
77

88
Field |Type |Required |Description
99
--- |---- |--- |---
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.
1111

1212
## Env
1313

1414

1515
Field |Type |Required |Description
1616
--- |---- |--- |---
1717
`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`.
2424
`deployable_ref` |*string* |`false` |This field specifies which the ref(branch, SHA, tag) is deployable or not. It supports the regular expression `re2`.
2525
`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.*`
2626
`review` |*[Review](#review)* |`false` |This field configures reviewers.
@@ -30,16 +30,16 @@ Field |Type |Required |Description
3030

3131
Field |Type |Required |Description
3232
--- |--- |--- |---
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.
3535

3636
## Frozen Window
3737

3838
Field |Type |Required |Description
3939
--- |--- |--- |---
4040
`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.
4141
`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.
4343

4444
## Variables
4545

0 commit comments

Comments
 (0)