feat: ♻️ use example for testing separate badge and upload actions

Author: cif

example-workflow-with-badges.yml

@@ -35,40 +35,5 @@ jobs:
           show-files: "true"
           coverage-threshold: "80"
 
-  # Badge generation and upload (only runs on main branch)
-  badges:
-    if: github.ref == 'refs/heads/main'
-    runs-on: ubuntu-latest
-    needs: coverage
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0 # Needed for git operations
-
-      # Option 1: Use the badge upload action (generates badges automatically)
-      - name: Upload Badges to GitHub Pages
-        uses: glideapps/[email protected]
-        with:
-          action: "badge-upload-action.yml"
-          coverage-file: "coverage/coverage-summary.json"
-          badges-dir: "badges"
-          pages-branch: "gh-pages"
-          pages-badges-dir: "badges"
-          generate-badges: "true"
-
-      # Option 2: Use separate actions for more control
-      # - name: Generate Badges
-      #   uses: glideapps/[email protected]
-      #   with:
-      #     action: "badge-generator-action.yml"
-      #     coverage-file: "coverage/coverage-summary.json"
-      #     badges-dir: "badges"
-      #
-      # - name: Upload Badges to GitHub Pages
-      #   uses: glideapps/[email protected]
-      #   with:
-      #     action: "badge-upload-action.yml"
-      #     badges-dir: "badges"
-      #     pages-branch: "gh-pages"
-      #     pages-badges-dir: "badges"
-      #     generate-badges: "false"
+  # Note: Badge generation and upload functionality is not yet available in this action
+  # This example will be updated when badge functionality is properly implemented

example-workflow.yml

@@ -28,11 +28,11 @@ jobs:
         run: npm test
 
       - name: Report Coverage
-        uses: glideapps/vitest-v8-json-coverage-summary@v1
+        uses: glideapps/vitest-v8-json-coverage-summary@v0.0.0-echo
         with:
           coverage-file: "coverage/coverage-summary.json"
           title: "🧪 Test Coverage Report"
           show-files: "true"
           coverage-threshold: "80"
-          make-badges: "true"
-          upload-badges-to-pages: "true"
+
+      # Note: Badge generation and upload functionality is not yet available in this action

examples/badge-generator-only.yml

@@ -20,9 +20,9 @@ jobs:
       - name: Run tests with coverage
         run: npm test
 
-      # Only generate badges - no upload
+      # Generate badges
       - name: Generate Badges
-        uses: glideapps/vitest-v8-json-coverage-summary/actions/badge-generator@v0.0.0-echo
+        uses: ./actions/badge-generator
         with:
           coverage-file: "coverage/coverage-summary.json"
           badges-dir: "badges"

examples/badge-uploader-only.yml

@@ -27,7 +27,7 @@ jobs:
 
       # Upload badges to GitHub Pages (generates badges automatically)
       - name: Upload Badges to GitHub Pages
-        uses: glideapps/vitest-v8-json-coverage-summary/actions/badge-uploader@v0.0.0-echo
+        uses: ./actions/badge-uploader
         with:
           coverage-file: "coverage/coverage-summary.json"
           badges-dir: "badges"

examples/coverage-only.yml

@@ -25,7 +25,7 @@ jobs:
 
       # Only coverage reporting - no badges
       - name: Report Coverage
-        uses: glideapps/vitest-v8-json-coverage-summary/actions/coverage-reporter@v0.0.0-echo
+        uses: glideapps/[email protected]
         with:
           coverage-file: "coverage/coverage-summary.json"
           title: "🧪 Test Coverage Report"

examples/example-merge.yml

@@ -0,0 +1,44 @@
+name: Example Merge Workflow
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write # Required for GitHub Pages upload
+
+jobs:
+  badges:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Needed for git operations
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests with coverage
+        run: npm test
+
+      # Generate badges
+      - name: Generate Badges
+        uses: ./
+        with:
+          action: "badge-generator-action.yml"
+          coverage-file: "coverage/coverage-summary.json"
+          badges-dir: "badges"
+
+      # Upload badges to GitHub Pages
+      - name: Upload Badges to GitHub Pages
+        uses: ./
+        with:
+          action: "badge-upload-action.yml"
+          badges-dir: "badges"
+          pages-branch: "gh-pages"
+          pages-badges-dir: "badges"
+          generate-badges: "false" # Use existing badges

examples/full-workflow.yml

@@ -28,7 +28,7 @@ jobs:
 
       # Coverage reporting (runs on PRs and main)
       - name: Report Coverage
-        uses: glideapps/vitest-v8-json-coverage-summary/actions/coverage-reporter@v0.0.0-echo
+        uses: glideapps/[email protected]
         with:
           coverage-file: "coverage/coverage-summary.json"
           title: "🧪 Test Coverage Report"
@@ -45,16 +45,27 @@ jobs:
         with:
           fetch-depth: 0 # Needed for git operations
 
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests with coverage
+        run: npm test
+
       # Generate badges
       - name: Generate Badges
-        uses: glideapps/vitest-v8-json-coverage-summary/actions/badge-generator@v0.0.0-echo
+        uses: ./actions/badge-generator
         with:
           coverage-file: "coverage/coverage-summary.json"
           badges-dir: "badges"
 
       # Upload badges to GitHub Pages
       - name: Upload Badges to GitHub Pages
-        uses: glideapps/vitest-v8-json-coverage-summary/actions/badge-uploader@v0.0.0-echo
+        uses: ./actions/badge-uploader
         with:
           badges-dir: "badges"
           pages-branch: "gh-pages"