Provide failure badge for documentation

ricardoboss · Dec 14, 2023 · 507045f · 507045f
1 parent de19434
commit 507045f
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/.github/workflows/report.yml b/.github/workflows/report.yml
@@ -88,9 +88,7 @@ jobs:
  runs-on: ubuntu-latest
 
  outputs:
- total: ${{ steps.docblocks.outputs.total }}
- documented: ${{ steps.docblocks.outputs.documented }}
- badge: ${{ steps.docblocks.outputs.badge }}
+ badge: ${{ steps.docblocks.outputs.badge || steps.doc-failure.outputs.badge }}
 
  steps:
  - uses: actions/checkout@v4
@@ -106,6 +104,12 @@ jobs:
  id: docblocks
  run: dotnet tool update cranky -g && cranky --project ./StepLang/StepLang.csproj --github --set-exit-code --percentages 0,50
 
+ - name: Provide failure badge
+ id: doc-failure
+ if: failure()
+ run: |
+ echo "badge=https://img.shields.io/badge/Documentation%20Coverage-failed-red.svg?style=flat" >> "$GITHUB_OUTPUT"
+
  report:
  name: Report