refactor: enhance workflow names and descriptions for clarity (#32262)

Author: mdrxy

.github/workflows/_compile_integration_test.yml

@@ -1,4 +1,4 @@
-name: compile-integration-test
+name: '🔗 Compile Integration Tests'
 
 on:
   workflow_call:
@@ -25,24 +25,24 @@ jobs:
         working-directory: ${{ inputs.working-directory }}
     runs-on: ubuntu-latest
     timeout-minutes: 20
-    name: "uv run pytest -m compile tests/integration_tests #${{ inputs.python-version }}"
+    name: 'Python ${{ inputs.python-version }}'
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python ${{ inputs.python-version }} + uv
+      - name: '🐍 Set up Python ${{ inputs.python-version }} + UV'
         uses: "./.github/actions/uv_setup"
         with:
           python-version: ${{ inputs.python-version }}
 
-      - name: Install integration dependencies
+      - name: '📦 Install Integration Dependencies'
         shell: bash
         run: uv sync --group test --group test_integration
 
-      - name: Check integration tests compile
+      - name: '🔗 Check Integration Tests Compile'
         shell: bash
         run: uv run pytest -m compile tests/integration_tests
 
-      - name: Ensure the tests did not create any additional files
+      - name: '🧹 Verify Clean Working Directory'
         shell: bash
         run: |
           set -eu

.github/workflows/_integration_test.yml

@@ -1,4 +1,4 @@
-name: Integration Tests
+name: '🚀 Integration Tests'
 
 on:
   workflow_dispatch:
@@ -24,20 +24,20 @@ jobs:
       run:
         working-directory: ${{ inputs.working-directory }}
     runs-on: ubuntu-latest
-    name: Python ${{ inputs.python-version }}
+    name: '🚀 Integration Tests (Python ${{ inputs.python-version }})'
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python ${{ inputs.python-version }} + uv
+      - name: '🐍 Set up Python ${{ inputs.python-version }} + UV'
         uses: "./.github/actions/uv_setup"
         with:
           python-version: ${{ inputs.python-version }}
 
-      - name: Install dependencies
+      - name: '📦 Install Integration Dependencies'
         shell: bash
         run: uv sync --group test --group test_integration
 
-      - name: Run integration tests
+      - name: '🚀 Run Integration Tests'
         shell: bash
         env:
           AI21_API_KEY: ${{ secrets.AI21_API_KEY }}

.github/workflows/_lint.yml

@@ -1,4 +1,6 @@
-name: lint
+name: '🧹 Code Linting'
+# Runs code quality checks using ruff, mypy, and other linting tools
+# Checks both package code and test code for consistency
 
 on:
   workflow_call:
@@ -24,19 +26,21 @@ env:
   UV_FROZEN: "true"
 
 jobs:
+  # Linting job - runs quality checks on package and test code
   build:
-    name: "make lint #${{ inputs.python-version }}"
+    name: 'Python ${{ inputs.python-version }}'
     runs-on: ubuntu-latest
     timeout-minutes: 20
     steps:
-      - uses: actions/checkout@v4
+      - name: '📋 Checkout Code'
+        uses: actions/checkout@v4
 
-      - name: Set up Python ${{ inputs.python-version }} + uv
+      - name: '🐍 Set up Python ${{ inputs.python-version }} + UV'
         uses: "./.github/actions/uv_setup"
         with:
           python-version: ${{ inputs.python-version }}
 
-      - name: Install dependencies
+      - name: '📦 Install Lint & Typing Dependencies'
         # Also installs dev/lint/test/typing dependencies, to ensure we have
         # type hints for as many of our libraries as possible.
         # This helps catch errors that require dependencies to be spotted, for example:
@@ -49,12 +53,12 @@ jobs:
         run: |
           uv sync --group lint --group typing
 
-      - name: Analysing the code with our lint
+      - name: '🔍 Analyze Package Code with Linters'
         working-directory: ${{ inputs.working-directory }}
         run: |
           make lint_package
 
-      - name: Install unit test dependencies
+      - name: '📦 Install Unit Test Dependencies'
         # Also installs dev/lint/test/typing dependencies, to ensure we have
         # type hints for as many of our libraries as possible.
         # This helps catch errors that require dependencies to be spotted, for example:
@@ -67,13 +71,13 @@ jobs:
         working-directory: ${{ inputs.working-directory }}
         run: |
           uv sync --inexact --group test
-      - name: Install unit+integration test dependencies
+      - name: '📦 Install Unit + Integration Test Dependencies'
         if: ${{ startsWith(inputs.working-directory, 'libs/partners/') }}
         working-directory: ${{ inputs.working-directory }}
         run: |
           uv sync --inexact --group test --group test_integration
 
-      - name: Analysing the code with our lint
+      - name: '🔍 Analyze Test Code with Linters'
         working-directory: ${{ inputs.working-directory }}
         run: |
           make lint_tests

.github/workflows/_release.yml

@@ -1,5 +1,5 @@
-name: Release
-run-name: Release ${{ inputs.working-directory }} by @${{ github.actor }}
+name: '🚀 Package Release'
+run-name: '🚀 Release ${{ inputs.working-directory }} by @${{ github.actor }}'
 on:
   workflow_call:
     inputs:
@@ -18,14 +18,16 @@ on:
         required: false
         type: boolean
         default: false
-        description: "Release from a non-master branch (danger!)"
+        description: "Release from a non-master branch (danger!) - Only use for hotfixes"
 
 env:
   PYTHON_VERSION: "3.11"
   UV_FROZEN: "true"
   UV_NO_SYNC: "true"
 
 jobs:
+  # Build the distribution package and extract version info
+  # Runs in isolated environment with minimal permissions for security
   build:
     if: github.ref == 'refs/heads/master' || inputs.dangerous-nonmaster-release
     environment: Scheduled testing

.github/workflows/_test.yml

@@ -1,4 +1,6 @@
-name: test
+name: '🧪 Unit Testing'
+# Runs unit tests with both current and minimum supported dependency versions
+# to ensure compatibility across the supported range
 
 on:
   workflow_call:
@@ -20,31 +22,33 @@ env:
   UV_NO_SYNC: "true"
 
 jobs:
+  # Main test job - runs unit tests with current deps, then retests with minimum versions
   build:
     defaults:
       run:
         working-directory: ${{ inputs.working-directory }}
     runs-on: ubuntu-latest
     timeout-minutes: 20
-    name: "make test #${{ inputs.python-version }}"
+    name: 'Python ${{ inputs.python-version }}'
     steps:
-      - uses: actions/checkout@v4
+      - name: '📋 Checkout Code'
+        uses: actions/checkout@v4
 
-      - name: Set up Python ${{ inputs.python-version }} + uv
+      - name: '🐍 Set up Python ${{ inputs.python-version }} + UV'
         uses: "./.github/actions/uv_setup"
         id: setup-python
         with:
           python-version: ${{ inputs.python-version }}
-      - name: Install dependencies
+      - name: '📦 Install Test Dependencies'
         shell: bash
         run: uv sync --group test --dev
 
-      - name: Run core tests
+      - name: '🧪 Run Core Unit Tests'
         shell: bash
         run: |
           make test
 
-      - name: Get minimum versions
+      - name: '🔍 Calculate Minimum Dependency Versions'
         working-directory: ${{ inputs.working-directory }}
         id: min-version
         shell: bash
@@ -55,7 +59,7 @@ jobs:
           echo "min-versions=$min_versions" >> "$GITHUB_OUTPUT"
           echo "min-versions=$min_versions"
 
-      - name: Run unit tests with minimum dependency versions
+      - name: '🧪 Run Tests with Minimum Dependencies'
         if: ${{ steps.min-version.outputs.min-versions != '' }}
         env:
           MIN_VERSIONS: ${{ steps.min-version.outputs.min-versions }}
@@ -64,7 +68,7 @@ jobs:
           make tests
         working-directory: ${{ inputs.working-directory }}
 
-      - name: Ensure the tests did not create any additional files
+      - name: '🧹 Verify Clean Working Directory'
         shell: bash
         run: |
           set -eu

.github/workflows/_test_doc_imports.yml

@@ -1,4 +1,4 @@
-name: test_doc_imports
+name: '📑 Documentation Import Testing'
 
 on:
   workflow_call:
@@ -18,29 +18,30 @@ jobs:
   build:
     runs-on: ubuntu-latest
     timeout-minutes: 20
-    name: "check doc imports #${{ inputs.python-version }}"
+    name: '🔍 Check Doc Imports (Python ${{ inputs.python-version }})'
     steps:
-      - uses: actions/checkout@v4
+      - name: '📋 Checkout Code'
+        uses: actions/checkout@v4
 
-      - name: Set up Python ${{ inputs.python-version }} + uv
+      - name: '🐍 Set up Python ${{ inputs.python-version }} + UV'
         uses: "./.github/actions/uv_setup"
         with:
           python-version: ${{ inputs.python-version }}
 
-      - name: Install dependencies
+      - name: '📦 Install Test Dependencies'
         shell: bash
         run: uv sync --group test
 
-      - name: Install langchain editable
+      - name: '📦 Install LangChain in Editable Mode'
         run: |
           VIRTUAL_ENV=.venv uv pip install langchain-experimental langchain-community -e libs/core libs/langchain
 
-      - name: Check doc imports
+      - name: '🔍 Validate Documentation Import Statements'
         shell: bash
         run: |
           uv run python docs/scripts/check_imports.py
 
-      - name: Ensure the test did not create any additional files
+      - name: '🧹 Verify Clean Working Directory'
         shell: bash
         run: |
           set -eu

.github/workflows/_test_pydantic.yml

@@ -1,4 +1,4 @@
-name: test pydantic intermediate versions
+name: '🐍 Pydantic Version Testing'
 
 on:
   workflow_call:
@@ -31,29 +31,30 @@ jobs:
         working-directory: ${{ inputs.working-directory }}
     runs-on: ubuntu-latest
     timeout-minutes: 20
-    name: "make test # pydantic: ~=${{ inputs.pydantic-version }}, python: ${{ inputs.python-version }}, "
+    name: 'Pydantic ~=${{ inputs.pydantic-version }}'
     steps:
-      - uses: actions/checkout@v4
+      - name: '📋 Checkout Code'
+        uses: actions/checkout@v4
 
-      - name: Set up Python ${{ inputs.python-version }} + uv
+      - name: '🐍 Set up Python ${{ inputs.python-version }} + UV'
         uses: "./.github/actions/uv_setup"
         with:
           python-version: ${{ inputs.python-version }}
 
-      - name: Install dependencies
+      - name: '📦 Install Test Dependencies'
         shell: bash
         run: uv sync --group test
 
-      - name: Overwrite pydantic version
+      - name: '🔄 Install Specific Pydantic Version'
         shell: bash
         run: VIRTUAL_ENV=.venv uv pip install pydantic~=${{ inputs.pydantic-version }}
 
-      - name: Run core tests
+      - name: '🧪 Run Core Tests'
         shell: bash
         run: |
           make test
 
-      - name: Ensure the tests did not create any additional files
+      - name: '🧹 Verify Clean Working Directory'
         shell: bash
         run: |
           set -eu

.github/workflows/_test_release.yml

@@ -1,4 +1,4 @@
-name: test-release
+name: '🧪 Test Release Package'
 
 on:
   workflow_call:
@@ -29,7 +29,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python + uv
+      - name: '🐍 Set up Python + UV'
         uses: "./.github/actions/uv_setup"
         with:
           python-version: ${{ env.PYTHON_VERSION }}
@@ -45,17 +45,17 @@ jobs:
       # > It is strongly advised to separate jobs for building [...]
       # > from the publish job.
       # https://github.com/pypa/gh-action-pypi-publish#non-goals
-      - name: Build project for distribution
+      - name: '📦 Build Project for Distribution'
         run: uv build
         working-directory: ${{ inputs.working-directory }}
 
-      - name: Upload build
+      - name: '⬆️ Upload Build Artifacts'
         uses: actions/upload-artifact@v4
         with:
           name: test-dist
           path: ${{ inputs.working-directory }}/dist/
 
-      - name: Check Version
+      - name: '🔍 Extract Version Information'
         id: check-version
         shell: python
         working-directory: ${{ inputs.working-directory }}