mega-linter.yml

---
name: MegaLinter

# Trigger mega-linter at every push. Action will also be visible from
# Pull Requests to main
on: # yamllint disable-line rule:truthy
  push:
    branches: [main]
  pull_request:
    branches: [main]
permissions:
  contents: read
# Comment env block if you do not want to apply fixes
env:
  # Apply linter fixes configuration
  #
  # When active, APPLY_FIXES must also be defined as environment variable
  # (in github/workflows/mega-linter.yml or other CI tool)
  # This is dynamically set based on the presence of the PAT secret.
  # If the PAT secret is not present, the APPLY_FIXES environment variable is set to none.
  # Without a PAT token, commits/PRs will not trigger workflow runs.
  # This is a GitHub Actions limitation to prevent infinite loops.
  APPLY_FIXES: none

  # Decide which event triggers application of fixes in a commit or a PR
  # (pull_request, push, all)
  # APPLY_FIXES_EVENT: pull_request

  # If APPLY_FIXES is used, defines if the fixes are directly committed (commit)
  # or posted in a PR (pull_request)
  # APPLY_FIXES_MODE: commit

  # Show individual linter status in GitHub Actions status summary
  GITHUB_STATUS_REPORTER: false

  # Enable to show lint results in GitHub PR comments.
  GITHUB_COMMENT_REPORTER: true

  # Set to simple to avoid external images in generated markdown
  REPORTERS_MARKDOWN_TYPE: simple
concurrency:
  group: ${{ github.head_ref || github.ref }}-${{ github.workflow }}
  cancel-in-progress: true
jobs:
  lint:
    name: MegaLinter
    runs-on: ubuntu-latest

    # Give the default GITHUB_TOKEN write permission to commit and push, comment
    # issues, and post new Pull Requests; remove the ones you do not need
    permissions:
      contents: read
      issues: read
      pull-requests: read
      statuses: read
    steps:
      # Git Checkout
      - name: Checkout code
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # V4.3.1
        with:
          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
          persist-credentials: false

          # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to
          # improve performance
          fetch-depth: 0

      # - name: Check PAT and Set APPLY_FIXES
      #   run: |
      #     if [ -z "${{ secrets.PAT }}" ]; then
      #       echo "APPLY_FIXES=none" >> "$GITHUB_ENV"
      #     fi

      # MegaLinter
      - name: MegaLinter

        # You can override MegaLinter flavor used to have faster performances
        # More info at https://megalinter.io/latest/flavors/
        uses: oxsecurity/megalinter@0e3ce9b9c8c10effb9b269509cc47ca17cae31c7 # V9.5.0
        id: ml

        # All available variables are described in documentation
        # https://megalinter.io/latest/config-file/
        env:
          # Validates all source when push on main, else just the git diff with
          # main. Override with true if you always want to lint all sources
          #
          # To validate the entire codebase, set to:
          # VALIDATE_ALL_CODEBASE: true
          #
          # To validate only diff with main, set to:
          # VALIDATE_ALL_CODEBASE: >-
          #   ${{
          #     github.event_name == 'push' &&
          #     github.ref == 'refs/heads/main'
          #   }}
          VALIDATE_ALL_CODEBASE: true
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

          # ADD YOUR CUSTOM ENV VARIABLES HERE TO OVERRIDE VALUES OF
          # .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY

      # Upload MegaLinter artifacts
      - name: Archive production artifacts
        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # V4.6.2
        if: success() || failure()
        with:
          name: MegaLinter reports
          path: |
            megalinter-reports
            mega-linter.log

      # Create pull request if applicable
      # (for now works only on PR from same repository, not from forks)
      # - name: Create Pull Request with applied fixes
      #   uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f
      #   id: cpr
      #   if: >-
      #     steps.ml.outputs.has_updated_sources == 1 &&
      #     (
      #       env.APPLY_FIXES_EVENT == 'all' ||
      #       env.APPLY_FIXES_EVENT == github.event_name
      #     ) &&
      #     env.APPLY_FIXES_MODE == 'pull_request' &&
      #     (
      #       github.event_name == 'push' ||
      #       github.event.pull_request.head.repo.full_name == github.repository
      #     ) &&
      #     !contains(github.event.head_commit.message, 'skip fix')
      #   with:
      #     token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
      #     commit-message: '[MegaLinter] Apply linters automatic fixes'
      #     title: '[MegaLinter] Apply linters automatic fixes'
      #     labels: bot

      # - name: Create PR output
      #   if: >-
      #     steps.ml.outputs.has_updated_sources == 1 &&
      #     (
      #       env.APPLY_FIXES_EVENT == 'all' ||
      #       env.APPLY_FIXES_EVENT == github.event_name
      #     ) &&
      #     env.APPLY_FIXES_MODE == 'pull_request' &&
      #     (
      #       github.event_name == 'push' ||
      #       github.event.pull_request.head.repo.full_name == github.repository
      #     ) &&
      #     !contains(github.event.head_commit.message, 'skip fix')
      #   run: |
      #     echo "PR Number - ${{ steps.cpr.outputs.pull-request-number }}"
      #     echo "PR URL - ${{ steps.cpr.outputs.pull-request-url }}"

      #  # Push new commit if applicable
      #  # (for now works only on PR from same repository, not from forks)
      # - name: Prepare commit
      #   if: >-
      #     steps.ml.outputs.has_updated_sources == 1 &&
      #     (
      #       env.APPLY_FIXES_EVENT == 'all' ||
      #       env.APPLY_FIXES_EVENT == github.event_name
      #     ) &&
      #     env.APPLY_FIXES_MODE == 'commit' &&
      #     github.ref != 'refs/heads/main' &&
      #     (
      #       github.event_name == 'push' ||
      #       github.event.pull_request.head.repo.full_name == github.repository
      #     ) &&
      #     !contains(github.event.head_commit.message, 'skip fix')
      #   run: sudo chown -Rc $UID .git/

      # - name: Commit and push applied linter fixes
      #   uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842
      #   if: >-
      #     steps.ml.outputs.has_updated_sources == 1 &&
      #     (
      #       env.APPLY_FIXES_EVENT == 'all' ||
      #       env.APPLY_FIXES_EVENT == github.event_name
      #     ) &&
      #     env.APPLY_FIXES_MODE == 'commit' &&
      #     github.ref != 'refs/heads/main' &&
      #     (
      #       github.event_name == 'push' ||
      #       github.event.pull_request.head.repo.full_name == github.repository
      #     ) &&
      #     !contains(github.event.head_commit.message, 'skip fix')
      #   with:
      #     branch: >-
      #       ${{
      #         github.event.pull_request.head.ref ||
      #         github.head_ref ||
      #         github.ref
      #       }}
      #     commit_message: '[MegaLinter] Apply linters fixes'