From ad43340a9a8b6d5f83a12d2b20c51704d9f750de Mon Sep 17 00:00:00 2001
From: Gabriel Luiz Freitas Almeida <gabriel@langflow.org>
Date: Wed, 27 Nov 2024 12:33:07 -0300
Subject: [PATCH] chore: Update CI workflow job and step names for clarity and
 consistency (#4847)

Update CI workflow job and step names for clarity and consistency
---
 .github/workflows/typescript_test.yml | 32 +++++++++++++--------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/.github/workflows/typescript_test.yml b/.github/workflows/typescript_test.yml
index 758949c64..0a2709b6b 100644
--- a/.github/workflows/typescript_test.yml
+++ b/.github/workflows/typescript_test.yml
@@ -54,6 +54,7 @@ env:
 
 jobs:
   determine-test-suite:
+    name: Determine Test Suites and Shard Distribution
     runs-on: ubuntu-latest
     outputs:
       matrix: ${{ steps.setup-matrix.outputs.matrix }}
@@ -71,7 +72,7 @@ jobs:
         with:
           filters: .github/changes-filter.yaml
 
-      - name: Set Matrix and Test Grep
+      - name: Determine Test Suites from Changes
         id: set-matrix
         run: |
           # Start with input suites if provided, otherwise empty array
@@ -171,11 +172,11 @@ jobs:
           cache: "npm"
           cache-dependency-path: ./src/frontend/package-lock.json
 
-      - name: Install Node.js dependencies
+      - name: Install Frontend Dependencies
         run: npm ci
         working-directory: ./src/frontend
 
-      - name: Setup Matrix Combinations
+      - name: Calculate Test Shards Distribution
         id: setup-matrix
         run: |
           cd src/frontend
@@ -209,7 +210,7 @@ jobs:
           echo "matrix={\"include\":[$MATRIX_COMBINATIONS]}" >> "$GITHUB_OUTPUT"
 
   setup-and-test:
-    name: Playwright Tests - Group ${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
+    name: Playwright Tests - Shard ${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
     runs-on: ubuntu-latest
     if: ${{ needs.determine-test-suite.outputs.test_grep != '' }}
     needs: determine-test-suite
@@ -226,14 +227,12 @@ jobs:
     outputs:
       failed: ${{ steps.check-failure.outputs.failed }}
     steps:
-      - name: Checkout code
+      - name: Checkout Repository
         uses: actions/checkout@v4
         with:
-          # If ref is passed as input, checkout that ref
-          # else checkout the default ref
           ref: ${{ inputs.ref || github.ref }}
 
-      - name: Setup Node ${{ env.NODE_VERSION }}
+      - name: Setup Node.js Environment
         uses: actions/setup-node@v4
         id: setup-node
         with:
@@ -241,28 +240,29 @@ jobs:
           cache: "npm"
           cache-dependency-path: ./src/frontend/package-lock.json
 
-      - name: Install Node.js dependencies
+      - name: Install Frontend Dependencies
         run: npm ci
         working-directory: ./src/frontend
 
-      - name: Install Playwright
+      - name: Install Playwright Browser Dependencies
         id: install-playwright
         uses: ./.github/actions/install-playwright
         with:
           working-directory: ./src/frontend
           browsers: chromium
 
-      - name: "Setup Environment"
+      - name: Setup Python Environment with UV
         uses: ./.github/actions/setup-uv
-      - name: Install the project
+
+      - name: Install Python Dependencies
         run: uv sync --dev
 
-      - name: create .env
+      - name: Configure Environment Variables
         run: |
           touch .env
           echo "${{ secrets.ENV_VARS }}" > .env
 
-      - name: Run Playwright Tests
+      - name: Execute Playwright Tests
         uses: nick-fields/retry@v3
         with:
           timeout_minutes: 12
@@ -276,7 +276,7 @@ jobs:
 
             npx playwright test ${{ inputs.tests_folder }} ${{ needs.determine-test-suite.outputs.test_grep }} --trace on --shard ${{ matrix.shardIndex }}/${{ matrix.shardTotal }} --workers 2
 
-      - name: Upload blob report to GitHub Actions Artifacts
+      - name: Upload Test Results
         if: always()
         uses: actions/upload-artifact@v4
         with:
@@ -284,7 +284,7 @@ jobs:
           path: src/frontend/blob-report
           retention-days: 1
 
-      - name: Minimize uv cache
+      - name: Cleanup UV Cache
         run: uv cache prune --ci
 
   merge-reports: