story(docs): add labels to readme (#49)

* build(issue-47): update workflow to create coverage badge

* docs(issue-47): add badges to readme

* build(issue-47): missing one thing

* chore(docs): update coverage badge

* build(issue-47): add workflow for updating coverage badge

* chore(docs): updated coverage badge.

* docs(issue-47): clean up order of badges a bit

---------

Co-authored-by: Zaba505 <[email protected]>
Co-authored-by: GitHub Action <[email protected]>

.github/workflows/build.yaml

@@ -1,4 +1,4 @@
-name: Go
+name: CI
 
 on:
   push:
@@ -10,6 +10,10 @@ jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
+    permissions:
+      # Give the default GITHUB_TOKEN write permission to commit and push the
+      # added or changed files to the repository.
+      contents: write
     steps:
         - name: Checkout
           uses: actions/checkout@v4

.github/workflows/coverage.yaml

@@ -0,0 +1,52 @@
+name: Generate code coverage badge
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Update coverage badge
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
+
+      - name: Setup go
+        uses: actions/setup-go@v4
+        with:
+          go-version-file: 'go.mod'
+
+      - name: Run Test
+        run: |
+          go test -v ./... -covermode=count -coverprofile=coverage.out
+          go tool cover -func=coverage.out -o=coverage.out
+
+      - name: Go Coverage Badge  # Pass the `coverage.out` output to this action
+        uses: tj-actions/coverage-badge-go@v2
+        with:
+          filename: coverage.out
+
+      - name: Verify Changed files
+        uses: tj-actions/verify-changed-files@v16
+        id: verify-changed-files
+        with:
+          files: README.md
+
+      - name: Commit changes
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add README.md
+          git commit -m "chore(docs): updated coverage badge."
+
+      - name: Push changes
+        if: steps.verify-changed-files.outputs.files_changed == 'true'
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ github.token }}
+          branch: ${{ github.head_ref }}

README.md

@@ -1,4 +1,8 @@
 # bedrock
+[![Go Reference](https://pkg.go.dev/badge/github.com/z5labs/bedrock.svg)](https://pkg.go.dev/github.com/z5labs/bedrock)
+[![Go Report Card](https://goreportcard.com/badge/github.com/z5labs/bedrock)](https://goreportcard.com/report/github.com/z5labs/bedrock)
+![Coverage](https://img.shields.io/badge/Coverage-93.5%25-brightgreen)
+[![build](https://github.com/z5labs/bedrock/actions/workflows/build.yaml/badge.svg)](https://github.com/z5labs/bedrock/actions/workflows/build.yaml)
 
 bedrock provides a minimal, modular and composable foundation for
 quickly developing services and more use case specific frameworks in Go.