linter.yml

---
###########################
###########################
## Linter GitHub Actions ##
###########################
###########################
name: Lint Code Base

#
# Documentation:
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
#

#############################
# Start the job on all push #
#############################
on: [push]

###############
# Set the Job #
###############
jobs:
  build:
    # Name the Job
    name: Lint Code Base
    # Set the agent to run on
    runs-on: ubuntu-latest

    ##################
    # 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

      - name: Install Ruby dependencies
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: 3.2.2
          bundler-cache: true

      - name: Install Node.js dependencies
        uses: actions/setup-node@v3
        with:
          node-version: "16"
      - run: npm install --production=false  # Install linting tools

      - name: Build site
        run: bundle exec jekyll build

      ################################
      # Run npm prettier linting     #
      ################################
      - name: Prettier Lint
        run: npm run lint:check || exit 1

      ################################
      # Run Linter against code base #
      ################################
      - name: Lint Code Base
        uses: github/super-linter@v4.0.2
        env:
          DEFAULT_BRANCH: main
          FILTER_REGEX_INCLUDE: .*(\assets|\_pages|\_site).*
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          LINTER_RULES_PATH: /
          VALIDATE_CSS: true
          VALIDATE_HTML: true
          VALIDATE_MARKDOWN: true