From f96883954b6e940e5387599c23c60d44d48ffad3 Mon Sep 17 00:00:00 2001 From: Otieno Calvine Date: Wed, 28 Jul 2021 16:10:31 +0300 Subject: [PATCH] chore: update readme and add coveralls code coverage Signed-off-by: Otieno Calvine --- .github/workflows/ci.yml | 9 +++++++++ README.md | 14 +++++--------- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 86881916..f675338b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -101,3 +101,12 @@ jobs: go tool cover -html=coverage.txt -o coverage.html gocov convert coverage.txt > coverage.json gocov report coverage.json > coverage_report.txt + + - name: Install goveralls + env: + GO111MODULE: off + run: go get github.com/mattn/goveralls + - name: Send coverage + env: + COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: goveralls -coverprofile=coverage.txt -service=github diff --git a/README.md b/README.md index cbfe26d1..c619dc5d 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,6 @@ This service manages user onboarding process. The project implements the `Clean Architecture` advocated by Robert Martin ('Uncle Bob'). - -## Documentation - -API documentation are available at: https://profile-service-docs-uyajqt434q-ew.a.run.app/ - -We should strive to always make the documentation reflect the true state of the service - ### Clean Architecture A cleanly architected project should be: @@ -118,5 +111,8 @@ export CHARGE_MASTER_GRANT_TYPE="" ``` -The server deploys to Google Cloud Run. The environment variables defined above -should also be set on Google Cloud Run. +Deployment +---------- + +This application is deployed via Google Cloud Build ( ) to Google Cloud Run ( ). +There's a `cloudbuild.yaml` file in the home folder. Secrets (e.g production settings) are managed with Google Secret Manager ( ).