8000 Add the document for default values of the GitHub fields by noahingh · Pull Request #49 · gitploy-io/gitploy-io.github.io · GitHub
[go: up one dir, main page]
Skip to content

Add the document for default values of the GitHub fields #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2022
Merged

Add the document for default values of the GitHub fields #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/references/deploy.yml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@ sidebar_position: 1

Field |Type |Required |Description
--- |---- |--- |---
`envs` |*[\][Env](#env)* |`true` |Thie field configures the pipeline for each environment, respectively.
`envs` |*[\][Env](#env)* |`true` |Thie field configures the pipeline for each environment, respectively.

## Env


Field |Type |Required |Description
--- |---- |--- |---
`name` |*string* |`true` |This field is the runtime environment such as `production`, `staging`, and `qa`.
`task` |*string* |`false` |This field is used by the deployment system to distinguish the kind of deployment. (*Only for `GitHub`*)
`description` |*string* |`false` |This field is the short description of the deployment. (*Only for `GitHub`*)
`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`*)
`required_contexts` |*[]string* |`false` |This field allows you to specify a subset of contexts that must be success. (*Only for `GitHub`*)
`payload` |*object* or *string* |`false` |This field is JSON payload with extra information about the deployment. (*Only for `GitHub`*)
`production_environment` |*boolean* |`false` |This field specifies whether this runtime environment is production or not.
`task` |*string* |`false` |This field is used by the deployment system to distinguish the kind of deployment. Default is `deploy`. (*Only for GitHub*)
`description` |*string* |`false` |This field is the short description of the deployment. (*Only for GitHub*)
`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*)
`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*)
`payload` |*object* or *string* |`false` |This field is JSON payload with extra information about the deployment. Default is `null`. (*Only for GitHub*)
`production_environment` |*boolean* |`false` |This field specifies whether this runtime environment is production or not. Default is `true`.
`deployable_ref` |*string* |`false` |This field specifies which the ref(branch, SHA, tag) is deployable or not. It supports the regular expression `re2`.
`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.*`
`review` |*[Review](#review)* |`false` |This field configures reviewers.
Expand All @@ -30,16 +30,16 @@ Field |Type |Required |Description

Field |Type |Required |Description
--- |--- |--- |---
`enabled` |*boolean* |`false` |This field makes to enables the review feature. The default value is `false`.
`reviewers` |*[]string* |`false` |This field list up reviewers. The default value is `[]`. You should specify the maintainers of the project.
`enabled` |*boolean* |`false` |This field makes to enables the review feature. Default is `false`.
`reviewers` |*[]string* |`false` |This field list up reviewers. Default is `[]`. You should specify the maintainers of the project.

## Frozen Window

Field |Type |Required |Description
--- |--- |--- |---
`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.
`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`.
`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.
`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.

## Variables

Expand Down
0