Kubernetes: Enhance KubeCheck workflow with improved YAML validation and comment formatting

Signed-off-by: NotHarshhaa <[email protected]>

Author: NotHarshhaa

Diff for: .github/scripts/comment-kubecheck.sh

@@ -2,11 +2,25 @@
 
 set -e
 
+# Fallback defaults (optional safety)
+COMMIT_TIME="${COMMIT_TIME:-Unknown}"
+COMMIT_MSG="${COMMIT_MSG:-(no message)}"
+SUMMARY="${SUMMARY:-No summary provided.}"
+RESULTS="${RESULTS:-}"
+
+# Format commit message to escape backticks or special chars
+ESCAPED_MSG=$(echo "$COMMIT_MSG" | sed 's/`/\\`/g')
+
+# If no validation results, say so
+if [[ -z "$RESULTS" ]]; then
+  RESULTS="_No files were validated in this run._"
+fi
+
 COMMENT="$(cat <<EOF
 🧪 **KubeCheck Validation Results**
 
 🕒 Commit Time: \`${COMMIT_TIME}\`  
-💬 Message: _${COMMIT_MSG}_
+💬 Message: _${ESCAPED_MSG}_
 
 ${SUMMARY}
 

Diff for: .github/workflows/kubecheck.yml

@@ -28,8 +28,8 @@ jobs:
     runs-on: ubuntu-latest
     needs: fetch_commit_info
     outputs:
-      summary: ${{ steps.kubeval.outputs.summary }}
-      results: ${{ steps.kubeval.outputs.results }}
+      summary: ${{ steps.kubeval.outputs.summary || steps.kubeval_skip.outputs.summary }}
+      results: ${{ steps.kubeval.outputs.results || steps.kubeval_skip.outputs.results }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
@@ -39,14 +39,28 @@ jobs:
           curl -L https://github.com/yannh/kubeconform/releases/latest/download/kubeconform-linux-amd64.tar.gz | tar xz
           sudo mv kubeconform /usr/local/bin/
 
+      - name: Detect changed YAML files
+        id: detect_changes
+        run: |
+          git fetch origin ${{ github.event.before }}
+          CHANGED_FILES=$(git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -E '\.ya?ml$' || true)
+          if [ -z "$CHANGED_FILES" ]; then
+            echo "No Kubernetes YAML changes found. Skipping validation."
+            echo "changed=false" >> $GITHUB_OUTPUT
+          else
+            echo "$CHANGED_FILES" > changed_yamls.txt
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
       - name: Validate Kubernetes YAML
         id: kubeval
+        if: steps.detect_changes.outputs.changed == 'true'
         run: |
           set +e
           RESULTS=""
           PASS_COUNT=0
           FAIL_COUNT=0
-          for file in $(find . -name '*.yaml' -o -name '*.yml'); do
+          for file in $(cat changed_yamls.txt); do
             output=$(kubeconform -strict -verbose "$file" 2>&1)
             if echo "$output" | grep -q "PASS"; then
               emoji="✅"
@@ -60,10 +74,22 @@ jobs:
 
           SUMMARY="✅ Passed: ${PASS_COUNT} | ❌ Failed: ${FAIL_COUNT}"
           echo "$RESULTS" > validation_output.txt
-          echo "::set-output name=results::$RESULTS"
-          echo "::set-output name=summary::$SUMMARY"
+
+          echo "results<<EOF" >> $GITHUB_OUTPUT
+          echo "$RESULTS" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+          echo "summary=${SUMMARY}" >> $GITHUB_OUTPUT
+
+      - name: Set summary for skipped validation
+        if: steps.detect_changes.outputs.changed == 'false'
+        id: kubeval_skip
+        run: |
+          echo "summary=✅ No Kubernetes YAML files changed. Skipped validation." >> $GITHUB_OUTPUT
+          echo "results=" >> $GITHUB_OUTPUT
 
       - name: Fail if any errors
+        if: steps.detect_changes.outputs.changed == 'true'
         run: |
           if grep -q "❌" validation_output.txt; then
             echo "Validation failed."
@@ -75,13 +101,13 @@ jobs:
     needs: [fetch_commit_info, validate_kubeconform]
     if: always()
     steps:
-    - name: Comment on commit
-      env:
-        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-        SHA: ${{ needs.fetch_commit_info.outputs.sha }}
-        COMMIT_MSG: ${{ needs.fetch_commit_info.outputs.message }}
-        COMMIT_TIME: ${{ needs.fetch_commit_info.outputs.timestamp }}
-        SUMMARY: ${{ needs.validate_kubeconform.outputs.summary }}
-        RESULTS: ${{ needs.validate_kubeconform.outputs.results }}
-        REPO: ${{ github.repository }}
-      run: chmod +x .github/scripts/comment-kubecheck.sh && bash .github/scripts/comment-kubecheck.sh
+      - name: Comment on commit
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          SHA: ${{ needs.fetch_commit_info.outputs.sha }}
+          COMMIT_MSG: ${{ needs.fetch_commit_info.outputs.message }}
+          COMMIT_TIME: ${{ needs.fetch_commit_info.outputs.timestamp }}
+          SUMMARY: ${{ needs.validate_kubeconform.outputs.summary }}
+          RESULTS: ${{ needs.validate_kubeconform.outputs.results }}
+          REPO: ${{ github.repository }}
+        run: chmod +x .github/scripts/comment-kubecheck.sh && bash .github/scripts/comment-kubecheck.sh