Init action

.github/workflows/superlinter.yml

@@ -0,0 +1,54 @@
+---
+#################################
+#################################
+## Super Linter GitHub Actions ##
+#################################
+#################################
+name: Lint Code Base
+
+#############################
+# Start the job on all push #
+#############################
+on:
+  push:
+    paths:
+    - .github/workflows/superlinter.yml
+  #pull_request:
+
+###############
+# Set the Job #
+###############
+jobs:
+  build:
+    # Name the Job
+    name: Lint Code Base
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+
+    permissions:
+      pull-requests: write
+      statuses: write
+
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          # Full git history is needed to get a proper
+          # list of changed files within `super-linter`
+          fetch-depth: 0
+
+      ################################
+      # Run Linter against code base #
+      ################################
+      - name: Lint Code Base
+        uses: github/super-linter/slim@v4
+        env:
+          VALIDATE_ALL_CODEBASE: true
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test-local-action.yml

@@ -0,0 +1,72 @@
+name: Test local action
+on:
+  push:
+
+  pull_request:
+
+jobs:
+  test-local-action:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Run the local action from the checked out branch
+        id: action-lint
+        uses: ./
+
+      - name: Check for no reported errors
+        if: steps.action-lint.outcome=='success'
+        run: |
+          echo "Error in 'action-lint' step, expeced a failure status, but got success"
+          # fail the job so reporting can pick it up
+          exit 1
+
+      - name: Check for expected errors
+        if: always() && steps.action-lint.outcome=='failure'
+        run: |
+          echo "Todo: check the results of fake-output and fake-secret"
+
+      - name: Test output file and expected contents
+        if: always()
+        shell: pwsh
+        env:
+          RESULTFILE: ${{ steps.action-lint.outputs.results-file }}
+        run: |
+          echo "Results file is [$env:RESULTFILE]"
+          $result = Get-Content $env:RESULTFILE       
+          $items = @(ConvertFrom-Json $result -Depth 10)     
+
+          $found1 = $false
+          foreach ($item in $items) { 
+            Write-Host "Found an error: "
+            Write-Host "Message:" $item.message
+            Write-Host "Filepath:" $item.filepath
+            Write-Host "Line:" $item.line
+
+            if ($item.filepath -eq ".github/workflows/test-local-action.yml" -and $item.line -eq 63) {
+              $found1 = $true
+            }
+          }      
+
+          if (!$found1){
+            echo "Error finding the first expected result. Exiting with failure"
+            exit 1
+          } 
+          else {
+            Write-Host "Found the expected error succesfully"
+          }
+
+  job-with-errors:
+    runs-on: ubuntu-latest
+    steps:
+     - name: Non existing output
+       id: fake-output
+       run: |
+        echo "Let's echo an output that does not exist, should fail the check:"
+        echo "Output that does not exist: ${{ needs.test-with-local-action.outputs.fake-output }}"
+
+     - name: Non existing secret
+       id: fake-secret
+       run: |
+        echo "Let's echo a secret that does not exist, should fail the check:"
+        echo "Secret that does not exist: ${{ secrets.fake-secret }}"

action.yml

@@ -0,0 +1,37 @@
+name: Rhysd actionlint
+description: Check your workflows for common errors, like not declaring outputs before using them, bash script errors, and more!
+branding:
+  icon: tag
+  color: gray-dark
+outputs:
+  results-file:
+    description: "Path to the json results of the linter"
+    value: ${{ steps.run.outputs.resultsfile }}
+
+runs:
+  using: composite
+  steps:
+  - name: Add anotation matcher
+    run: echo "::add-matcher::actionlint-matcher.json"
+    shell: bash
+
+  - name: Docker run    
+    shell: bash
+    id: run
+    run: |
+      # running version 1.6.22 of rhysd/actionlint
+      # disable pipefail -e -o that is set on the shell script from the runner to prevent exiting when the docker run command fails
+      set +e +o pipefail;
+      result=$(docker run -v /home/runner/work/actionlint/actionlint:/repo --workdir /repo rhysd/actionlint@sha256:5f957b2a08d223e48133e1a914ed046bea12e578fe2f6ae4de47fdbe691a2468 -color -format "{{json .}}")
+      status=$?
+      #echo "Loaded status [$status]"
+      if [[ $status == 0 ]];
+      then
+        echo "actionlint had no errors"
+      else
+        echo "actionlint found errors"
+      fi
+      echo $result > "actionlint-errors.json"
+      echo "resultsfile=actionlint-errors.json" >> $GITHUB_OUTPUT
+
+      exit $status

actionlint-matcher.json

@@ -0,0 +1,17 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "actionlint",
+      "pattern": [
+        {
+          "regexp": "^(?:\\x1b\\[\\d+m)?(.+?)(?:\\x1b\\[\\d+m)*:(?:\\x1b\\[\\d+m)*(\\d+)(?:\\x1b\\[\\d+m)*:(?:\\x1b\\[\\d+m)*(\\d+)(?:\\x1b\\[\\d+m)*: (?:\\x1b\\[\\d+m)*(.+?)(?:\\x1b\\[\\d+m)* \\[(.+?)\\]$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "message": 4,
+          "code": 5
+        }
+      ]
+    }
+  ]
+}