reviewdog.yml

---
# Runs various ReviewDog based checks against PR with suggested changes to improve quality
name: Review
on:
  pull_request:
concurrency:
  group: review-${{ github.ref }}
  cancel-in-progress: true
jobs:
  prep-review:
    name: Prepare Review Jobs
    runs-on: ubuntu-latest
    outputs:
      actionlint: ${{ steps.actionlint.outputs.run }}
      golangci-lint: ${{ steps.golangci-lint.outputs.run }}
      hadolint: ${{ steps.hadolint.outputs.run }}
      shellcheck: ${{ steps.shellcheck.outputs.run }}
      yamllint: ${{ steps.yamllint.outputs.run }}
    steps:
      - name: Clone repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Check files for actionlint
        id: actionlint
        run: |
          if git diff --name-only origin/${{ github.base_ref }} HEAD -- | grep -Eq '\.github/workflows/.*' ; then
            echo "run=true" >> $GITHUB_OUTPUT
            echo 'GitHub Actions workflows have changed, need to run actionlint.'
          else
            echo "run=false" >> $GITHUB_OUTPUT
          fi
      - name: Check files for golangci-lint
        id: golangci-lint
        run: |
          if git diff --name-only origin/${{ github.base_ref }} HEAD -- | grep -Eq '.*\.go' ; then
            echo "run=true" >> $GITHUB_OUTPUT
            echo 'Go code has changed, need to run golangci-lint.'
          else
            echo "run=false" >> $GITHUB_OUTPUT
          fi
      - name: Check files for hadolint
        id: hadolint
        run: |
          if git diff --name-only origin/${{ github.base_ref }} HEAD -- | grep -Eq '.*Dockerfile.*' ; then
            echo "run=true" >> $GITHUB_OUTPUT
            echo 'Dockerfiles have changed, need to run Hadolint.'
          else
            echo "run=false" >> $GITHUB_OUTPUT
          fi
      - name: Check files for shellcheck
        id: shellcheck
        run: |
          if git diff --name-only origin/${{ github.base_ref }} HEAD -- | grep -Eq '.*\.sh.*' ; then
            echo "run=true" >> $GITHUB_OUTPUT
            echo 'Shell scripts have changed, need to run shellcheck.'
          else
            echo "run=false" >> $GITHUB_OUTPUT
          fi
      - name: Check files for yamllint
        id: yamllint
        run: |
          if git diff --name-only origin/${{ github.base_ref }} HEAD -- | grep -Eq '.*\.ya?ml|config/.*\.conf' ; then
            echo "run=true" >> $GITHUB_OUTPUT
            echo 'YAML files have changed, need to run yamllint.'
          else
            echo "run=false" >> $GITHUB_OUTPUT
          fi

  actionlint:
    name: actionlint
    needs: prep-review
    if: needs.prep-review.outputs.actionlint == 'true'
    runs-on: ubuntu-latest
    steps:
      - name: Git clone repository
        uses: actions/checkout@v4
      - name: Run actionlint
        uses: reviewdog/action-actionlint@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-check

  golangci-lint:
    name: golangci-lint
    needs: prep-review
    if: needs.prep-review.outputs.golangci-lint == 'true'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Run golangci-lint
        uses: reviewdog/action-golangci-lint@v2
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-check
          golangci_lint_flags: '--timeout=10m'

  hadolint:
    name: hadolint
    needs: prep-review
    if: needs.prep-review.outputs.hadolint == 'true'
    runs-on: ubuntu-latest
    steps:
      - name: Git clone repository
        uses: actions/checkout@v4
      - name: Run hadolint
        uses: reviewdog/action-hadolint@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-check

  shellcheck:
    name: shellcheck
    needs: prep-review
    if: needs.prep-review.outputs.shellcheck == 'true'
    runs-on: ubuntu-latest
    steps:
      - name: Git clone repository
        uses: actions/checkout@v4
      - name: Run shellcheck
        uses: reviewdog/action-shellcheck@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-check
          path: "."
          pattern: "*.sh*"
          exclude: "./.git/*"

  yamllint:
    name: yamllint
    needs: prep-review
    if: needs.prep-review.outputs.yamllint == 'true'
    runs-on: ubuntu-latest
    steps:
      - name: Git clone repository
        uses: actions/checkout@v4
      - name: Run yamllint
        uses: reviewdog/action-yamllint@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-check