OSOE-188: YAML Linting

.github/actions/check-current-workflow-is-latest/action.yml

@@ -21,7 +21,7 @@ runs:
       shell: pwsh
       run: |
         (Resolve-Path "${{ github.action_path }}/../../../Scripts").Path >> $Env:GITHUB_PATH
-      
+
     - name: Check Current Workflow Equals Latest
       shell: pwsh
       id: check-current-workflow-equals-latest

.github/actions/check-merge-queue-adds/action.yml

@@ -1,7 +1,7 @@
 name: Check Merge Queue Adds
 description: >
-  Checks current pull request timeline add events to determine if it was ever added to a 
-  merge queue. Intentionally not documented in Actions.md since it's only meant for 
+  Checks current pull request timeline add events to determine if it was ever added to a
+  merge queue. Intentionally not documented in Actions.md since it's only meant for
   internal use.
 
 outputs:

.github/actions/get-changed-gha-items/Get-GHA-Items-From-File-List.ps1 → .github/actions/get-changed-gha-items/Get-GhaItemsFromFileList.ps1

@@ -4,18 +4,38 @@ param(
 
 # Filter actions based on files in action directory.
 [array]$actionFiles = $FileIncludeList | Where-Object -FilterScript {
-    (Get-Item $PSitem).Directory.GetFiles('action.yml').Count -gt 0 -or
-    (Get-Item $PSitem).Directory.GetFiles('action.yaml').Count -gt 0
+    try
+    {
+        $itemDirectory = (Get-Item $PSItem).Directory.FullName
+        $isInGitHubDir = $itemDirectory -like '*/.github/*' -or $itemDirectory -eq '*/.github'
+        if (-not $isInGitHubDir) {
+            return $false
+        }
+
+        (Get-Item $PSitem).Directory.GetFiles('action.yml').Count -gt 0 -or
+        (Get-Item $PSitem).Directory.GetFiles('action.yaml').Count -gt 0
+    }
+    catch
+    {
+        return $false
+    }
 }
 
 # GitHub Actions are called by directory name. Get directory and de-duplicate list.
 [array]$actions = $actionFiles.ForEach({ $PSItem.Replace('/' + $(Get-Item $PSItem).Name, '') }) | Select-Object -Unique
 
 # Filter workflow files excluding action yaml file names.
 [array]$workflows = $FileIncludeList | Where-Object -FilterScript {
-    (Get-Item $PSitem).BaseName -ne 'action' -and
-        ((Get-Item $PSitem).Extension -eq '.yml' -or
-         (Get-Item $PSitem).Extension -eq '.yaml')
+    try
+    {
+        (Get-Item $PSitem).BaseName -ne 'action' -and
+            ((Get-Item $PSitem).Extension -eq '.yml' -or
+             (Get-Item $PSitem).Extension -eq '.yaml')
+    }
+    catch
+    {
+        return $false
+    }
 }
 
 # Combine actions and workflows.

.github/actions/get-changed-gha-items/action.yml

@@ -7,7 +7,7 @@ inputs:
     required: false
     default: '@()'
     description: >
-      PowerShell string array of file names to return corresponding GitHub Actions (GHA) items. The 
+      PowerShell string array of file names to return corresponding GitHub Actions (GHA) items. The
       parameter must be a PowerShell string array.
 outputs:
   changed-items:
@@ -20,12 +20,12 @@ runs:
       shell: pwsh
       run: |
         "${{ github.action_path }}" >> $Env:GITHUB_PATH
-        
+
     - name: Get GHA Items
       id: get-gha-items
       shell: pwsh
       run: |
         $params = @{
             FileIncludeList = ${{ inputs.file-include-list }}
         }
-        Get-GHA-Items-From-File-List @params
+        Get-GhaItemsFromFileList @params

.github/actions/spelling/allow.txt

@@ -0,0 +1 @@
+runtimes

.github/actions/yaml-lint/action.yml

@@ -0,0 +1,21 @@
+name: YAML Linting
+description: Runs a linter on YAML files.
+
+
+inputs:
+  config-file-path:
+    description: 'Path to the yamllint configuration file'
+    required: true
+    default: '.yamllint.yaml'
+
+  search-path:
+    description: 'Path to search for YAML files'
+    required: true
+    default: '.'
+
+runs:
+  using: "composite"
+  steps:
+    - name: Run yamllint
+      run: yamllint -c "${{ inputs.config-file-path }}" "${{ inputs.search-path }}"
+      shell: pwsh

.github/workflows/build-and-test-dotnet.yml

@@ -183,7 +183,7 @@ jobs:
 
       - name: Verify that .NET packages are consolidated
         if: ${{ inputs.verify-dotnet-consolidation }}
-        uses: Lombiq/GitHub-Actions/.github/actions/verify-dotnet-consolidation@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/verify-dotnet-consolidation@issue/OSOE-188
         with:
           directory: ${{ inputs.build-directory }}
           exclude-version-regex: ${{ inputs.dotnet-consolidation-exclude-version-regex }}

.github/workflows/build-and-test-orchard-core.yml

@@ -206,7 +206,7 @@ jobs:
 
       - name: Verify that .NET packages are consolidated
         if: ${{ inputs.verify-dotnet-consolidation }}
-        uses: Lombiq/GitHub-Actions/.github/actions/verify-dotnet-consolidation@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/verify-dotnet-consolidation@issue/OSOE-188
         with:
           directory: ${{ inputs.build-directory }}
           exclude-version-regex: ${{ inputs.dotnet-consolidation-exclude-version-regex }}

.github/workflows/build-dotnet.yml

@@ -99,7 +99,7 @@ jobs:
 
       - name: Verify that .NET packages are consolidated
         if: ${{ inputs.verify-dotnet-consolidation }}
-        uses: Lombiq/GitHub-Actions/.github/actions/verify-dotnet-consolidation@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/verify-dotnet-consolidation@issue/OSOE-188
         with:
           directory: ${{ inputs.build-directory }}
 

.github/workflows/post-pull-request-checks-automation.yml

@@ -54,7 +54,7 @@ jobs:
     steps:
       - name: Check Further Steps Should Run
         if: inputs.run-only-latest-workflow == 'true'
-        uses: Lombiq/GitHub-Actions/.github/actions/check-current-workflow-is-latest@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/check-current-workflow-is-latest@issue/OSOE-188
         id: check-steps-should-run
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -72,15 +72,15 @@ jobs:
 
       - name: Automatically Merge Pull Request
         if: steps.check-steps-should-run.outputs.is-latest != 'false'
-        uses: Lombiq/GitHub-Actions/.github/actions/auto-merge-pull-request@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/auto-merge-pull-request@issue/OSOE-188
         env:
           GITHUB_TOKEN: ${{ env.MERGE_TOKEN }}
         with:
           merge-method: ${{ inputs.merge-method }}
 
       - name: Automatically Resolve or Done Jira issue
         if: steps.check-steps-should-run.outputs.is-latest != 'false'
-        uses: Lombiq/GitHub-Actions/.github/actions/auto-resolve-done-jira-issue@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/auto-resolve-done-jira-issue@issue/OSOE-188
         env:
           GITHUB_TOKEN: ${{ env.MERGE_TOKEN }}
           JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}

.github/workflows/spelling-this-repo.yml

@@ -11,4 +11,4 @@ on:
 jobs:
   spelling:
     name: Spelling
-    uses: Lombiq/GitHub-Actions/.github/workflows/spelling.yml@dev
+    uses: Lombiq/GitHub-Actions/.github/workflows/spelling.yml@issue/OSOE-188

.github/workflows/spelling.yml

@@ -111,7 +111,7 @@ jobs:
 
       - name: Check Spelling
         id: check-spelling-action
-        uses: Lombiq/GitHub-Actions/.github/actions/spelling@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/spelling@issue/OSOE-188
         with:
           merge-file-excludes: ${{ inputs.merge-file-excludes }}
           merge-forbidden-patterns: ${{ inputs.merge-forbidden-patterns }}
@@ -125,7 +125,7 @@ jobs:
 
       - name: Cancel Workflow on Failure
         if: failure() && inputs.cancel-workflow-on-failure == 'true'
-        uses: Lombiq/GitHub-Actions/.github/actions/cancel-workflow@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/cancel-workflow@issue/OSOE-188
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -138,7 +138,7 @@ jobs:
     if: always() && needs.check-spelling.outputs.followup && github.event_name == 'pull_request'
     steps:
       - name: Comment (PR)
-        uses: Lombiq/GitHub-Actions/.github/actions/spelling@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/spelling@issue/OSOE-188
         with:
           post-comment: 1
           task: ${{ needs.check-spelling.outputs.followup }}

.github/workflows/validate-this-gha-refs.yml

@@ -20,12 +20,12 @@ jobs:
 
       - name: Checkout Repository (Push)
         if: github.event_name == 'push'
-        uses: Lombiq/GitHub-Actions/.github/actions/checkout@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/checkout@issue/OSOE-188
 
       - name: Check Merge Queue Adds
         id: check-merge-queue-adds
         if: github.event_name == 'pull_request' || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved')
-        uses: Lombiq/GitHub-Actions/.github/actions/check-merge-queue-adds@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/check-merge-queue-adds@issue/OSOE-188
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -44,7 +44,7 @@ jobs:
       - name: Get Applicable Git File Changes
         id: git-diff
         if: github.event_name == 'pull_request' || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved') || github.event_name == 'merge_group'
-        uses: Lombiq/GitHub-Actions/.github/actions/get-changed-files-from-git-diff@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/get-changed-files-from-git-diff@issue/OSOE-188
         with:
           left-commit: ${{ github.event_name == 'merge_group' && github.event.merge_group.base_sha || github.event.pull_request.base.sha }}
           right-commit: ${{ github.sha }}
@@ -53,7 +53,7 @@ jobs:
       - name: Get GitHub Actions Item Changes from File Changes
         id: changed-items
         if: github.event_name == 'pull_request' || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved') || github.event_name == 'merge_group'
-        uses: Lombiq/GitHub-Actions/.github/actions/get-changed-gha-items@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/get-changed-gha-items@issue/OSOE-188
         with:
           file-include-list: '${{ steps.git-diff.outputs.changed-files }}'
 
@@ -72,7 +72,7 @@ jobs:
       - name: Check PR Reviews
         id: check-pr-reviews
         if: github.event_name == 'pull_request' || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved')
-        uses: Lombiq/GitHub-Actions/.github/actions/check-pull-request-reviews@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/check-pull-request-reviews@issue/OSOE-188
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -112,11 +112,11 @@ jobs:
 
       - name: Verify GitHub Actions Items Match Expected Ref (Pull & Approve/Merge PR)
         if: (github.event_name == 'pull_request' || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved') || github.event_name == 'merge_group') && steps.add-prefix.outputs.prefixed-files != '@()'
-        uses: Lombiq/GitHub-Actions/.github/actions/verify-gha-refs@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/verify-gha-refs@issue/OSOE-188
         with:
           called-repo-base-include-list: '${{ steps.add-prefix.outputs.prefixed-files }}'
           expected-ref: ${{ steps.determine-ref.outputs.expected-ref }}
 
       - name: Verify GitHub Actions Items Match Expected Ref (Push)
         if: github.event_name == 'push'
-        uses: Lombiq/GitHub-Actions/.github/actions/verify-gha-refs@dev
+        uses: Lombiq/GitHub-Actions/.github/actions/verify-gha-refs@issue/OSOE-188

.github/workflows/yaml-lint-this-repo.yml

@@ -0,0 +1,16 @@
+name: YAML Linting
+
+# Runs for PRs opened for any branch, and pushes to the dev branch.
+on:
+  pull_request:
+  push:
+    branches:
+      - dev
+
+jobs:
+  yaml-linting:
+    name: YAML Linting
+    uses: Lombiq/GitHub-Actions/.github/workflows/yaml-lint.yml@issue/OSOE-188
+    with:
+      config-file-path: '.trunk/configs/.yamllint.yaml'
+      search-path: '.'

.github/workflows/yaml-lint.yml

@@ -0,0 +1,55 @@
+name: YAML Linting
+
+on:
+  workflow_call:
+    secrets:
+      CHECKOUT_TOKEN:
+        required: false
+        description: >
+          The GitHub token to authenticate checkout. Pass in a GitHub personal access token if authenticated submodules
+          are used.
+
+    inputs:
+      timeout-minutes:
+        required: false
+        type: number
+        default: 10
+        description: Configuration for the timeout-minutes parameter of the workflow. GitHub's default is 360.
+      cancel-workflow-on-failure:
+        description: If set to "true", this will cancel the current workflow run with all jobs if this workflow fails.
+        required: false
+        type: string
+        default: "true"
+      config-file-path:
+        description: 'Path to the yamllint configuration file'
+        required: true
+        type: string
+        default: '.yamllint.yaml'
+      search-path:
+        description: 'Path to search for YAML files'
+        required: true
+        type: string
+        default: '.'
+
+jobs:
+  yaml-linting:
+    runs-on: ubuntu-22.04
+    name: YAML Linting Job
+    timeout-minutes: ${{ inputs.timeout-minutes }}
+    steps:
+      - name: Checkout
+        uses: Lombiq/GitHub-Actions/.github/actions/checkout@dev
+        with:
+          token: ${{ secrets.CHECKOUT_TOKEN }}
+
+      - name: YAML Linting
+        uses: Lombiq/GitHub-Actions/.github/actions/yaml-lint@issue/OSOE-188
+        with:
+          config-file-path: ${{ inputs.config-file-path }}
+          search-path: ${{ inputs.search-path }}
+
+      - name: Cancel Workflow on Failure
+        if: failure() && inputs.cancel-workflow-on-failure == 'true'
+        uses: Lombiq/GitHub-Actions/.github/actions/cancel-workflow@dev
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.trunk/.gitignore

@@ -0,0 +1,8 @@
+*out
+*logs
+*actions
+*notifications
+*tools
+plugins
+user_trunk.yaml
+user.yaml

.trunk/configs/.yamllint.yaml

@@ -0,0 +1,16 @@
+yaml-files:
+  - '*.yaml'
+  - '*.yml'
+  - '.yamllint'
+
+ignore: |
+  **/node_modules/**
+  **/.trunk/**
+
+rules:
+    trailing-spaces: {}
+    key-duplicates: {}
+    quoted-strings: {
+        quote-type: any,
+        required: false
+    }

.trunk/trunk.yaml

@@ -0,0 +1,20 @@
+# This file controls the behavior of Trunk: https://docs.trunk.io/cli
+# To learn more about the format of this file, see https://docs.trunk.io/reference/trunk-yaml
+version: 0.1
+cli:
+    version: 1.17.2
+# Trunk provides extensibility via plugins. (https://docs.trunk.io/plugins)
+plugins:
+    sources:
+        - id: trunk
+          ref: v1.3.0
+          uri: https://github.com/trunk-io/plugins
+# Many linters and tools depend on runtimes - configure them here. (https://docs.trunk.io/runtimes)
+runtimes:
+    enabled:
+        - [email protected]
+        - [email protected]
+# This is the section where you manage your linters. (https://docs.trunk.io/check/configuration)
+lint:
+    enabled:
+        - [email protected]

Docs/Workflows.md

@@ -30,6 +30,7 @@ These features are designed to reduce resource usage (like paid GitHub Actions m
 - [Spell-checking](Workflows/Productivity/SpellChecking.md)
 - [Validate pull request](Workflows/Productivity/ValidatePullRequest.md)
 - [Validate submodule](Workflows/Productivity/ValidateSubmodule.md)
+- [Lint YAML files](Workflows/Productivity/YamlLinting.md)
 
 ## Azure hosting