Update linters

Author: sethvargo

.github/workflows/unit.yml

@@ -31,16 +31,10 @@ jobs:
 
       - uses: 'actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a' # ratchet:actions/setup-node@v4
         with:
-          node-version: '20.x'
+          node-version-file: 'package.json'
 
       - name: 'npm build'
         run: 'npm ci && npm run build'
 
-      - name: 'npm lint'
-        # There's no need to run the linter for each operating system, since it
-        # will find the same thing 3x and clog up the PR review.
-        if: ${{ matrix.os == 'ubuntu-latest' }}
-        run: 'npm run lint'
-
       - name: 'npm test'
         run: 'npm run test'

action.yml

@@ -12,10 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: SSH to Google Cloud Platform compute instances
-author: Google LLC
+name: 'SSH to Google Cloud Platform compute instances'
+author: 'Google LLC'
 description: |-
-  Use this action to connect to Google Cloud Platform instances via ssh and execute user's commands.
+  Use this action to connect to Google Cloud Platform instances via ssh and
+  execute user's commands.
 
 inputs:
   instance_name:
@@ -71,7 +72,8 @@ inputs:
     required: false
 
   project_id:
-    description: The GCP project ID. Overrides project ID set by credentials.
+    description: |-
+      The GCP project ID. Overrides project ID set by credentials.
     required: false
 
   flags:
@@ -97,9 +99,11 @@ inputs:
 
 outputs:
   stdout:
-    description: Stdout from ssh command.
+    description: |-
+      Stdout from ssh command.
   stderr:
-    description: Stderr from ssh command.
+    description: |-
+      Stderr from ssh command.
 
 branding:
   icon: 'terminal'

bin/runTests.sh

@@ -16,4 +16,6 @@ set -eEuo pipefail
 FILES="$(node -e "process.stdout.write(require('node:fs').readdirSync('./', { recursive: true }).filter((e) => {return e.endsWith('.test.ts') && !e.startsWith('node_modules');}).sort().join(' '));")"
 
 set -x
+
+# shellcheck disable=SC2086
 exec node --require ts-node/register --test-reporter spec --test ${FILES}

package.json

@@ -9,6 +9,10 @@
     "format": "eslint . --fix",
     "test": "bash ./bin/runTests.sh"
   },
+  "engines": {
+    "node": "20.x",
+    "npm": "10.x"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/google-github-actions/ssh-compute.git"

workflow-examples/ssh-command-example.yml

@@ -29,27 +29,27 @@ jobs:
       id-token: 'write'
 
     steps:
-    - name: 'Checkout'
-      uses: 'actions/checkout@v3'
+      - name: 'Checkout'
+        uses: 'actions/checkout@v3'
 
-    # Configure Workload Identity Federation and generate an access token.
-    - id: 'auth'
-      name: 'Authenticate to Google Cloud'
-      uses: 'google-github-actions/auth@v2'
-      with:
-        workload_identity_provider: '${{ vars.WIF_PROVIDER_NAME }}'
-        service_account: '${{ vars.SERVICE_ACCOUNT_EMAIL }}'
+      # Configure Workload Identity Federation and generate an access token.
+      - id: 'auth'
+        name: 'Authenticate to Google Cloud'
+        uses: 'google-github-actions/auth@v2'
+        with:
+          workload_identity_provider: '${{ vars.WIF_PROVIDER_NAME }}'
+          service_account: '${{ vars.SERVICE_ACCOUNT_EMAIL }}'
 
-    - name: 'SSH to GCP instance'
-      id: 'ssh'
-      uses: 'google-github-actions/ssh-compute@v1'
-      with:
-        instance_name: 'instance-name'
-        zone: '${{ env.ZONE }}'
-        ssh_private_key: '${{ secrets.VM_PRIVATE_KEY }}'
-        command: 'echo Hello world'
+      - name: 'SSH to GCP instance'
+        id: 'ssh'
+        uses: 'google-github-actions/ssh-compute@v1'
+        with:
+          instance_name: 'instance-name'
+          zone: '${{ env.ZONE }}'
+          ssh_private_key: '${{ secrets.VM_PRIVATE_KEY }}'
+          command: 'echo Hello world'
 
-    - name: 'Show Output'
-      run: |-
-        echo '${{ steps.ssh.outputs.stdout }}'
-        echo '${{ steps.ssh.outputs.stderr }}'
+      - name: 'Show Output'
+        run: |-
+          echo '${{ steps.ssh.outputs.stdout }}'
+          echo '${{ steps.ssh.outputs.stderr }}'

workflow-examples/ssh-script-example.yml

@@ -29,27 +29,27 @@ jobs:
       id-token: 'write'
 
     steps:
-    - name: 'Checkout'
-      uses: 'actions/checkout@v3'
+      - name: 'Checkout'
+        uses: 'actions/checkout@v3'
 
-    # Configure Workload Identity Federation and generate an access token.
-    - id: 'auth'
-      name: 'Authenticate to Google Cloud'
-      uses: 'google-github-actions/auth@v2'
-      with:
-        workload_identity_provider: '${{ vars.WIF_PROVIDER_NAME }}'
-        service_account: '${{ vars.SERVICE_ACCOUNT_EMAIL }}'
+      # Configure Workload Identity Federation and generate an access token.
+      - id: 'auth'
+        name: 'Authenticate to Google Cloud'
+        uses: 'google-github-actions/auth@v2'
+        with:
+          workload_identity_provider: '${{ vars.WIF_PROVIDER_NAME }}'
+          service_account: '${{ vars.SERVICE_ACCOUNT_EMAIL }}'
 
-    - name: 'SSH to GCP instance'
-      id: 'ssh'
-      uses: 'google-github-actions/ssh-compute@v1'
-      with:
-        instance_name: 'instance-name'
-        zone: '${{ env.ZONE }}'
-        ssh_private_key: '${{ secrets.VM_PRIVATE_KEY }}'
-        script: '${{ github.workspace }}/script-examples/script.sh'
+      - name: 'SSH to GCP instance'
+        id: 'ssh'
+        uses: 'google-github-actions/ssh-compute@v1'
+        with:
+          instance_name: 'instance-name'
+          zone: '${{ env.ZONE }}'
+          ssh_private_key: '${{ secrets.VM_PRIVATE_KEY }}'
+          script: '${{ github.workspace }}/script-examples/script.sh'
 
-    - name: 'Show Output'
-      run: |-
-        echo '${{ steps.ssh.outputs.stdout }}'
-        echo '${{ steps.ssh.outputs.stderr }}'
+      - name: 'Show Output'
+        run: |-
+          echo '${{ steps.ssh.outputs.stdout }}'
+          echo '${{ steps.ssh.outputs.stderr }}'