From ebfebab310a5401910fd2e7051b386984c55ca66 Mon Sep 17 00:00:00 2001
From: Derek Croote <dcroote@users.noreply.github.com>
Date: Tue, 27 Aug 2024 21:59:51 -0700
Subject: [PATCH] Cleanup and add comment

---
 .github/workflows/check-against-commons.yml | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/check-against-commons.yml b/.github/workflows/check-against-commons.yml
index 680b8f7..0694a08 100644
--- a/.github/workflows/check-against-commons.yml
+++ b/.github/workflows/check-against-commons.yml
@@ -1,4 +1,4 @@
-name: Check Breaking Changes
+name: Check for breaking changes
 
 on:
   pull_request:
@@ -32,20 +32,22 @@ jobs:
           PACKAGE_PATH=$(pnpm pack | tail -n 1)
           echo "PACKAGE_PATH=$PACKAGE_PATH" >> $GITHUB_ENV
 
-      - name: Checkout api3dao/${{ env.repo_name }} repository
+      - name: Checkout api3dao/${{ env.repo_name }} repo
         uses: actions/checkout@v4
         with:
           repository: api3dao/${{ env.repo_name }}
           path: ${{ env.repo_name }}
 
-      - name: Move ${{ env.repo_name }} outside of the repo
+      # Workaround for inability clone outside of workspace directory
+      # See: https://github.com/actions/checkout/issues/197#issuecomment-603651324
+      - name: Move ${{ env.repo_name }} directory outside of eslint-plugin-commons repo
         run: mv ${{ env.repo_name }} ../
 
-      - name: Install packaged version in ${{ env.repo_name }}
+      - name: Install packaged eslint-plugin-commons in ${{ env.repo_name }}
         working-directory: ../${{ env.repo_name }}
         run: |
           pnpm add -D file:../eslint-plugin-commons/${{ env.PACKAGE_PATH }}
 
       - name: Run ESLint on ${{ env.repo_name }}
         working-directory: ../${{ env.repo_name }}
-        run: pnpm eslint .
\ No newline at end of file
+        run: pnpm eslint .