From 3d3482316b4fbb5aac757cc2e43c8feaa9dbdf4e Mon Sep 17 00:00:00 2001
From: Bhavin Patel <bhavin.j.patel91@gmail.com>
Date: Tue, 9 Jul 2024 13:24:31 -0700
Subject: [PATCH] updating print

---
 .github/workflows/format_test_results.py |  2 +-
 .github/workflows/unit-testing.yml       | 10 ++++++----
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/format_test_results.py b/.github/workflows/format_test_results.py
index 8ef274b219..aeb804516e 100644
--- a/.github/workflows/format_test_results.py
+++ b/.github/workflows/format_test_results.py
@@ -45,7 +45,7 @@ def main():
                 else:
                     print(f"{name:<80} | 🟢  {status:<6} | {test_type:<10} | {'-':<50}")
     # Print table footer
-    print(f"{'----':<80} | {'------':<6} | {'---------':<10} | {'---------':<50}")
+    # print(f"{'----':<80} | {'------':<6} | {'---------':<10} | {'---------':<50}")
 
     # Check if total_fail is a valid integer and greater than or equal to one
     print("\n")  # Print a newline for separation
diff --git a/.github/workflows/unit-testing.yml b/.github/workflows/unit-testing.yml
index 541591b022..a6f0f00fb7 100644
--- a/.github/workflows/unit-testing.yml
+++ b/.github/workflows/unit-testing.yml
@@ -27,8 +27,8 @@ jobs:
             python -m pip install --upgrade pip
             pip install contentctl
            
-        
-        - name: Run ContentCTL test for changes against develop
+        # Running contentctl test with a few arguments, before running the command make sure you checkout into the current branch of the pull request. This step only performs unit testing on all the changes against the target-branch. In most cases this target branch will be develop
+        - name: Run ContentCTL test for changes against target branch
           run: |
             echo "Current Branch (Head Ref): ${{ github.head_ref }}"
             echo "Target Branch (Base Ref): ${{ github.base_ref }}"
@@ -39,7 +39,7 @@ jobs:
             echo "contentctl test - COMPLETED"
           continue-on-error: true
 
-          
+        # Store test_results/summary.yml and dist/DA-ESS-ContentUpdate-latest.tar.gz to job artifact-test_summary_results.zip
         - name: store_artifacts
           uses: actions/upload-artifact@v4
           with:
@@ -49,10 +49,12 @@ jobs:
               dist/DA-ESS-ContentUpdate-latest.tar.gz
           continue-on-error: true
 
+        # Print entire result summary so that the users can view it in the Github Actions logs 
         - name: Print entire test_results/summary.yml
           run: cat test_results/summary.yml
           continue-on-error: true
-          
+
+        # Run a simple custom script created to pretty print results in a markdown friendly format in Github Actions Summary
         - name: Check the test_results/summary.yml for pass/fail.
           run: |       
             echo "This job will fail if there are failures in unit-testing"