Skip to content

Commit

Permalink
chore: update readme and add coveralls code coverage
Browse files Browse the repository at this point in the history
Signed-off-by: Otieno Calvine <nyarangaotieno@gmail.com>
  • Loading branch information
NYARAS committed Jul 28, 2021
1 parent c1580d2 commit 705c62b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
9 changes: 9 additions & 0 deletions .github/workflows/ci.yml
Expand Up @@ -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
14 changes: 5 additions & 9 deletions README.md
Expand Up @@ -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:
Expand Down Expand Up @@ -118,5 +111,8 @@ export CHARGE_MASTER_GRANT_TYPE="<an auth server 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 ( <https://cloud.google.com/build> ) to Google Cloud Run ( <https://cloud.google.com/run> ).
There's a `cloudbuild.yaml` file in the home folder. Secrets (e.g production settings) are managed with Google Secret Manager ( <https://cloud.google.com/secret-manager> ).

0 comments on commit 705c62b

Please sign in to comment.