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
2 changes: 1 addition & 1 deletion docs/concepts/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ GITPLOY_PROMETHEUS_AUTH_SECRET=YOUR_SECRET

2\. Configure the prometheus scraper:

```
```yaml
global:
scrape_interval: 60s

Expand Down
6 changes: 4 additions & 2 deletions docs/concepts/review.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Gitploy has the review to require at least one approval for the deployment. You

## Review process

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

```yaml
envs:
Expand All @@ -15,4 +15,6 @@ envs:
reviewers: ["USER_LOGIN"]
```

2\. When the user deploys, Gitploy request a review to reviewers. And the deployment is waiting until one of reviews is approved.
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.

![review](../images/review.png)
Binary file added 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.
33 changes: 33 additions & 0 deletions docs/tasks/integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,38 @@
# Integration

## GitHub Action

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.

```yaml
# Listening the deployment event
on:
deployment

jobs:
deploy-dev:
runs-on: ubuntu-latest
# Run a job when the environment is 'production.
if: ${{ github.event.deployment.environment == 'production' }}
steps:
-
name: Checkout
uses: actions/checkout@v2
-
name: Start to deploy
uses: chrnorm/deployment-status@releases/v1
with:
deployment_id: ${{ github.event.deployment.id }}
description: Start to deploy ...
state: "in_progress"
token: "${{ github.token }}"
# Run your deployment commands.
```

### Step 2:

## Slack

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