Add PHPStan Github Action

[rvanlaak]

PHPStan baseline is added to ignore current state. Baseline file should get removed together with #39

[Nyholm]

Thank you

[jakzal]

Is it because of the dom extension missing on the phpqa image?

[rvanlaak]

Probably not. Had this inconsistency on another project as well. Typehinting it as DOMElement instead solves this error.

The object actually isn't a DOMNode. This is because of the return signature on appendChild in PHP core.

[jakzal]

Btw, would be great to document how to use jakzal/phpqa with github actions. I'd appreciate a PR if you have some spare time. Otherwise I'll try to do it in the next couple of weeks.

[rvanlaak]

Will send you a PR once this one is ready 👍

Locally the baseline file gets used. Any idea why it's not used by Github checks?

[jakzal]

Make sure you're testing with the latest image locally. PHPStan was recently updated.

[rvanlaak]

Having problems with getting the tests green. Although using make static passes locally, it fails remotely.

My current assumption is that a working directory volume isn't mounted under /project. Can't get the volume nor analyzing the checked out working directory right.

@odolbeau probably the same applies to #40 as tests are way too fast there. Can you make the cs-fixer output more verbose?

[odolbeau]

@rvanlaak I introduced a "error" on purpose on #40 & it looks like it's working like a charm: https://github.com/php-translation/symfony-storage/pull/40/checks?check_run_id=337944668

[jakzal]

Why do we need to mount the /project? Doesn’t github actions mount the working directory automatically?

Have you tried:

    working-directory: ${{ github.workspace }}

I read somewhere it might not work with uses.

If everything fails we can add a WORKING_DIRECTORY env variable to jakzal/phpqa and change the working path in the entry point.

[Nyholm]

Is this really a hard requirement?

[odolbeau]

@rvanlaak Could we consider using https://github.com/OskarStark/phpstan-ga for this Github action in order to move forward please?
We can obviously keep https://github.com/jakzal/phpqa usage in README. :)

[jakzal]

I just did a quick test on one of my projects. You don't need to mount any directories, github will do it for you.

This is all you need:

name: Static code analysis

on: [pull_request]

jobs:
  phpstan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: Run PHPStan
        uses: docker://jakzal/phpqa:php7.3-alpine
        with:
          args: sh -c 'composer install && phpstan analyze src/ -l 1'

[jakzal]

Actually, I think to make it work jakzal/phpqa needs to be updated to run composer etc.

[jakzal]

I have updated jakzal/phpqa to install composer dependencies if it is run as a github action (jakzal/phpqa#185).

As soon as docker hub builds images all you will need is args: phpstan analyze src/.

[rvanlaak]

Thanks! Then I'll change the action to running phpstan using the minimum required amount of code, and wait until the images are pushed before rerunning the build 👍

[rvanlaak]

@jakzal thanks for letting the image run composer install 👏

@odolbeau @Nyholm PR is ready. Was able to remove lots of baseline items since the BC layer was removed in #39

[odolbeau]

Looks good for me, thanks! :)