Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/OskarStark/phpstan-ga
GithubAction for PHPStan
https://github.com/OskarStark/phpstan-ga
github-actions php phpstan
Last synced: 3 months ago
JSON representation
GithubAction for PHPStan
- Host: GitHub
- URL: https://github.com/OskarStark/phpstan-ga
- Owner: OskarStark
- Created: 2019-01-03T18:43:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-07T00:48:35.000Z (3 months ago)
- Last Synced: 2024-10-10T08:56:57.949Z (3 months ago)
- Topics: github-actions, php, phpstan
- Language: Dockerfile
- Homepage:
- Size: 169 KB
- Stars: 97
- Watchers: 7
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
- awesome-actions - PHPStan Static code analyzer Action
- fucking-awesome-actions - PHPStan Static code analyzer Action
- awesome-workflows - PHPStan Static code analyzer Action
README
# GithubAction for PHPStan
## Usage
You can use it as a Github Action like this:
```yaml
# .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@v3
- name: PHPStan
uses: docker://oskarstark/phpstan-ga
with:
args: analyse src/
```
_to use a specific level:_
```diff
uses: docker://oskarstark/phpstan-ga
with:
- args: analyse src/
+ args: analyse src/ --level=5
```
_to install dev dependencies:_
```diff
uses: docker://oskarstark/phpstan-ga
+ env:
+ REQUIRE_DEV: true
with:
args: analyse src/
```
_to allow dev dependencies:_
```diff
uses: docker://oskarstark/phpstan-ga
+ env:
+ ALLOW_DEV: true
with:
args: analyse src/
```
_to skip checking the platform requirements:_
```diff
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`