mega-linter.yaml

# Mega-Linter GitHub Action configuration file
# More info at https://nvuillam.github.io/mega-linter
name: Mega-Linter

on:  # yamllint disable-line rule:truthy
  # Trigger mega-linter at every push. Action will also be visible from Pull Requests to master
  push:  # Comment this line to trigger action only on pull-requests (not recommended if you don't pay for GH Actions)
    branches: [master, main, '*.*', 'staging*']
  pull_request:
    branches: [master, main, '*.*', 'staging*']

env:  # Comment env block if you do not want to apply fixes
  # Apply linter fixes configuration
  APPLY_FIXES: none  # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
  APPLY_FIXES_EVENT: pull_request  # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
  APPLY_FIXES_MODE: commit  # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)

permissions:
  checks: write
  pull-requests: write
  statuses: write

jobs:
  # Cancel duplicate jobs: https://github.com/fkirc/skip-duplicate-actions#option-3-cancellation-only
  cancel_duplicates:
    name: Cancel duplicate jobs
    runs-on: ubuntu-latest
    steps:
    - uses: fkirc/skip-duplicate-actions@master
      with:
        github_token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}

  build:
    name: Mega-Linter
    runs-on: ubuntu-latest
    steps:
    # Git Checkout
    - name: Checkout Code
      uses: actions/checkout@v2
      with:
        token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
        fetch-depth: 0

    # Mega-Linter
    - name: Mega-Linter
      id: ml
      # You can override Mega-Linter flavor used to have faster performance
      # More info at https://nvuillam.github.io/mega-linter/flavors/
      uses: nvuillam/mega-linter/flavors/python@v4
      env:
        # All available variables are described in documentation
        # https://nvuillam.github.io/mega-linter/configuration/
        VALIDATE_ALL_CODEBASE: true  # Set ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} to validate only diff with master branch
        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 Mega-Linter artifacts
    - name: Archive production artifacts
      if: ${{ success() }} || ${{ failure() }}
      uses: actions/upload-artifact@v2
      with:
        name: Mega-Linter reports
        path: |
          report
          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
      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')
      uses: peter-evans/create-pull-request@v3
      with:
        token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
        commit-message: '[Mega-Linter] Apply linters automatic fixes'
        title: '[Mega-Linter] 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 "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
        echo "Pull Request 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/master' && (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
      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/master' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
      uses: stefanzweifel/git-auto-commit-action@v4
      with:
        branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
        commit_message: '[Mega-Linter] Apply linters fixes'