Merge pull request #21 from mgandharva/spell-test-autofix

code updated

.github/workflows/Spell-check-autofix/codespell-autofix.sh

@@ -2,29 +2,42 @@
 
 # Determine the directory of the script
 script_dir=$(dirname "$(readlink -f "$0")")
-echo "Script dir: $script_dir"
+echo "Script directory: $script_dir"
 
 # Define the target directory
 target_dir=$(realpath "$script_dir/../../..")
+echo "Target directory: $target_dir"
 
-echo "Target dir: $target_dir"
 # Run codespell and capture output, targeting the test-csm-docs directory
-output=$(find "$target_dir" -type f -name "*.md" -exec codespell --ignore-words="$script_dir/codespell.txt" --builtin clear,rare,informal --write-changes --quiet-level=0 {} +)
+output=$(find "$target_dir" -type f -name "*.md" -exec codespell \
+  --ignore-words="$script_dir/codespell.txt" --builtin clear,rare,informal \
+  --write-changes --quiet-level=0 {} +)
 
-echo "Output: $output"
+# Print each line of the output separately for readability
+echo "Codespell Output:"
+echo "$output" | while IFS= read -r line; do
+  echo "$line"
+done
 
 # Process the output and apply the first suggestion
+echo "Processing changes..."
 echo "$output" | while IFS= read -r line; do
-    if [[ $line == *"=="* ]]; then
-        file=$(echo "$line" | cut -d':' -f1)
-        error_line=$(echo "$line" | cut -d':' -f2)
-        original=$(echo "$line" | awk -F ' ' '{print $2}')
-        suggestion=$(echo "$line" | grep -oP '(?<= ==>)\s\K[^,]*')
-
-        # Apply the first suggestion
-        if [ -n "$suggestion" ] && [ -f "$file" ]; then
-            sed -i "${error_line}s/$original/$suggestion/" "$file"
-            echo "Fixed $original to $suggestion in $file on line $error_line"
-        fi
+  if [[ $line == *" ==>"* ]]; then
+    # Extract file, line number, original word, and suggestion
+    file=$(echo "$line" | cut -d':' -f1)
+    error_line=$(echo "$line" | cut -d':' -f2)
+    original=$(echo "$line" | awk '{print $2}')
+    suggestion=$(echo "$line" | awk -F'[ ]+==> ' '{print $2}' | cut -d',' -f1)
+
+    # Ensure the file is inside the test-csm-docs directory
+    if [[ $file == $target_dir/* ]]; then
+      # Apply the first suggestion
+      if [ -n "$suggestion" ] && [ -f "$file" ]; then
+        sed -i "${error_line}s/\b$original\b/$suggestion/" "$file"
+        echo "Fixed $original to $suggestion in $file on line $error_line"
+      fi
+    else
+      echo "Skipping file not in target directory: $file"
     fi
+  fi
 done

.github/workflows/spellcheck-autofix.yaml

@@ -1,46 +1,47 @@
-name: Spellchecking Final Autofix
+name: Automatic Spell Check and Correction
 
 on: 
   workflow_dispatch:
   repository_dispatch:
-    types: [spell-check-workflow]
+    types: [trigger-spell-check-autofix]
 
 jobs:
   codespell:
-    name: Check spelling with codespell and autofix
+    name: Perform Spell Check and Apply Fixes
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [3.8]  # Define the Python version here
+
     steps:
-      - name: Checkout code
+      - name: Checkout Repository
         uses: actions/checkout@v2
 
-      - name: Import GPG key
+      - name: Import GPG Key
         uses: crazy-max/ghaction-import-gpg@v6
         with:
-            gpg_private_key: ${{ secrets.CSM_GPG_PRIVATE_KEY }}
-            git_user_signingkey: true
-            git_commit_gpgsign: true
-            git_tag_gpgsign: true
-            git_config_global: true
+          gpg_private_key: ${{ secrets.CSM_GPG_PRIVATE_KEY }}
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+          git_tag_gpgsign: true
+          git_config_global: true
 
-      - name: Set up Python
+      - name: Set Up Python Environment
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install dependencies
+      - name: Install Codespell
         run: |
           python -m pip install --upgrade pip
           pip install codespell
 
-      - name: Check and fix spelling with codespell
+      - name: Run Codespell Autofix
         run: |
           chmod +x .github/workflows/Spell-check-autofix/codespell-autofix.sh
           ./.github/workflows/Spell-check-autofix/codespell-autofix.sh
-      
-      - name: Check for uncommitted changes
+
+      - name: Check for Uncommitted Changes
         id: check_changes
         run: |
           git status
@@ -50,28 +51,38 @@ jobs:
             echo "CHANGES_DETECTED=false" >> $GITHUB_ENV
           fi
 
-      - name: Print changes detected
+      - name: Print Changes Detected
         run: |
           echo "Changes detected: ${{ env.CHANGES_DETECTED }}"
 
-      - name: Commit and push changes
+      - name: Commit and Push Changes
         if: env.CHANGES_DETECTED == 'true'
         run: |
           git add .
           git commit -m "Autofix spelling issues"
 
-      - uses: actions/[email protected]
+      - name: Generate GitHub App Token
+        uses: actions/[email protected]
         id: generate-token
+        if: env.CHANGES_DETECTED == 'true'
         with:
           app-id: ${{ vars.CSM_RELEASE_APP_ID }}
           private-key: ${{ secrets.CSM_RELEASE_APP_PRIVATE_KEY }}
 
-      - name: Create Pull Request
+      - name: Create Pull Request with Autofixes
+        if: env.CHANGES_DETECTED == 'true'
         uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ steps.generate-token.outputs.token }}
-          branch: autofix-spelling
-          title: 'Autofix spelling issues'
-          body: "This pull request was created automatically by a GitHub Action that fixes spelling errors."
+          branch: spellcheck-fixes
+          title: 'Automated Spelling Corrections Applied'
+          body: |
+            This pull request was created automatically by a GitHub Action that fixes spelling errors across multiple files.
+
+            **Summary of changes:**
+            - Identified and corrected common spelling mistakes
+            - Ensured consistency and accuracy in documentation files
+
+            Please review the changes to confirm their accuracy and approve the PR.
           sign-commits: true
           delete-branch: true