diff --git a/docs/concepts/lock.md b/docs/concepts/lock.md index 81bde7b4..8bb92ce3 100644 --- a/docs/concepts/lock.md +++ b/docs/concepts/lock.md @@ -1,9 +1,7 @@ # Lock -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. +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. -You can lock the environment simply by clicking the button in the UI. - -Figure) Lock +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. ![lock](../images/lock.png) diff --git a/docs/concepts/review.md b/docs/concepts/review.md index 334cf51a..af5d2d7c 100644 --- a/docs/concepts/review.md +++ b/docs/concepts/review.md @@ -1,20 +1,29 @@ # Review -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. +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. ## Review process -1\. To enable review, you must configure like the below: +1\. To enable review, you must configure the `review` field first. ```yaml envs: - name: production - auto_merge: true review: enabled: true - reviewers: ["USER_LOGIN"] + reviewers: ["USER_LOGIN1", "USER_LOGIN2"] ``` -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. +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. -![review](../images/review.png) +![Changes](../images/changes.png) + +3\. Finally, a reviewer confirms to approve or reject the deployment, and the `deploy` button will be enabled if a reviewer approves. + +*I recommend that a reviewer use the `Approve and Deploy` to let a reviewer acknowledges that the deployment is started.* + +![Review](../images/review.png) + +## Notification + +Gitploy notifies users when a review is requested or responded to. You can check the [documentation](./notification.md) for the detail. \ No newline at end of file diff --git a/docs/images/changes.png b/docs/images/changes.png new file mode 100644 index 00000000..636380e4 Binary files /dev/null and b/docs/images/changes.png differ diff --git a/docs/images/review.png b/docs/images/review.png index 5a9ac9b0..3a4e8654 100644 Binary files a/docs/images/review.png and b/docs/images/review.png differ diff --git a/docs/tasks/integration.md b/docs/tasks/integration.md index 466eddd5..807090a2 100644 --- a/docs/tasks/integration.md +++ b/docs/tasks/integration.md @@ -4,7 +4,7 @@ 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. -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. +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. ```yaml # Listening the deployment event