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

Commit afc8c3a

Browse files
author
Noah Hanjun Lee
authored
Add the document for review (#203)
1 parent 01ce6fd commit afc8c3a

File tree

6 files changed

+26
-39
lines changed

6 files changed

+26
-39
lines changed

docs/concepts/approval.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/concepts/deploy.yml.md

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@ Gitploy configures a pipeline with a simple, easy‑to‑read file that you comm
44

55
## Environments
66

7-
The configuration file is configured for each environment, respectively. The following example is the fundamental structure of a configuration file.
8-
9-
<details>
10-
<summary>Fundamental structure</summary>
7+
You can configure each environments, respectively. The configuration have to be under the `evns` field. The following example show each environments have different configuration.
118

129
```yaml
1310
envs:
@@ -21,42 +18,29 @@ envs:
2118
- docker-image
2219
```
2320
24-
</details>
25-
26-
## Parameters for Github deployment API
21+
## Parameters of GitHub deployment API
2722
28-
When Gitploy deploys, it posts a new deployment to GitHub [deployments API](https://docs.github.com/en/rest/reference/repos#create-a-deployment) with parameters from the configuration file. The configuration file provides fields to configure all parameters of GitHub deployment API. You can check the [document](../references/deploy.yml.md) for the detail.
29-
30-
<details>
31-
<summary>GitHub parameter field</summary>
23+
Internally, Gitploy posts a deployment to GitHub [deployments API](https://docs.github.com/en/rest/reference/repos#create-a-deployment) with parameters from the configuration file. These parameter help you can verify the artifact before you start to deploy. The configuration file provides fields to configure all parameters of GitHub deployment API. You can check the [document](../references/deploy.yml.md) for the detail.
3224
3325
```yaml
3426
envs:
3527
- name: production
3628
task: deploy:lambda
37-
description: Start to deploy to the production.
29+
description: Start deploying to the production.
3830
auto_merge: false
3931
required_contexts:
4032
- test
4133
- integration-test
4234
production_environment: true
4335
```
36+
## Review
4437
45-
</details>
46-
47-
## Approval
48-
49-
Gitploy provides the approval step to protect to deploy until it matches the required approving approvals.
50-
51-
<details>
52-
<summary>Enable Approval</summary>
38+
Gitploy provides the review process. You can list up to users on the configuration file. You can check the [document](./review.md) for the detail.
5339
5440
```yaml
5541
envs:
5642
- name: production
57-
approval:
43+
review:
5844
enabled: true
59-
required_count: 1
45+
reviewers: ["ocotocat", "noah"]
6046
```
61-
62-
</details>

docs/concepts/permission.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The permission of the repository is determined while Gitploy synchronizes with G
99

1010
Here are capabilities for each permission:
1111

12-
* **Read** - Users can read all activities that happened in the repository, such as deployments, approvals. And users are also capable of responding to the approval.
12+
* **Read** - Users can read all activities that happened in the repository, such as deployments, reviews. And users are also capable of responding to the review.
1313

1414
* **Write** - Users can lock, deploy, and rollback.
1515

docs/concepts/review.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Review
2+
3+
Gitploy has the review to require at least one approval for the deployment. You can list up to users on the configuration file. The reviewers must have at least read access to the repository.
4+
5+
```yaml
6+
envs:
7+
- name: production
8+
auto_merge: true
9+
review:
10+
enabled: true
11+
reviewers: ["octocat", "noah"]
12+
```

docs/references/deploy.yml.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ Field |Type |Required |Description
1717
`required_contexts` |*[]string* |`false` |This field allows you to specify a subset of contexts that must be success.
1818
`payload` |*object* or *string* |`false` |This field is JSON payload with extra information about the deployment.
1919
`production_environment` |*boolean* |`false` |This field specifies whether this runtime environment is production or not.
20-
`approval` |*[Approval](#approval)* |`false` |This field configures approval.
20+
`review` |*[Review](#review)* |`false` |This field configures review.
2121

22-
## Approval
22+
## Review
2323

2424
Field |Type |Tag |Description
2525
--- |--- |--- |---
26-
`enabled` |*boolean* |`true` |This field make to enable the approval feature. The default value is `false`.
27-
`required_count` |*integer* |`false` |This field determine how many the required approving approvals is needs to deploy. The default value is `0`.
26+
`enabled` |*boolean* |`true` |This field make to enable the review feature. The default value is `false`.
27+
`reviewers` |*[]string* |`false` |This field list up reviewers. The default value is `[]`. You should specify maintainers of the project.
2828

2929
## Variables
3030

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ nav:
1515
- "How it works": concepts/how-it-work.md
1616
- "deploy.yml": concepts/deploy.yml.md
1717
- Deployment: concepts/deployment.md
18-
- Approval: concepts/approval.md
18+
- Review: concepts/review.md
1919
- Lock: concepts/lock.md
2020
- Permission: concepts/permission.md
2121
- Chatops: concepts/chatops.md

0 commit comments

Comments
 (0)