Skip to content

Commit afbc459

Browse files
authored
Update README.md
1 parent c5a83a5 commit afbc459

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This is a GitHub bot that simplifies the process of deployment for organizations from multiple interconnected repositories.
44

5+
It listens certain [GitHub events](https://docs.github.com/en/developers/webhooks-and-events/events) (pull request, commit) and triggers a new deployment to be created for defined applications.
6+
7+
That allows your dev team to develop and deploy their code to personal dev environments e.g. `https://pull-123.customer-domain.com` managed by Kubernetes.
8+
59

610
## Diagram flow
711

@@ -15,6 +19,53 @@ This is a GitHub bot that simplifies the process of deployment for organizations
1519
3. Follow install instructions inside the bot to conect it to GitHub organization.
1620
4. Try to make a PR in a repository, that defined in the `config.yaml` file.
1721

22+
## Configuration
23+
24+
Configuration file should be located at: `.infraway/config.yaml`
25+
26+
```yaml
27+
domain: domain.tech
28+
29+
events:
30+
pull_request_opened: "deploy" # or "ignore", deploy by default
31+
pull_request_reopened: "deploy" # or "ignore", deploy by default
32+
commit: "deploy" # or "ignore", deploy by default
33+
34+
stale_pull_cleanup:
35+
enabled: true
36+
duration: "7 days"
37+
38+
deploy:
39+
- name: repo-name1
40+
components:
41+
- name: web
42+
chart: ./charts/web
43+
needs:
44+
- static
45+
version: commit
46+
- name: static
47+
version: release
48+
repo: repo-name2
49+
- name: api
50+
chart: ./charts/web.api
51+
needs: # a dependency on another component, when deploy happens, both components will be redeployed
52+
- db
53+
version: commit
54+
- name: db
55+
version: data
56+
- name: mailer
57+
addon: true # a component which is not installed by default with push, but can be added by a comment
58+
version: release
59+
60+
versions:
61+
- name: commit
62+
description: latest commit made in the repo (default value)
63+
- name: release
64+
description: latest release from the repo
65+
- name: ^.+$
66+
description: predefined version
67+
```
68+
1869
## Docker
1970
2071
```sh

0 commit comments

Comments
 (0)