Skip to content

Commit 7bac623

Browse files
author
Noah Lee
authored
Enhance the 'Deployment' documentation (#22)
* Enhance the 'deployment' docs * Add the title
1 parent 13cdae7 commit 7bac623

File tree

4 files changed

+18
-10
lines changed

4 files changed

+18
-10
lines changed

docs/concepts/deployment.md

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

55
# Deployment
66

7-
Gitploy provides two types of deployment: Deploy and Rollback.
7+
## Deploy & Rollback
88

9-
## Deploy
9+
### Deploy
10+
**Gitploy provides an intuitive UI that allows users to deploy a specific `ref`.** The UI provides three types of `ref`: *commit*, *branch*, and *tag*. The UI shows a list of options for each type. For example, the UI shows the current commit list with information such as SHA, description, committer if the user selects a commit.
1011

11-
Deploying is the primary feature of Gitploy. When you deploy, you have to select the environment and the reference. You can choose one of the environments defined in the configuration file (i.e. `deploy.yml`). You can select a commit, branch, or tag for reference.
12+
When the user selects `ref`, an icon indicating the commit's status appears on the right, and you can check the subset of contexts by clicking the icon. This information can be handy if you use the `required_contexts` field, which specifies a subset of contexts that must be `success`.
1213

13-
When you deploy the ref, Gitploy post the deployment to GitHub, and Github dispatch the event to external services.
14+
After that, when you click the deploy button, Gitploy sends a deployment request to GitHub. The selected `ref` is used as a request parameter when requesting. And other parameters are filled with `deploy.yml` field values.
1415

15-
![deploy](../../static/img/docs/deploy.png)
16+
![Deploy](../../static/img/docs/deploy.png)
1617

17-
## Rollback
18+
### Rollback
19+
We generally run `git revert` and merge the code to roll back. But in this process, we must wait for CI for a long time, which causes an impact on users. Therefore, the rollback must be done quickly and accurately.
1820

19-
Rollback is the best way to recover while you fix the problems, and Gitploy supports the rollback. You can choose one of the deployed references for the environment to roll back.
21+
**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.
2022

21-
When you roll back to the specific reference, Gitploy posts a new deployment with the reference from the rollbacked deployment. *Note that if the reference of the rollbacked deployment is a branch, Gitploy automatically references the commit SHA to avoid deploying the head of the branch.*
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.
2224

23-
For best practice, you should lock the environment to block deploying by others until finishing to fix the problems. Gitploy provide the 'lock' feature in UI and Chatops.
2425

25-
![rollback](../../static/img/docs/rollback.png)
26+
![Rollback](../../static/img/docs/rollback.png)
27+
28+
## Deployment Status
29+
Gitploy provides the UI to view the status after deployment. If you click `View Detail` of the deployment history on the Home tab, the link will take you to the page.
30+
31+
The page allows you to follow up on the changes through the status field. Each status has a description, update time, and a `View` link. The `View` link, when clicked, takes you directly to a deployment tooling and displays details.
32+
33+
![Status](../../static/img/docs/status.png)

static/img/docs/deploy.png

11.7 KB
Loading

static/img/docs/rollback.png

-20.8 KB
Loading

static/img/docs/status.png

44.3 KB
Loading

0 commit comments

Comments
 (0)