Skip to content

Commit c1928b7

Browse files
author
noah
committed
Add the document for serialization
1 parent cc0a1d5 commit c1928b7

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

docs/concepts/deploy.yml.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,15 @@ 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
7079
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

docs/references/deploy.yml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Field |Type |Required |Description
2323
`production_environment` |*boolean* |`false` |This field specifies whether this runtime environment is production or not.
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.*`
26-
`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`.
2727
`frozen_windows` |*[\][Frozen Window](#frozen-window)* |`false` |This field configures to add a frozen window to prevent unintended deployment for the environment.
2828

2929
## Review

0 commit comments

Comments
 (0)