From 658d41e8c2cd40788bdcf0052204600a3aa47a71 Mon Sep 17 00:00:00 2001 From: Dave Blakey Date: Mon, 27 Jan 2020 14:46:44 +0200 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2b3972e..6607076 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ -# GitHub Action for PHP syntax check +# PHP Lint GitHub Action -This actions runs `php -l` on all PHP files found in the current project. It allows you to easily and quickly check for +This Github Action runs `php -l` on all PHP files found in the current project. It allows you to easily and quickly check for any syntax / parse errors in your PHP files on pull requests or pushes. This is especially useful for code that is meant to run on multiple PHP versions. +--- + ## Getting Started -Using this action can be done with this template: +Using this action can be done with the following template: ``` steps: @@ -28,6 +30,8 @@ steps: folder-to-exclude: "! -path \"./vendor/*\" ! -path \"./folder/excluded/*\"" ``` +--- + ## Brand New Setup If you have never used github actions, then create a file called phplint.yml in your Git repository in the directory @@ -67,6 +71,19 @@ In the above example, your workflow will run the PHP syntax check with PHP 5.6, --- +## Supported versions + +Right now there is support for the following PHP versions: + - 5.5 + - 5.6 + - 7.2 + - 7.3 + - 7.4 + + If you would like to add more submit a PR or an issue. + + --- + ## Ignoring paths You can see in the above examples it ignores certain paths. You may add as many as you need by copying the example.