Skip to content

Commit 9385f53

Browse files
author
Noah Lee
authored
Add the document for the serialization field (#47)
* Add the document for serialization * Embold essential sentence * Reorder the fields of 'deploy.yml'
1 parent 7685251 commit 9385f53

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

docs/concepts/deploy.yml.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ envs:
3939
4040
### Deployable Ref
4141
42-
The `ref` can be any named branch, tag, or SHA. But sometimes, a `ref` must be specific branches or tags. You can verify a `ref` matched with the format by configuring the `deployable_ref` field. And this configuration also supports a regular expression.
42+
The `ref` can be any named branch, tag, or SHA. But sometimes, a `ref` must be specific branches or tags. **You can verify a `ref` matched with the regular expression** by configuring the `deployable_ref` field.
4343

4444
```yaml title="deploy.yml"
4545
envs:
@@ -48,7 +48,7 @@ envs:
4848
```
4949

5050
### Deploy Freeze Window
51-
If you want to prevent deployments for a particular period, such as during a planned vacation period or out of working time, you can configure the `frozen_windows` field. During a deploy freeze period, users can not execute any deployment.
51+
**If you want to prevent deployments for a particular period**, such as during a planned vacation period or out of working time, you can configure the `frozen_windows` field. During a deploy freeze period, users can not execute any deployment.
5252

5353
And this configuration uses the cron expression to handle repetitive periods. You can check the detail in the [documentation](../references/deploy.yml.md).
5454

@@ -66,8 +66,17 @@ envs:
6666
location: Asia/Seoul
6767
```
6868

69+
### Serialization
70+
**Serialization forces only one deployment to run for the same environment.** If deployment is running for a specific environment, users cannot deploy until the deployment is finished. In particular, serialization is helpful in long-running deployment strategies, such as canary deployments, as it prevents other deployments.
71+
72+
```yaml title="deploy.yml"
73+
envs:
74+
- name: production
75+
serialization: true
76+
```
77+
6978
### Review
70-
If you require a specific person, such as a service owner or product manager, to review what is deployed before deployment, you can configure the `review` field. You can list up users as reviewers under the `review` field. Then Gitploy requests a review to users by sending a notification when a deployment is triggered.
79+
**If you require a specific person, such as a service owner or product manager, to review what is deployed before deployment**, you can configure the `review` field. You can list up users as reviewers under the `review` field. Then Gitploy requests a review to users by sending a notification when a deployment is triggered.
7180

7281
```yaml title="deploy.yml"
7382
envs:

docs/references/deploy.yml.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,16 @@ Field |Type |Required |Description
1717
`name` |*string* |`true` |This field is the runtime environment such as `production`, `staging`, and `qa`.
1818
`task` |*string* |`false` |This field is used by the deployment system to distinguish the kind of deployment. Default is `deploy`. (*Only for GitHub*)
1919
`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*)
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, GitHub will attempt to merge it for you. Default is `true`, but Gitploy set `false` for rollback. (*Only for GitHub*)
2121
`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*)
2222
`payload` |*object* or *string* |`false` |This field is JSON payload with extra information about the deployment. Default is `null`. (*Only for GitHub*)
23-
`dyanmic_payload` |*[Dynamic Payload](#dynamic-payload)* |`false` |This field dynamically generates JSON payload about the deployment.(*Only for `GitHub`*)
23+
`dyanmic_payload` |*[Dynamic Payload](#dynamic-payload)* |`false` |This field dynamically generates JSON payload about the deployment.(*Only for GitHub*)
2424
`production_environment` |*boolean* |`false` |This field specifies whether this runtime environment is production or not. Default is `true`.
25-
`deployable_ref` |*string* |`false` |This field specifies which the ref(branch, SHA, tag) is deployable or not. It supports the regular expression `re2`.
2625
`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.*`
27-
`review` |*[Review](#review)* |`false` |This field configures reviewers.
26+
`deployable_ref` |*string* |`false` |This field specifies which the ref(branch, SHA, tag) is deployable or not. It supports the regular expression `re2`.
2827
`frozen_windows` |*[\][Frozen Window](#frozen-window)* |`false` |This field configures to add a frozen window to prevent unintended deployment for the environment.
28+
`serialization` |*boolean* |`false` |This field forces only one deployment to run for the environment.
29+
`review` |*[Review](#review)* |`false` |This field configures reviewers.
2930

3031
## Review
3132

0 commit comments

Comments
 (0)