Skip to content

Commit e55f777

Browse files
committed
#1 add using this repo section in README
1 parent 140e306 commit e55f777

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
- [CICD Pipeline ](#cicd-pipeline)
1414
- [Build](#build)
1515
- [Run](#run)
16-
- [Local development](#local-development)
17-
- [Production](#production)
18-
- [References](#references)
16+
- [Local development](#local-development)
17+
- [Production](#production)
18+
- [Using this Repository](#using-this-repository)
1919
---
2020

2121
## Getting started
@@ -84,5 +84,19 @@ make deploy-minikube # deploys the application to your local Minikube cluster
8484
### Production
8585
Merge your feature branch to release candidate branch to execute deploy pipeline. Public URLs for documentation and api are defined on docker-compose. Take into consideration that public DNS must be created before the deployment because an automatic process will create a Let's Encrypt certificate right after the container is up and running in the server.
8686

87-
## References
88-
TBD
87+
## Using This Repository
88+
89+
To enable all integrations, create the following secrets:
90+
91+
- `COVERALLS_REPO_TOKEN`: Required for uploading coverage reports to [coveralls.io](https://coveralls.io/repos). Generate this token from your Coveralls account settings and add it as a secret. After setup, update the badge URL in the README if needed.
92+
- `REGISTRY_USER` and `REGISTRY_PASSWORD`: Docker Hub credentials used for building and pushing service images as part of the CI/CD pipeline.
93+
- `TELEGRAM_TOKEN` and `TELEGRAM_CHAT_ID`: Used to authenticate and identify TELEGRAM chat. Used within the pipeline for notifications.
94+
- `KUBECONFIG`: Base64-encoded Kubernetes config file for use by `kubectl` in GitHub Actions.
95+
96+
In order to get Base64 config you can do the following:
97+
98+
```bash
99+
base64 -w0 ~/.kube/config_vps
100+
# validate base64 string
101+
base64 -w0 ~/.kube/config_vps | base64 -d
102+
```

docs/pipelines/secrets.png

38.1 KB
Loading

0 commit comments

Comments
 (0)