Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.

Commit 1842826

Browse files
author
Noah Lee
authored
Enhance docs for review and lock (#307)
* Enhance the docs for review * Enhance the docs for lock
1 parent 5742cc6 commit 1842826

File tree

5 files changed

+18
-11
lines changed

5 files changed

+18
-11
lines changed

docs/concepts/lock.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# Lock
22

3-
The worst thing that can happen is someone deploys to the same repository during an incident. The lock helps with this. We provide the locking system to block deployments that are going out to the environment.
3+
The worst thing that can happen is someone deploys to the same repository during an incident. The lock helps with this. We provide the locking system to block deployments going out to the environment.
44

5-
You can lock the environment simply by clicking the button in the UI.
6-
7-
Figure) Lock
5+
You can lock the environment simply by clicking the `LOCK` button in the UI. And if you want to reserve unlock, you can configure the auto-unlock timer.
86

97
![lock](../images/lock.png)

docs/concepts/review.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,29 @@
11
# Review
22

3-
Gitploy has the review to require at least one approval for the deployment. You can list up to users on the configuration file. The reviewers must have at least read access to the repository.
3+
Gitploy has the review to require at least one approval for the deployment. You can list up to reviewers on the configuration file. The reviewers must be logged in and have read permission for the repository.
44

55
## Review process
66

7-
1\. To enable review, you must configure like the below:
7+
1\. To enable review, you must configure the `review` field first.
88

99
```yaml
1010
envs:
1111
- name: production
12-
auto_merge: true
1312
review:
1413
enabled: true
15-
reviewers: ["USER_LOGIN"]
14+
reviewers: ["USER_LOGIN1", "USER_LOGIN2"]
1615
```
1716
18-
2\. When the user deploys in the 'deploy' tab, Gitploy requests a review to reviewers. And the deployment is waiting until one of the reviews is approved.
17+
2\. When a user deploys in the 'deploy' tab, Gitploy automatically requests a review to reviewers. A reviewer should check what is changed from the latest one.
1918
20-
![review](../images/review.png)
19+
![Changes](../images/changes.png)
20+
21+
3\. Finally, a reviewer confirms to approve or reject the deployment, and the `deploy` button will be enabled if a reviewer approves.
22+
23+
*I recommend that a reviewer use the `Approve and Deploy` to let a reviewer acknowledges that the deployment is started.*
24+
25+
![Review](../images/review.png)
26+
27+
## Notification
28+
29+
Gitploy notifies users when a review is requested or responded to. You can check the [documentation](./notification.md) for the detail.

docs/images/changes.png

44.9 KB
Loading

docs/images/review.png

-7.84 KB
Loading

docs/tasks/integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
GitHub Actions help you automate tasks to run an actual deployment. GitHub Actions are event-driven, meaning that you can run a series of commands after a deployment event has occurred.
66

7-
To listening the deployment event, you must specify `deployment` for the `on` field. And you can use the `if` conditional to run a job for the specific environment. Here is the example below.
7+
You must specify `deployment` for the `on` field to listen for the deployment event. And you can use the `if` conditional to run a job for a specific environment. Here is the example below.
88

99
```yaml
1010
# Listening the deployment event

0 commit comments

Comments
 (0)