feat: show badges generated from test data

Author: vyadh

.github/workflows/tests.yaml

@@ -37,7 +37,15 @@ jobs:
           version: ${{ matrix.version }}
 
       - name: Test Nu-Test
-        run: "nu -c 'use nutest; nutest run-tests --fail --report { type: junit, path: test-report.xml }'"
+        shell: nu {0}
+        run: |
+          nu -c 'use nutest; (
+            nutest run-tests
+              --fail
+              --display terminal
+              --report { type: junit, path: test-report.xml }
+              --returns summary | to json | save --force test-summary.json
+          )'
 
       - name: Publish Test Results
         uses: EnricoMi/publish-unit-test-result-action@v2
@@ -57,6 +65,33 @@ jobs:
         with:
           files: test-report.xml
 
+      - name: Publish Test Summary
+        if: runner.os == 'Linux' && matrix.version == '*' && github.ref == 'refs/heads/main'
+        shell: nu {0}
+        run: |
+          let gist_id = "0cbdca67f966d7ea2e6e1eaf7c9083a3"
+          let filename = "test-summary.json"
+
+          let data = {
+            files: {
+              "test-summary.json": {
+                content: (open --raw $filename)
+              }
+            }
+          }
+          
+          (
+            $data | http patch
+              --redirect-mode "follow"
+              --content-type "application/json"
+              --headers {
+                "Authorization": $"Bearer ${{ secrets.GIST_TOKEN }}"
+                "Accept": "application/vnd.github+json"
+                "X-GitHub-Api-Version": "2022-11-28"
+              }
+              $"https://api.github.com/gists/($gist_id)"
+          ) | ignore
+
   nushell-tests:
     name: Run Nushell Tests
 

PLAN.md

@@ -11,14 +11,13 @@
 
 ## Milestone: Version 1.0
 
-- Get Topiary Nushell formatting working as commit hook (if it's readable)
-- JUnit test reports:
-  - Add [a badge](https://github.com/EnricoMi/publish-unit-test-result-action/?tab=readme-ov-file#create-a-badge-from-test-results) for test results in CI serving as an example
+- Use step outputs for file references
 - Versioning strategy, labels and docs/automation
 - Basic contributor agreement if needed
 
 ## Post v1 Roadmap
 
+- Get Topiary Nushell formatting working as commit hook (if it's readable)
 - JUnit test reports:
   - Add error information into the expected JUnit failure elements
   - Add test output

README.md

@@ -1,5 +1,11 @@
 # Nu-test
 
+![CI/CD](https://github.com/vyadh/nu-test/actions/workflows/tests.yaml/badge.svg)
+![Tests](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgist.githubusercontent.com%2Fvyadh%2F0cbdca67f966d7ea2e6e1eaf7c9083a3%2Fraw%2Ftest-summary.json&query=%24.total&label=Tests)
+![Passed](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgist.githubusercontent.com%2Fvyadh%2F0cbdca67f966d7ea2e6e1eaf7c9083a3%2Fraw%2Ftest-summary.json&query=%24.passed&label=Passed&color=%2331c654)
+![Failed](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgist.githubusercontent.com%2Fvyadh%2F0cbdca67f966d7ea2e6e1eaf7c9083a3%2Fraw%2Ftest-summary.json&query=%24.failed&label=Failed&color=red)
+![Skipped](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgist.githubusercontent.com%2Fvyadh%2F0cbdca67f966d7ea2e6e1eaf7c9083a3%2Fraw%2Ftest-summary.json&query=%24.skipped&label=Skipped&color=yellow)
+
 A [Nushell](https://www.nushell.sh) test runner.
 
 ![An example nu-test run](resources/test-run.png)