Merge pull request #37 from Expensify/Rory-TellPeopleHowToRunTheChecks

GitHub Actions checks cleanup

Author: rafecolton

.github/workflows/shellCheck.yml

@@ -16,4 +16,4 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
 
       - name: Lint shell scripts with ShellCheck
-        run: npm run shellCheck
+        run: ./scripts/shellCheck.sh

.github/workflows/validateActions.yml

@@ -22,10 +22,14 @@ jobs:
         run: npm i -g ajv-cli@5.0.0
 
       - name: Validate action and workflow schemas
-        run: GitHub-Actions/.github/scripts/validateWorkflowSchemas.sh
+        run: GitHub-Actions/scripts/validateWorkflowSchemas.sh
         env:
           REPO_ROOT: ${{ steps.repo.outputs.NAME }}
 
+      - name: Tell people how to run the failing check
+        if: failure()
+        run: echo "::error::The validateWorkflowSchemas check failed! To run it locally, go to the root of ${{ steps.repo.outputs.NAME }} and run <path_to_github_actions_repo>/scripts/validateWorkflowSchemas.sh"
+
   actionlint:
     runs-on: ubuntu-latest
     steps:
@@ -34,10 +38,14 @@ jobs:
         uses: Expensify/GitHub-Actions/checkoutRepoAndGitHubActions@main
 
       - name: Lint workflows with actionlint
-        run: GitHub-Actions/.github/scripts/actionlint.sh
+        run: GitHub-Actions/scripts/actionlint.sh
         env:
           REPO_ROOT: ${{ steps.repo.outputs.NAME }}
 
+      - name: Tell people how to run the failing check
+        if: failure()
+        run: echo "::error::The actionlint check failed! To run it locally, go to the root of ${{ steps.repo.outputs.NAME }} and run <path_to_github_actions_repo>/scripts/actionlint.sh"
+
   validateImmutableActionRefs:
     runs-on: ubuntu-latest
     steps:
@@ -46,6 +54,10 @@ jobs:
         uses: Expensify/GitHub-Actions/checkoutRepoAndGitHubActions@main
 
       - name: Validate actions refs are immutable
-        run: GitHub-Actions/.github/scripts/validateImmutableActionRefs.sh
+        run: GitHub-Actions/scripts/validateImmutableActionRefs.sh
         env:
           REPO_ROOT: ${{ steps.repo.outputs.NAME }}
+
+      - name: Tell people how to run the failing check
+        if: failure()
+        run: echo "::error::The validateImmutableActionRefs check failed! To run it locally, go to the root of ${{ steps.repo.outputs.NAME }} and run <path_to_github_actions_repo>/scripts/validateImmutableActionRefs.sh"

.gitignore

@@ -20,5 +20,5 @@ dist/
 
 # Ignore actionlint binary and any leftover directories related to installing it
 actionlint*
-!.github/scripts/actionlint.sh
-!.github/scripts/actionlint_checksums.txt
+!scripts/actionlint.sh
+!scripts/actionlint_checksums.txt

package-lock.json

@@ -1,9 +1,9 @@
 #!/bin/bash
 
-ROOT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/../.." &>/dev/null && pwd)
+ROOT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." &>/dev/null && pwd)
 readonly ROOT_DIR
 
-source "$ROOT_DIR"/.github/scripts/shellUtils.sh
+source "$ROOT_DIR"/scripts/shellUtils.sh
 
 readonly DIRECTORIES_TO_IGNORE="
 -path $ROOT_DIR/node_modules