GithubAction for PHPStan

Usage

You can use it as a Github Action like this:

# .github/workflows/test.yml 

on:
  push:
    branches:
      - master
  pull_request:

name: Test

jobs:
  phpstan:
    name: PHPStan

    runs-on: ubuntu-latest

    steps:
    - name: "Checkout"
      uses: actions/checkout@v2

    - name: PHPStan
      uses: docker://oskarstark/phpstan-ga
      with:
        args: analyse src/

to use a specific level:

      uses: docker://oskarstark/phpstan-ga
      with:
-        args: analyse src/
+        args: analyse src/ --level=5

to install dev dependencies:

      uses: docker://oskarstark/phpstan-ga
+     env:
+       REQUIRE_DEV: true
      with:
        args: analyse src/

to skip checking the platform requirements:

      uses: docker://oskarstark/phpstan-ga
+     env:
+        CHECK_PLATFORM_REQUIREMENTS: false
      with:
        args: analyse src/

to use a phpstan.neon.dist configuration file, just drop the phpstan.neon.dist in your repository root and it will be taken into account.

You can copy/paste the .github folder (under examples/) to your project and thats all!

Docker

A Docker-Image is built automatically and located here: https://hub.docker.com/r/oskarstark/phpstan-ga

You can run it in any given directory like this:

docker run --rm -it -w=/app -v ${PWD}:/app oskarstark/phpstan-ga:latest analyse src/ --level=5

Build instructions for M1 Macs

We need to build it a bit differently as Github Actions doesn't support other architectures than amd64, so crossbuild it is then

docker buildx create --use
docker buildx build --platform linux/amd64 . -t ukkocom/phpstan-ga:latest --push