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

Commit 44e2ff8

Browse files
author
Noah Hanjun Lee
authored
Fix documents (#215)
* Fix the document for review * Fix the document for metrics * Add GitHub Action integration
1 parent e077536 commit 44e2ff8

File tree

4 files changed

+38
-3
lines changed

4 files changed

+38
-3
lines changed

docs/concepts/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ GITPLOY_PROMETHEUS_AUTH_SECRET=YOUR_SECRET
1313

1414
2\. Configure the prometheus scraper:
1515

16-
```
16+
```yaml
1717
global:
1818
scrape_interval: 60s
1919

docs/concepts/review.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Gitploy has the review to require at least one approval for the deployment. You
44

55
## Review process
66

7-
1\. First, to enable review, you must configure like the below:
7+
1\. To enable review, you must configure like the below:
88

99
```yaml
1010
envs:
@@ -15,4 +15,6 @@ envs:
1515
reviewers: ["USER_LOGIN"]
1616
```
1717
18-
2\. When the user deploys, Gitploy request a review to reviewers. And the deployment is waiting until one of reviews is approved.
18+
2\. When the user deploys in the 'deploy' tab, Gitploy request a review to reviewers. And the deployment is waiting until one of reviews is approved.
19+
20+
![review](../images/review.png)

docs/images/review.png

39.5 KB
Loading

docs/tasks/integration.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
11
# Integration
22

3+
## GitHub Action
4+
5+
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.
6+
7+
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.
8+
9+
```yaml
10+
# Listening the deployment event
11+
on:
12+
deployment
13+
14+
jobs:
15+
deploy-dev:
16+
runs-on: ubuntu-latest
17+
# Run a job when the environment is 'production.
18+
if: ${{ github.event.deployment.environment == 'production' }}
19+
steps:
20+
-
21+
name: Checkout
22+
uses: actions/checkout@v2
23+
-
24+
name: Start to deploy
25+
uses: chrnorm/deployment-status@releases/v1
26+
with:
27+
deployment_id: ${{ github.event.deployment.id }}
28+
description: Start to deploy ...
29+
state: "in_progress"
30+
token: "${{ github.token }}"
31+
# Run your deployment commands.
32+
```
33+
34+
### Step 2:
35+
336
## Slack
437

538
Slack integration provides Chatops (i.e. deploy, rollback) and notification alert for events.

0 commit comments

Comments
 (0)