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

Commit 03cfcce

Browse files
author
Noah Lee
authored
Add the documentation for auto deploy (#260)
1 parent e3633d4 commit 03cfcce

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Gitploy makes your team or organization **build the deployment system around Git
3535
Name | Gitploy | GitHub environment
3636
--- |--- |---
3737
Manual deploy | ✅ | ✅
38+
Auto deploy | ✅ | ✅
3839
Review | ✅ | ✅
3940
Rollback | ✅ | ❌
4041
Lock environment | ✅ | ❌

docs/concepts/deployment.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@ Gitploy provides two types of deployment: Deploy and Rollback.
44

55
## Deploy
66

7-
Deploying is the primary feature of Gitploy. When you deploy, you have to select the environment and the reference. The environment is one of the environments defined in the configuration file (i.e., deploy.yml). And for reference, you can choose one of commit, branch, and tag.
7+
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.
88

99
When you deploy the ref, Gitploy post the deployment to GitHub, and Github dispatch the event to external services.
1010

1111
Figure) Deploy
1212

1313
![deploy](../images/deploy.png)
1414

15+
## Auto Deploy
16+
17+
Gitploy provides not only manual deployment but also auto-deployment. Gitploy is listening for the push event dispatched from GitHub and trigger to deploy automatically when the ref is matched with the `auto_deploy_on` of the configuration file.
18+
1519
## Rollback
1620

1721
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.

0 commit comments

Comments
 (0)