Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/concepts/lock.md
Original file line number Diff line number Diff line change
@@ -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)
21 changes: 15 additions & 6 deletions docs/concepts/review.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added docs/images/changes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/review.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/tasks/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down