Docs: Refine README.md

.github/workflows/ci.yml

@@ -0,0 +1,104 @@
+name: ci
+
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+
+jobs:
+  preparation:
+    name: Prepare Deployment
+    runs-on: ubuntu-latest
+    outputs:
+      exec-tests: ${{ (steps.changes.outputs.exec-tests == 'true') }}
+    steps:
+      - name: Checkout Current Commit
+        uses: actions/checkout@v3
+
+      - name: Determine Changes
+        uses: dorny/paths-filter@v2
+        id: changes
+        with:
+          base: ${{ github.ref }}
+          filters: |
+            exec-tests:
+              - ".github/workflows/**"
+              - "internal/**"
+              - "build/**"
+              - "cmd/**"
+              - "deploy/**"
+              - "go.mod"
+              - "go.sum"
+              - "Makefile"
+
+      - name: Notify To Slack If Failed
+        uses: lazy-actions/[email protected]
+        if: failure()
+        with:
+          type: ${{ job.status }}
+          job_name: "*[hex-monscape]* ${{ github.job }}"
+          mention: "here"
+          mention_if: "failure"
+          channel: "#solutions-team-ci-cd"
+          icon_emoji: ":haraaj:"
+          username: "ci/cd-reporter"
+          url: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
+          commit: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  build-all:
+    name: Test Build All Container Images
+    needs: preparation
+    if: needs.preparation.outputs.exec-tests == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Current Commit
+        uses: actions/checkout@v3
+
+      - name: Run Build All
+        run: make test-build-all
+
+      - name: Notify To Slack If Failed
+        uses: lazy-actions/[email protected]
+        if: failure()
+        with:
+          type: ${{ job.status }}
+          job_name: "*[hex-monscape]* ${{ github.job }}"
+          mention: "here"
+          mention_if: "failure"
+          channel: "#solutions-team-ci-cd"
+          icon_emoji: ":haraaj:"
+          username: "ci/cd-reporter"
+          url: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
+          commit: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  run-tests:
+    name: Run Automated Tests
+    needs: preparation
+    if: needs.preparation.outputs.exec-tests == 'true'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Current Commit
+        uses: actions/checkout@v3
+
+      - name: Run Automated Tests
+        run: make test
+
+      - name: Notify To Slack If Failed
+        uses: lazy-actions/[email protected]
+        if: failure()
+        with:
+          type: ${{ job.status }}
+          job_name: "*[hex-monscape]* ${{ github.job }}"
+          mention: "here"
+          mention_if: "failure"
+          channel: "#solutions-team-ci-cd"
+          icon_emoji: ":haraaj:"
+          username: "ci/cd-reporter"
+          url: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
+          commit: true
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/coverage-badge.yml

@@ -0,0 +1,61 @@
+name: coverage-badge
+
+on:
+  push:
+    paths-ignore:
+      - 'Makefile'
+      - '**.md'
+      - 'docs/**'
+    branches: 
+      - master
+
+jobs:
+  gen-badge:
+    name: Generate Coverage Badge
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Current Commit
+        uses: actions/checkout@v3
+
+      - name: Generate Coverage Report
+        run: make test
+
+      - name: Install Go
+        uses: actions/[email protected]
+
+      - name: Install gobadge
+        run: go install github.com/AlexBeauchemin/gobadge@latest
+
+      - name: Generate Coverage Badge
+        run: |
+          # generate coverage badge
+          gobadge \
+            -filename=./.output/cov-report/coverage.out \
+            -green=80 \
+            -target=README.md \
+            -text=coverage \
+            -link=./.output/cov-report/coverage.out
+
+      - name: Auto Commit & Push Coverage Badge
+        uses: stefanzweifel/git-auto-commit-action@v4
+        id: auto-commit-action
+        with:
+          commit_message: "chore: update coverage report & apply coverage badge to README.md"
+          file_pattern: 'README.md .output/cov-report/coverage.out'
+
+      - name: Notify To Slack If Failed
+        uses: lazy-actions/[email protected]
+        if: failure()
+        with:
+          type: ${{ job.status }}
+          job_name: "*[hex-monscape]* ${{ github.job }}"
+          mention: "here"
+          mention_if: "failure"
+          channel: "#solutions-team-ci-cd"
+          icon_emoji: ":haraaj:"
+          username: "ci/cd-reporter"
+          url: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
+          commit: true
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/deploy.yml

@@ -1,4 +1,4 @@
-name: Build & Deploy
+name: deploy
 
 on:
   push:
@@ -10,43 +10,51 @@ on:
       - master
 
 jobs:
-  run-test:
-    uses: ./.github/workflows/tests.yml
-    name: Run Tests
-    with:
-      checkout-ref: ${{ github.sha }}
-    secrets:
-      github-token: ${{ secrets.GITHUB_TOKEN }}
-      SOLUTIONS_TEAM_SLACK_WEBHOOK: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
-
   preparation:
-    name: Prepare Environment
-    needs: run-test
+    name: Prepare Deployment
     runs-on: ubuntu-latest
     outputs:
-      deploy-game: ${{ (steps.changes.outputs.lambda == 'true') || (steps.changes.outputs.all == 'true') }}
+      deploy-game: ${{ (steps.changes.outputs.deploy-game == 'true') }}
     steps:
-      - name: Checkout Latest Commit
-        uses: actions/checkout@v2
+      - name: Checkout Current Commit
+        uses: actions/checkout@v3
+
+      - name: Run Automated Tests
+        run: make test
+
       - name: Determine Changes
         uses: dorny/paths-filter@v2
         id: changes
         with:
           base: ${{ github.ref }}
           filters: |
-            all:
+            deploy-game:
               - "internal/**"
               - ".github/workflows/deploy-dev.yml"
               - ".github/workflows/run-tests.yml"
               - "go.mod"
               - "go.sum"
-            lambda:
               - "build/package/lambda/**"
               - "cmd/lambda/**"
               - "internal/driven/storage/dynamodb/**"
               - "deploy/aws/lambda/infras.yml"
               - "deploy/aws/lambda/service.yml"
 
+      - name: Notify To Slack If Failed
+        uses: lazy-actions/[email protected]
+        if: failure()
+        with:
+          type: ${{ job.status }}
+          job_name: "*[hex-monscape]* ${{ github.job }}"
+          mention: "here"
+          mention_if: "failure"
+          channel: "#solutions-team-ci-cd"
+          icon_emoji: ":haraaj:"
+          username: "ci/cd-reporter"
+          url: ${{ secrets.SOLUTIONS_TEAM_SLACK_WEBHOOK }}
+          commit: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+
   deploy-game:
     name: Deploy Game
     needs: preparation
@@ -57,7 +65,7 @@ jobs:
       INFRA_STACK_NAME_DEV: hex-monscape-infras
     steps:
       - name: Checkout Current Commit
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v1

.gitignore

@@ -1,3 +1,2 @@
 .vscode
-**/*.DS_Store
-.tmp
+**/*.DS_Store

.output/.gitignore

@@ -0,0 +1,4 @@
+*
+!.gitignore
+!cov-report/
+!cov-report/*

.output/cov-report/README.md

@@ -0,0 +1,5 @@
+# Coverage Report
+
+The [coverage.out](./coverage.out) file was generated by [this command](../../build/package/tests/Dockerfile#L11). It will be automatically updated when [ci.yaml](../../.github/workflows/ci.yml) workflow is triggered.
+
+The coverage report is one of the requirements for submitting this project to [Awesome Go](https://github.com/avelino/awesome-go).