librenms/.github/workflows/lint.yml at master · murrant/librenms · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
name: Lint
on:
  push:
  pull_request:
    branches: [master, main]

permissions:
  contents: read # to fetch code (actions/checkout)

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  super-linter:
    permissions:
      contents: read # to fetch code (actions/checkout)
      checks: write # to mark the status of each individual linter run

    name: Lint Code Base
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v6
        with:
          fetch-depth: 0
          sparse-checkout-cone-mode: false
          sparse-checkout: |
            /*
            !/tests/data/
            !/tests/snmpsim/
            !/mibs/

      - name: Lint Code Base
        uses: docker://ghcr.io/github/super-linter:slim-v4
        env:
          VALIDATE_BASH: true
          # VALIDATE_PHP_BUILTIN: true # temp disable until it supports PHP 8.1
          VALIDATE_PYTHON_PYLINT: true
          VALIDATE_PYTHON_BLACK: true

          VALIDATE_ALL_CODEBASE: false
          DEFAULT_BRANCH: master
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  phpstan:
    name: PHP Static Analysis
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
    steps:
      - name: Checkout Code
        uses: actions/checkout@v6
        with:
          fetch-depth: 2
          sparse-checkout-cone-mode: false
          sparse-checkout: |
            /*
            !/tests/data/
            !/tests/snmpsim/
            !/mibs/
            !/doc/

      - name: Get composer cache directory
        id: composer-cache
        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT

      - name: Cache composer
        uses: actions/cache@v5
        with:
          path: ${{ steps.composer-cache.outputs.dir }}
          key: ${{ runner.os }}-composer-${{ secrets.CACHE_VERSION }}-${{ hashFiles('**/composer.lock') }}
          restore-keys: ${{ runner.os }}-composer-${{ secrets.CACHE_VERSION }}-

      - name: Composer install
        run: composer install --prefer-dist --no-interaction --no-progress --no-scripts --no-autoloader

      - name: Composer dump
        run: composer dump --strict-psr --strict-ambiguous --no-interaction --no-scripts

      - name: Find new PHP files
        if: github.event_name == 'pull_request'
        id: new-php-files
        run: |
          # HEAD is the PR merge commit, HEAD~1 is its first parent (base branch tip)
          NEW_PHP_FILES=$(git diff -z --diff-filter=A --name-only HEAD~1 HEAD -- 'app/**.php' 'bootstrap/**.php' 'config/**.php' 'database/**.php' 'LibreNMS/**.php' 'resources/**.php' 'routes/**.php' 'tests/**.php' | xargs -0)
          echo "Discovered new PHP files: $NEW_PHP_FILES"
          echo "files=$NEW_PHP_FILES" >> "$GITHUB_OUTPUT"

      - name: Run PHPStan (New files, level 6)
        if: github.event_name == 'pull_request' && steps.new-php-files.outputs.files != ''
        env:
          NEW_PHP_FILES: ${{ steps.new-php-files.outputs.files }}
        run: ./vendor/bin/phpstan analyze --no-interaction --memory-limit=4G --level=6 -- $NEW_PHP_FILES

      - name: Run PHPStan
        run: ./vendor/bin/phpstan analyze --no-interaction --memory-limit=4G

      - name: Run PHPStan (Legacy codebase)
        run: ./vendor/bin/phpstan analyze --no-interaction --memory-limit=4G --configuration=phpstan-legacy.neon

      - name: Run PHPStan (Deprecated functions)
        run: ./vendor/bin/phpstan analyze --no-interaction --memory-limit=4G --configuration=phpstan-deprecated.neon

  rector:
    name: Rector (dry-run)
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v6
        with:
          sparse-checkout-cone-mode: false
          sparse-checkout: |
            /*
            !/tests/data/
            !/tests/snmpsim/
            !/mibs/
            !/doc/

      - name: Get composer cache directory
        id: composer-cache
        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT

      - name: Cache composer
        uses: actions/cache@v5
        with:
          path: ${{ steps.composer-cache.outputs.dir }}
          key: ${{ runner.os }}-composer-${{ secrets.CACHE_VERSION }}-${{ hashFiles('**/composer.lock') }}
          restore-keys: ${{ runner.os }}-composer-${{ secrets.CACHE_VERSION }}-

      - name: Composer install
        run: composer install --prefer-dist --no-interaction --no-progress --no-scripts --no-autoloader

      - name: Composer dump
        run: composer dump --strict-psr --strict-ambiguous --no-interaction --no-scripts

      - name: Run Rector (dry-run)
        run: ./vendor/bin/rector process --dry-run --no-progress-bar --ansi --memory-limit=2G