You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/concepts/how-it-work.md
+42-11Lines changed: 42 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,51 @@ sidebar_position: 1
4
4
5
5
# How it works
6
6
7
-
Gitploy builds the system around GitHub [deployment API](https://docs.github.com/en/rest/reference/deployments#deployments). **It's an event-driven decoupled way to deploy your code.** Internally, Gitploy creates a new Github deployment resource, and Github dispatches a deployment event that external services can listen for and act. It enables developers and organizations to build loosely coupled tooling.
7
+
Gitploy builds the system around GitHub [deployment API](https://docs.github.com/en/rest/reference/deployments#deployments). Deployment API is a request to deploy a specific ref (branch, SHA, tag), and GitHub dispatches an event to deployment toolings that can listen for and act on when a request is posted. **It's an event-driven decoupled way to deploy your code.** This article looks under the hood Gitploy interacts with deployment API.
8
8
9
-
This approach has several pros:
10
9
11
-
* Replace deployment tools easily without changing your deployment pipeline.
12
-
* Easy to implement details of deploying different types of applications (e.g., web, native).
10
+
## GitHub Deployment API
11
+
12
+
The deployment API consists of these stages:
13
+
14
+
1. A user selects a ref(branch, SHA, tag) to deploy.
15
+
2. Gitploy verifies the ref for deployment safety.
16
+
3. It requests GitHub to deploy a specific ref.
17
+
18
+
Of course, Gitploy follows these stages to deploy a ref and enhances each stage to use it easily and safely.
19
+
20
+
### Select a ref(branch, SHA, tag)
21
+
22
+
A ref can be any named branch, tag, or SHA, and it is determined by how to deploy an application. If an application uses semantic versioning, the ref should be a tag(e.g., `v0.5.5`).
23
+
24
+
Gitploy provides an intuitive UI similar to GitHub, enabling users to select a ref easily even though a user is a newcomer to the system. And it displays the details of a commit such as SHA, message, creator, and creation time. So it enables to let users know which commits are deployed.
25
+
26
+
### Verification
27
+
28
+
Before deploying a ref, it needs verification for deployment safety. The deployment API provides these verifications:
29
+
30
+
*`auto_merge`: Ensure that the requested ref is not behind the repository's default branch.
31
+
*`required_contexts`: Ensure that commit statuses are in that success state.
32
+
33
+
Gitploy provides the file (i.e., `deploy.yml`) to configure the parameters for each runtime environment, respectively.
34
+
35
+
### Event Dispatch
36
+
37
+
Gitploy posts a request to GitHub, and it dispatches an event to deployment toolings.
38
+
39
+
## Deployment Tooling
40
+
41
+
### Update status
42
+
43
+
After deployment, a deployment tooling must update the deployment status if it has succeeded or not by the [deployment status API](https://docs.github.com/en/rest/reference/deployments#deployment-statuses). It enables Gitploy to sync the deployment status and display the deployment status with a redirection link for the deployment details, such as logs.
Copy file name to clipboardExpand all lines: docs/index.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ sidebar_position: 1
3
3
title: What is Gitploy?
4
4
---
5
5
6
-
Gitploy is a tooling that helps your organization build the deployment system in minutes. It enables your organization **to deploy in the same manner** without worrying about the details of different types of applications and **to deploy differently** for each application, respectively. And as a result, your organization can get a robust system to deploy fast and safely. 🚀
6
+
Gitploy is a tooling that helps your organization build the deployment system in minutes. It enables your organization **to deploy in the same manner** without worrying about the implementation details of delivering different types of applications (e.g., web, native). and **to deploy differently** for each application by a simple configuration file, respectively. And as a result, your organization can get a robust system to deploy fast and safely. 🚀
7
7
8
8
## Deploy in the same manner
9
9
@@ -19,7 +19,7 @@ Gitploy provides an intuitive UI similar to GitHub. Users can select one of the
19
19
20
20
## Deploy differently
21
21
22
-
Each application needs a customizable pipeline. If an organization has essential applications to deploy carefully, it should enforce a gateway like a review or deploy freeze window. And an organization chooses continuous delivery or continuous deployment for application.
22
+
Each application needs a customizable pipeline. If an organization has essential applications to deploy carefully, it should enforce a gateway like a review or deploy freeze window. And also an organization chooses continuous delivery or continuous deployment for application.
23
23
24
24
Gitploy provides a way **to configure a pipeline with a simple, easy‑to‑read file for each repository (each environment).** The default path is `deploy.yml` at the root directory, but you can replace the file path in the settings tab of Gitploy.
0 commit comments