Fix: Code Coverage Badge Failed (#196)

* switch coverage to codecov

* reset node, increment ver

* remove auto-pass job var

* remove coverage 'env' note

* set badge with new action

* add fqvn for action

* fix step name

* make badge commit explicit

.github/workflows/build.yml

@@ -1,5 +1,6 @@
 name: Builds
 run-name: Validate Node and Docker Builds
+
 on:
   push:
     branches:
@@ -9,15 +10,16 @@ jobs:
   Discord-Node-Build: # test if the node install and run
     runs-on: ubuntu-latest
     timeout-minutes: 2
+    
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/jod
+      - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
           node-version: lts/jod
-          cache: "npm"
+          cache: npm
 
       - name: Install Project Dependencies
         run: |
@@ -48,11 +50,11 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/jod
+      - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
           node-version: lts/jod
-          cache: "npm"
+          cache: npm
 
       - name: Create Environment Variables
         run: |

.github/workflows/coverage.yml

@@ -1,28 +1,39 @@
 name: Coverage
 run-name: Code Coverage
+
 on:
-  push:
+  pull_request:
     branches:
       - master
+    types: [opened, reopened]
+
+permissions:
+  contents: write
+
+concurrency:
+  group: coverage-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
 
 jobs:
   Discord-Node-Coverage:
     runs-on: ubuntu-latest
-    environment: coverage
     timeout-minutes: 2
+
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
 
-      - name: Set up Node Environment lts/jod
+      - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
           node-version: lts/jod
-          cache: "npm"
+          cache: npm
 
       - name: Install Project Dependencies
-        run: |
+        run: npm install
-          npm install
 
       - name: Create Environment Variables
         run: |
@@ -32,19 +43,32 @@ jobs:
           echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
           echo MODEL = ${{ secrets.MODEL }} >> .env
 
-      - name: Collect Code Coverage
+      - name: Run tests with coverage
-        run: |
+        run: npm run coverage
-          LINE_PCT=$(npm run coverage | tail -2 | head -1 | awk '{print $3}')
+
-          echo "COVERAGE=$LINE_PCT" >> $GITHUB_ENV
+      - name: Generate coverage badge
-      
+        uses: wjervis7/vitest-badge-action@v1.0.0
-      - name: Upload Code Coverage
+        if: success() || failure()
-        uses: schneegans/dynamic-badges-action@v1.7.0
         with:
-          auth: ${{ secrets.GIST_SECRET }}
+          result-type: statements
-          gistID: ${{ vars.GIST_ID }}
+          badge-text: 'Coverage (Statements)'
-          filename: coverage.json
+          badge-path: ./imgs/coverage.svg
-          label: Coverage
+          upload-badge: false
-          message: ${{ env.COVERAGE }}
+
-          valColorRange: ${{ env.COVERAGE }}
+      - name: Check whether badge commit is already latest
-          maxColorRange: 100
+        id: badge-check
-          minColorRange: 0
+        if: github.event_name == 'pull_request' && (github.event.action == 'opened' || github.event.action == 'synchronize' || github.event.action == 'reopened')
+        run: |
+          if [ "$(git log -1 --pretty=%s)" = "update with coverage badge" ]; then
+            echo "already_latest=true" >> $GITHUB_OUTPUT
+          else
+            echo "already_latest=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Commit badge to PR branch
+        if: github.event_name == 'pull_request' && (github.event.action == 'opened' || github.event.action == 'synchronize' || github.event.action == 'reopened') && steps.badge-check.outputs.already_latest != 'true'
+        uses: stefanzweifel/git-auto-commit-action@v7
+        with:
+          file_pattern: ./imgs/coverage.svg
+          commit_message: 'update with coverage badge'
+          branch: ${{ github.head_ref }}

.github/workflows/deploy.yml

@@ -1,9 +1,6 @@
 name: Deploy
 run-name: Deploy Application Latest
-# on:
+
-#   push:
-#     tags:
-#       - 'v*'
 on: workflow_dispatch
 
 jobs:
@@ -11,6 +8,7 @@ jobs:
     runs-on: self-hosted
     environment: deploy
     timeout-minutes: 5
+    
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v4
@@ -40,7 +38,7 @@ jobs:
           git clone https://github.com/kevinthedang/discord-ollama.git ${{ secrets.PATH }}
           cd ${{ secrets.PATH }}
       
-      - name: Install nvm and Node.js lts/jod
+      - name: Install nvm and Node.js
         run: |
           curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
           export NVM_DIR="$HOME/.nvm"

.github/workflows/test.yml

@@ -1,5 +1,6 @@
 name: Tests
 run-name: Unit Tests
+
 on:
   pull_request:
     branches:
@@ -21,15 +22,16 @@ jobs:
   Discord-Node-Test:
     runs-on: ubuntu-latest
     timeout-minutes: 2
+    
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/jod
+      - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
           node-version: lts/jod
-          cache: "npm"
+          cache: npm
 
       - name: Install Project Dependencies
         run: |

CODEOWNERS

@@ -12,7 +12,7 @@
 # Technical/Business Code Ownership
 /src/ @kevinthedang @JT2M0L3Y
 /tests/ @JT2M0L3Y
-/.github/ @kevinthedang
+/.github/ @kevinthedang @JT2M0L3Y
 
 # Docker Ownership
 Dockerfile @kevinthedang

README.md

@@ -5,9 +5,8 @@
     <p><a href="#"></a><a href="https://creativecommons.org/licenses/by/4.0/"><img alt="License" src="https://img.shields.io/badge/License-CC_BY_4.0-darkgreen.svg" /></a>
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/releases/latest"><img alt="Release" src="https://img.shields.io/github/v/release/kevinthedang/discord-ollama?logo=github" /></a>
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml"><img alt="Builds" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml/badge.svg" /></a>
-    <!-- <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml"><img alt="Deploy Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml/badge.svg" /></a> -->
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml"><img alt="Tests" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml/badge.svg" /></a>
-    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/coverage.yml"><img alt="Code Coverage" src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/kevinthedang/bc7b5dcfa16561ab02bb3df67a99b22d/raw/coverage.json"></a>
+    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/coverage.yml"><img alt="Coverage" src="https://github.com/kevinthedang/discord-ollama/blob/main/imgs/coverage.svg?raw=true" /></a>
 </div>
 
 ## About/Goals

docker-compose.yml

@@ -7,7 +7,7 @@ services:
     build: ./                     # find docker file in designated path
     container_name: discord
     restart: always               # rebuild container always
-    image: kevinthedang/discord-ollama:0.9.0
+    image: kevinthedang/discord-ollama:0.9.1
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
       OLLAMA_IP: ${OLLAMA_IP}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-ollama",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",

vitest.config.ts

@@ -1,4 +1,4 @@
-import { defineConfig, configDefaults } from 'vitest/config'
+import { defineConfig } from 'vitest/config'
 
 // config for vitest
 export default defineConfig({
@@ -6,8 +6,8 @@ export default defineConfig({
         globals: true, // <-- reduces test file imports
         reporters: ['verbose'], // <-- verbose output
         coverage: {
-            exclude: [...configDefaults.exclude, 'build/*', 'tests/*'], // <-- exclude JS build
+            include: ['src/**/*.ts'],
-            reporter: ['text-summary'] // <-- report in text-summary
+            reporter: 'json-summary'
         }
     }
 })