cleanup

Signed-off-by: Mahantesh-R <[email protected]>

Author: MahanteshR12

scripts/publishCoverage.sh

@@ -17,17 +17,20 @@
 set -x
 echo "Publishing the coverage results"
 
-# GitHub Actions vars:
-# $GITHUB_WORKSPACE   -> root of repo
+# GitHub Actions env vars:
+# $GITHUB_WORKSPACE   -> repo root on runner
 # $GITHUB_REPOSITORY  -> owner/repo
-# $GITHUB_REF_NAME    -> branch or tag name
-# $GITHUB_SHA         -> current commit SHA
-# $GITHUB_RUN_NUMBER  -> CI run number
+# $GITHUB_REF_NAME    -> branch or tag name (e.g. master)
+# $GITHUB_SHA         -> commit SHA
+# $GITHUB_RUN_NUMBER  -> workflow run number
 # $GITHUB_EVENT_NAME  -> event type (push, pull_request, etc)
-# $GITHUB_EVENT_PATH  -> path to the full webhook event JSON
+# $GITHUB_EVENT_PATH  -> webhook event JSON
 
-mkdir -p "$GITHUB_WORKSPACE/gh-pages"
-cd "$GITHUB_WORKSPACE/gh-pages" || exit 1
+WORKDIR="$GITHUB_WORKSPACE/gh-pages"
+COVERAGE_DIR="$WORKDIR/coverage/$GITHUB_REF_NAME"
+
+mkdir -p "$WORKDIR"
+cd "$WORKDIR" || exit 1
 
 OLD_COVERAGE=0
 NEW_COVERAGE=0
@@ -37,68 +40,65 @@ BADGE_COLOR=red
 GREEN_THRESHOLD=85
 YELLOW_THRESHOLD=50
 
-# clone and prepare gh-pages branch
-git clone -b gh-pages https://"$GHE_USER":"$GHE_TOKEN"@github.com/"$GITHUB_REPOSITORY".git .
-git config user.name "travis"
-git config user.email "travis"
-
-mkdir -p "$GITHUB_WORKSPACE/gh-pages/coverage/$GITHUB_REF_NAME"
-mkdir -p "$GITHUB_WORKSPACE/gh-pages/coverage/$GITHUB_SHA"
+# clone gh-pages branch
+git clone -b gh-pages "https://$GHE_USER:$GHE_TOKEN@github.com/$GITHUB_REPOSITORY.git" .
+git config user.name "github-actions"
+git config user.email "[email protected]"
 
-# calculate overall coverage percentage
-echo "Computing the coverages"
+mkdir -p "$COVERAGE_DIR" "$WORKDIR/coverage/$GITHUB_SHA"
 
-if [ -f "$GITHUB_WORKSPACE/gh-pages/coverage/${GITHUB_REF_NAME}/cover.html" ]; then
-    OLD_COVERAGE=$(grep "%)" "$GITHUB_WORKSPACE/gh-pages/coverage/${GITHUB_REF_NAME}/cover.html" \
-      | sed 's/[][()><%]/ /g' | awk '{ print $4 }' \
-      | awk '{s+=$1}END{if(NR>0)print s/NR; else print 0}')
-fi
+# compute old coverage if present
+COVER_HTML="$COVERAGE_DIR/cover.html"
+OLD_COVERAGE=$(grep "%)" "$COVER_HTML" 2>/dev/null \
+  | sed 's/[][()><%]/ /g' \
+  | awk '{s+=$4}END{if(NR>0)print s/NR; else print 0}')
 
-cp "$GITHUB_WORKSPACE/cover.html" "$GITHUB_WORKSPACE/gh-pages/coverage/${GITHUB_REF_NAME}"
-cp "$GITHUB_WORKSPACE/cover.html" "$GITHUB_WORKSPACE/gh-pages/coverage/$GITHUB_SHA"
+# copy new report
+cp "$GITHUB_WORKSPACE/cover.html" "$COVERAGE_DIR"
+cp "$GITHUB_WORKSPACE/cover.html" "$WORKDIR/coverage/$GITHUB_SHA"
 
-if [ -f "$GITHUB_WORKSPACE/Passing" ]; then
-    curl -s https://img.shields.io/badge/e2e-passing-yellow.svg > "$GITHUB_WORKSPACE/gh-pages/coverage/${GITHUB_REF_NAME}/e2e.svg"
-elif [ -f "$GITHUB_WORKSPACE/Failed" ]; then
-    curl -s https://img.shields.io/badge/e2e-failed-red.svg > "$GITHUB_WORKSPACE/gh-pages/coverage/${GITHUB_REF_NAME}/e2e.svg"
+# add e2e badge if test markers exist
+if [[ -f "$GITHUB_WORKSPACE/Passing" ]]; then
+    curl -s https://img.shields.io/badge/e2e-passing-green.svg > "$COVERAGE_DIR/e2e.svg"
+elif [[ -f "$GITHUB_WORKSPACE/Failed" ]]; then
+    curl -s https://img.shields.io/badge/e2e-failed-red.svg > "$COVERAGE_DIR/e2e.svg"
 fi
 
-NEW_COVERAGE=$(grep "%)" "$GITHUB_WORKSPACE/gh-pages/coverage/${GITHUB_REF_NAME}/cover.html" | sed 's/[][()><%]/ /g' | awk '{ print $4 }' \
-  | awk '{s+=$1}END{if(NR>0)print s/NR; else print 0}')
+# compute new coverage
+NEW_COVERAGE=$(grep "%)" "$COVER_HTML" \
+  | sed 's/[][()><%]/ /g' \
+  | awk '{s+=$4}END{if(NR>0)print s/NR; else print 0}')
 
-# pick badge color
+# select badge color
 if (( $(echo "$NEW_COVERAGE > $GREEN_THRESHOLD" | bc -l) )); then
-	BADGE_COLOR="green"
+    BADGE_COLOR="green"
 elif (( $(echo "$NEW_COVERAGE > $YELLOW_THRESHOLD" | bc -l) )); then
-	BADGE_COLOR="yellow"
+    BADGE_COLOR="yellow"
 fi
 
-# generate badge
-curl -s https://img.shields.io/badge/coverage-"$NEW_COVERAGE"-$BADGE_COLOR.svg > "$GITHUB_WORKSPACE/gh-pages/coverage/${GITHUB_REF_NAME}/badge.svg"
+# generate coverage badge
+curl -s "https://img.shields.io/badge/coverage-${NEW_COVERAGE}-${BADGE_COLOR}.svg" > "$COVERAGE_DIR/badge.svg"
 
-# generate result message
+# build result message
 if (( $(echo "$OLD_COVERAGE > $NEW_COVERAGE" | bc -l) )); then
-	RESULT_MESSAGE=":red_circle: Coverage decreased from [$OLD_COVERAGE%] to [$NEW_COVERAGE%]"
+    RESULT_MESSAGE=":red_circle: Coverage decreased from [$OLD_COVERAGE%] to [$NEW_COVERAGE%]"
 elif (( $(echo "$OLD_COVERAGE == $NEW_COVERAGE" | bc -l) )); then
-	RESULT_MESSAGE=":thumbsup: Coverage remained same at [$NEW_COVERAGE%]"
+    RESULT_MESSAGE=":thumbsup: Coverage remained the same at [$NEW_COVERAGE%]"
 else
-	RESULT_MESSAGE=":thumbsup: Coverage increased from [$OLD_COVERAGE%] to [$NEW_COVERAGE%]"
+    RESULT_MESSAGE=":thumbsup: Coverage increased from [$OLD_COVERAGE%] to [$NEW_COVERAGE%]"
 fi
 
-# update gh-pages or PR
-echo "Updating gh-pages"
-if [ "$GITHUB_EVENT_NAME" == "push" ]; then
-	git status
-	git add .
-	git commit -m "Coverage result for commit $GITHUB_SHA from run $GITHUB_RUN_NUMBER" || echo "No changes to commit"
-	git push origin gh-pages
-elif [ "$GITHUB_EVENT_NAME" == "pull_request" ]; then
-	# extract PR number from JSON
-	PR_NUMBER=$(jq -r .pull_request.number "$GITHUB_EVENT_PATH")
-
-	curl -s -X POST \
-	  -H "Authorization: token $GHE_TOKEN" \
-	  -H "Content-Type: application/json" \
-	  -d "{\"body\": \"$RESULT_MESSAGE\"}" \
-	  "https://api.github.com/repos/$GITHUB_REPOSITORY/issues/$PR_NUMBER/comments"
+# updating comment on PR
+echo "Updating gh-pages/PR comment"
+if [[ "$GITHUB_EVENT_NAME" == "push" ]]; then
+    git add .
+    git commit -m "Coverage: commit $GITHUB_SHA (run $GITHUB_RUN_NUMBER)" || echo "No changes to commit"
+    git push origin gh-pages
+elif [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then
+    PR_NUMBER=$(jq -r .pull_request.number "$GITHUB_EVENT_PATH")
+    curl -s -X POST \
+      -H "Authorization: token $GHE_TOKEN" \
+      -H "Content-Type: application/json" \
+      -d "{\"body\": \"$RESULT_MESSAGE\"}" \
+      "https://api.github.com/repos/$GITHUB_REPOSITORY/issues/$PR_NUMBER/comments"
 fi