Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/devgine/composer-php

Docker image based on official alpine image, PHP-fpm and composer. This image will help you to build and test your PHP projects with different PHP version. It contains a necessary tools you need to analyse and test your PHP project (xdebug, phpunit, phpstan, psalm, phpcs, php-cs-fixer, phpmd, phpcpd and rector).
https://github.com/devgine/composer-php

composer docker php phpcpd phpcsfixer phpmd phpstan phpunit rector xdebug

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/devgine/composer-php
Owner: devgine
License: mit
Created: 2023-05-24T21:39:54.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-12-10T20:35:28.000Z (28 days ago)
Last Synced: 2024-12-10T21:32:10.125Z (28 days ago)
Topics: composer, docker, php, phpcpd, phpcsfixer, phpmd, phpstan, phpunit, rector, xdebug
Language: Dockerfile
Homepage:
Size: 428 KB
Stars: 6
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Composer PHP docker image
[![Build](https://github.com/devgine/composer-php/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/devgine/composer-php/actions/workflows/build.yaml)
[![License](https://img.shields.io/github/license/devgine/composer-php)](https://github.com/devgine/composer-php/blob/main/LICENSE)
![GitHub top language](https://img.shields.io/github/languages/top/devgine/composer-php)
[![Packages retention policy](https://github.com/devgine/composer-php/actions/workflows/packages-retention-policy.yaml/badge.svg?branch=main)](https://github.com/devgine/composer-php/actions/workflows/packages-retention-policy.yaml)

![cover.png](.readme/images/cover.png)

## About
This repository is a docker image based on official php, composer and alpine docker images to help you to build and test your PHP projects with different PHP version.

This docker image contains a necessary tools you need to analyze and test your PHP project
* xdebug
* phpunit
* rector
* phpstan
* psalm
* phpcs
* php-cs-fixer
* phpmd
* phpcpd (available from php 7.3 version)

Below is the list of docker images available by PHP versions:

| PHP version | Docker image tags |
|-------------|------------------------------------------------------------------------------------------|
| PHP 8.4 | `ghcr.io/devgine/composer-php:latest`
`ghcr.io/devgine/composer-php:v2-php8.4-alpine` |
| PHP 8.3 | `ghcr.io/devgine/composer-php:v2-php8.3-alpine` |
| PHP 8.2 | `ghcr.io/devgine/composer-php:v2-php8.2-alpine` |
| PHP 8.1 | `ghcr.io/devgine/composer-php:v2-php8.1-alpine` |
| PHP 8.0 | `ghcr.io/devgine/composer-php:v2-php8.0-alpine` |
| PHP 7.4 | `ghcr.io/devgine/composer-php:v2-php7.4-alpine` |
| PHP 7.3 | `ghcr.io/devgine/composer-php:v2-php7.3-alpine` |
| PHP 7.2 | `ghcr.io/devgine/composer-php:v2-php7.2-alpine` |

## Usage
### Install from the command line
```shell
docker run -ti -v LOCAL_PROJECT_DIR:/var/www/composer ghcr.io/devgine/composer-php:latest sh
```
[All versions](https://github.com/devgine/composer-php/pkgs/container/composer-php/versions)
### Use as base image in Dockerfile
```dockerfile
FROM ghcr.io/devgine/composer-php:latest

# Add your custom instructions here
# example: install bash
RUN apk add --no-cache bash

# example: expose 8080 port
EXPOSE 8080
#...
```

### Use components
Inside the container, you can run any tool you need from any working directory.

Global vendor binaries are added to the PATH environment.

#### Composer
```shell
composer --help
```
#### PHP Unit
```shell
simple-phpunit --help
```
#### Rector
```shell
rector --help
```
#### PHPStan
```shell
phpstan --help
```
#### Psalm
```shell
psalm --help
```
#### PHP Code sniffer
```shell
phpcs --help
```
#### PHP Coding Standards Fixer
```shell
php-cs-fixer --help
```
#### PHP Mess Detector
```shell
phpmd --help
```
#### PHP Copy Past Detector
```shell
phpcpd --help
```

## Use image in continuous integration
### GitHub action
```yaml
name: 'Workflow name'
on:
push
jobs:
job-id:
runs-on: ubuntu-latest
...
container:
image: ghcr.io/devgine/composer-php:latest
steps:
- name: 'Run Tests'
run: simple-phpunit --coverage-text
...
```

An example with matrix strategy
```yaml
name: 'Matrix strategy'
on:
push
jobs:
job-id:
runs-on: ubuntu-latest
...
strategy:
fail-fast: false
matrix:
tag: ['v2-php8.3-alpine', 'v2-php8.2-alpine', 'v2-php8.1-alpine', 'v2-php8.0-alpine', 'v2-php7.4-alpine']
container:
image: ghcr.io/devgine/composer-php:${{ matrix.tag }}
steps:
- name: 'Run Tests'
run: simple-phpunit --coverage-text
...
```

### Gitlab CI
```yaml
tests:
image: ghcr.io/devgine/composer-php:latest
...
script:
- simple-phpunit --coverage-text
```

An example with matrix strategy
```yaml
tests:
parallel:
matrix:
TAG: ['v2-php8.3-alpine', 'v2-php8.2-alpine', 'v2-php8.1-alpine', 'v2-php8.0-alpine', 'v2-php7.4-alpine']
image: ghcr.io/devgine/composer-php:${TAG}
...
script:
- simple-phpunit --coverage-text
```

## References
* [PHP Unit supported versions](https://phpunit.de/supported-versions.html)
* [Xdebug compatibility](https://xdebug.org/docs/compat)
* [PHP Unit](https://symfony.com/doc/current/components/phpunit_bridge.html)
* [Rector](https://packagist.org/packages/rector/rector)
* [PHPStan](https://phpstan.org/)
* [Psalm](https://psalm.dev/docs/)
* [PHP CS](https://github.com/squizlabs/PHP_CodeSniffer/wiki)
* [PHP Coding Standards Fixer](https://cs.symfony.com/)
* [PHP Mess Detector](https://phpmd.org/)
* [PHP Copy Past detector](https://github.com/sebastianbergmann/phpcpd)