From 297589bb42707dbaa41e5f59b760abe5bbcb0480 Mon Sep 17 00:00:00 2001 From: Nanda Kishore Date: Fri, 21 Jan 2022 14:29:21 +0530 Subject: [PATCH] Update Readme --- .github/workflows/build-image.yaml | 1 + README.md | 21 +++++++++++++++++---- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build-image.yaml b/.github/workflows/build-image.yaml index fa38948..5ba91ba 100644 --- a/.github/workflows/build-image.yaml +++ b/.github/workflows/build-image.yaml @@ -7,6 +7,7 @@ on: - "/*.sh" - ".gitignore" - "charts" + - "*.md" jobs: build-docker-image: diff --git a/README.md b/README.md index f2e00aa..627c7f2 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # hello-universe-go-app -hello-universe-go-app +`hello-universe-go-app`, a simple "Hello-Universe" service written in Go, with built-in Newrelic instrumentation. -# Run server +--- +## Run server ```sh go build -o server && ./server ``` -# Install as Helm chart +--- +## Install as Helm chart ```sh kubectl create ns hello-universe @@ -36,7 +38,8 @@ helm upgrade -v 3 \ . ``` -# Want to see Newrelic Instrumentation ? +--- +## Want to see Newrelic Instrumentation ? Supply the below environment variables with valid values and start the service. Thats all. * `NEW_RELIC_APP_NAME` @@ -50,3 +53,13 @@ go build -o server && ./server ``` Headover to Newrelic and find the application in "APM" screen. + +--- +## Create a Git Tag +Whenever a new release/tag has to be created, just update `version.go` and push it to `main` branch. A github workflow is already configured that creates the actual (git) tag, which will be available in https://github.com/none-da/hello-universe-go-app/tags page. + +> For now Github release creation is still manual. + +--- +## Create a Docker Image +Whenever a new tag is created (using the above mentioned steps), a github workflow automatically kicks-in, builds the docker images and pushes to [Dockerhub](https://hub.docker.com/r/nanda/hello-universe/tags?page=1&ordering=last_updated).