Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 3.99 KB

README.md

File metadata and controls

115 lines (80 loc) · 3.99 KB
Raw

PHP Static Analysis in Github Actions

PHP Static Analysis in Github Actions.

PHPStan finds bugs in your code without writing tests by using runnin static analysis on your project's code.

Usage

Create your Github Workflow configuration in .github/workflows/ci.yml or similar.

name: CI

on: [push]

jobs:
  build-test:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - uses: php-actions/composer@v6 # or alternative dependency management
    - uses: php-actions/phpstan@v3
      with:
        path: src/

    # ... then your own project steps ...

Version numbers

This action is released with semantic version numbers, but also tagged so the latest major release's tag always points to the latest release within the matching major version.

Please feel free to use uses: php-actions/phpstan@v3 to always run the latest version of v3, or uses: php-actions/[email protected] to specify the exact release.

Example

We've put together an extremely simple example application that uses php-actions/phpstan. Check it out here: https://github.com/php-actions/example-phpstan.

Inputs

The following configuration options are available:

  • version The version of PHPStan to use e.g. 9, 9.5.0, latest or composer (default: composer will use the version in your vendor/bin directory)
  • php_version The version of PHP to use e.g. 7.4 (default: latest)
  • php_extensions Space-separated list of extensions using php-build e.g. xdebug mbstring (default: N/A)
  • vendored_phpstan_path The path to a phar file already present on the runner (default: N/A)
  • command The command to run e.g. list or worker (default: analyse)
  • path Path(s) with source code to run analysis on, space-separated (required)
  • configuration Configuration file location
  • level Level of rule options - the higher, the stricter
  • paths_file Path to a file with a list of paths to run analysis on
  • autoload_file Project's additional autoload file path
  • error_format Format in which to print the result of the analysis
  • generate_baseline Path to a file where the baseline should be saved
  • memory_limit Memory limit for analysis
  • args Extra arguments to pass to the phpstan binary

By default, adding - uses: php-actions/phpstan@v2 into your workflow will run phpstan analyse, as analyse is the default command name.

You can issue custom commands by passing a command input, like so:

jobs:
  phpstan:

    ...

    - name: PHPStan
      uses: php-actions/phpstan@v3
      with:
        command: your-command-here

The syntax for passing in a custom input is the following:

...

jobs:
  phpstan:

    ...

    - name: PHPStan Static Analysis
      uses: php-actions/phpstan@v3
      with:
        configuration: custom/path/to/phpstan.neon
        memory_limit: 256M

If you require other configurations of phpstan, please request them in the Github issue tracker

PHP and PHPStan versions

It's possible to run any version of PHPStan under any version of PHP, with any PHP extensions you require. This is configured with the following inputs:

  • version - the version number of PHPStan to run e.g. 1.10.14 (default: composer)
  • php_version - the version number of PHP to use e.g. 8.1 (default: latest)
  • php_extensions - a space-separated list of extensions to install using php-build e.g. xdebug mbstring (default: N/A)

If you require a specific version combination that is not compatible with Github Actions for some reason, please make a request in the Github issue tracker.

If you found this repository helpful, please consider sponsoring the developer.