Our pipeline consists of the following steps:
- Dependency check via ComposerRequireChecker
- Lint Pull Request
- Check code style via PHP CS Fixer
- Static Analyse via PHPStan
- Check architecture via Deptrac
- Run tests via PHPUnit
Before submitting a merge request, you can perform all checks by running the make check command.
| Command | Description |
|---|---|
| composer test | Run tests (via PHPUnit) |
| composer lint | Run lint (via PHPCsFixer) |
| composer deptrac | Run deptrac |
| make deps-check | Check composer requires (via ComposerRequireChecker) |
| make check | Run test, lint, stat-analyse, deptrac |
| make docs | Build docs (rule page, Config JSON Schema) |
| make env | Add .env file |
| make try MR_ID=10 | Run MR-Linter on really pull request |
| make try-gitlab MR_ID=10 | Run MR-Linter on really merge request |
| Command | Description |
|---|---|
| ./bin/mr-linter install | Install this tool (copy configuration file to work directory) |
| ./bin/mr-linter install --format=yaml | Install this tool (copy configuration file to work directory) |
| ./bin/mr-linter dump | Print current rules |
| ./bin/mr-linter lint | Run lint to current merge request |
| ./bin/mr-linter info | Print info about MR Linter |