Skip to content

Commit db16ee1

Browse files
author
Noah Lee
authored
Enhance the document for review, and lock (#27)
* Fix the document for review * Fix the doc for locking
1 parent 2d66bae commit db16ee1

File tree

4 files changed

+19
-18
lines changed

4 files changed

+19
-18
lines changed

docs/concepts/deployment.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@ We generally run `git revert` and merge the code to roll back. But in this proce
2020

2121
**Gitploy provides a quick and easy one-click rollback.** The UI shows a list of completed deployments of which status is `success` when the user selects a runtime environment. And the first option is just the previous deployment.
2222

23-
After that, when the user clicks rollback, Gitploy fetches the payload from the previous deployment and sends a deployment request with the payload to Github. The `ref` from the previous distribution is used in this case. *However, if the ref of the previous deployment is a branch, Gitploy uses SHA to prevent the head of the branch from being deployed.* And `auto_merge: false` is set internally to avoid merge conflicts when rollback.
23+
After that, when the user clicks rollback, Gitploy fetches the payload from the previous deployment and sends a deployment request with the payload to Github. The `ref` from the previous deployment is used in this case. *However, if the ref of the previous deployment is a branch, Gitploy uses SHA to prevent the head of the branch from being deployed.*
2424

25+
*Note that `auto_merge: false` is set internally to avoid merge conflicts when rollback.*
2526

2627
![Rollback](../../static/img/docs/rollback.png)
2728

docs/concepts/lock.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,12 @@ sidebar_position: 5
44

55
# Lock
66

7-
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.
7+
## Locking deployments
88

9-
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.
9+
There are some situations where you may want to block a deployment. If someone else deploys to the same environment while debugging in the production environment, this may worsen the issue. In this case, the locking deployments buy time to resolve the issue as you see fit.
1010

11-
![lock](../../static/img/docs/lock.png)
11+
Gitploy provides locking for each environment. You can use it simply by clicking the 'LOCK' button.
12+
13+
Gitploy also provides automatic unlocking. Generally, users forget to unlock after locking. The auto-unlock provides a function automatically unlocked after a specific time. It can be set to be unlocked after a certain period that requires locking for a certain period, such as canary deployment.
14+
15+
![Lock](../../static/img/docs/lock.png)

docs/concepts/review.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,26 @@ sidebar_position: 4
44

55
# Review
66

7-
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.
8-
9-
## Review process
10-
11-
1\. To enable review, you must configure the `review` field first.
7+
## About required review
8+
Users can enable the review in the `deploy.yml` file for each environment, and the users who review are specified here. Reviewers must have at least read permission.
129

1310
```yaml title="deploy.yml"
1411
envs:
1512
- name: production
1613
review:
1714
enabled: true
18-
reviewers: ["USER_LOGIN1", "USER_LOGIN2"]
15+
reviewers: ["octocat", "dreamer"]
1916
```
2017
21-
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.
22-
23-
![Changes](../../static/img/docs/changes.png)
18+
After the review is enabled, reviews are requested when a user deploys. And the deployment waits until a review is approved and has a status of `waiting`. Only one of the required reviewers needs to approve it to proceed. If one rejects it, deployment is not possible. If a deployment is not approved within 30 minutes, it will be automatically canceled.
2419

25-
3\. Finally, a reviewer confirms to approve or reject the deployment, and the `deploy` button will be enabled if a reviewer approves.
26-
27-
*I recommend that a reviewer use the `Approve and Deploy` to let a reviewer acknowledges that the deployment is started.*
20+
The notification will navigate to the deployment page when a review is requested. And when the reviewer presses the 'Review' button on the page, a pop-up shows options for approval and rejection. To approve, click **Approve and Deploy**. After approved, the deployment will proceed (after any deployment protection rules have passed).
2821

2922
![Review](../../static/img/docs/review.png)
3023

31-
## Notification
24+
## Pro Tips
25+
26+
### Confirm Changes
27+
The 'Changes' field at the bottom of the page shows what changes have been made. Reviewers can quickly check what has changed through the commit messages.
3228

33-
Gitploy notifies users when a review is requested or responded to. You can check the [documentation](./notification.md) for the detail.
29+
![Changes](../../static/img/docs/changes.png)

static/img/docs/lock.png

3.91 KB
Loading

0 commit comments

Comments
 (0)