Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dbfx committed Jan 27, 2020
1 parent 75cb2ca commit 658d41e
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 658d41e

Please sign in to comment.