Add job summary to point to contributing.md

Signed-off-by: Marco Franssen <[email protected]>
sigstore · Nov 30, 2022 · e2a6819 · e2a6819
1 parent 4ee83bb
commit e2a6819
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -51,6 +51,18 @@ jobs:
         run: .github/helm-docs.sh .
         working-directory: ${{ matrix.chart }}
 
+      - name: Print job summary
+        if: failure()
+        run: |
+          echo '### Linting summary:' >> $GITHUB_STEP_SUMMARY
+          echo '' >> $GITHUB_STEP_SUMMARY
+          echo 'Please check our CONTRIBUTING.md sections:' >> $GITHUB_STEP_SUMMARY
+          echo '' >> $GITHUB_STEP_SUMMARY
+          echo "- [Bumping helm chart dependencies](${REPO_URL}/blob/main/CONTRIBUTING.md#bumping-helm-chart-dependencies)" >> $GITHUB_STEP_SUMMARY
+          echo "- [Generating documentation](${REPO_URL}/blob/main/CONTRIBUTING.md#generating-documentation)" >> $GITHUB_STEP_SUMMARY
+        env:
+          REPO_URL: github.com/${{ github.repository }}
+
   test:
     runs-on: ubuntu-latest
     steps: