DX: Add Docker dev setup #5234
DX: Add Docker dev setup #5234
Conversation
|
I would somehow explicitly notice whether this is a PHP CS Fixer docker image, to be used by folks willing to run the fixer, or dev-purpose image to use internally for development of this repo itself? |
|
These images are intended for internal usage (dev and tests). I'll add information in |
| xdebug.remote_autostart=1 | ||
| xdebug.remote_enable=1 | ||
| xdebug.remote_host=host.docker.internal | ||
| xdebug.remote_port=9003 |
There was a problem hiding this comment.
Images that use Xdebug 2 (PHP < 7.3) use the port 9003 instead of the default 9000 because on Xdebug 3 the default port has been changed to 9003. This removes the need to change the port to listen in e.g. PhpStorm everytime you switch between versions of PHP.
There was a problem hiding this comment.
maybe we don't need xdebug for 5.6, which we gonna drop soon ?
There was a problem hiding this comment.
It's exactly the same config than for PHP 7.0, 7.1 and 7.2, so PHP 5.6 does not specifically make the whole setup more complicated.
| && php composer-setup.php --install-dir=/usr/local/bin --filename=composer \ | ||
| && rm composer-setup.php \ | ||
| # xdebug command | ||
| && curl --location --output /usr/local/bin/xdebug https://github.com/julienfalque/xdebug/releases/download/v1.1.0/xdebug \ |
There was a problem hiding this comment.
on first look, i thought it's simply fork of the xdebug itself.
maybe consider renaming the cli file?
There was a problem hiding this comment.
You mean in the upstream repository or here in the Dockerfile?
There was a problem hiding this comment.
i would dare to suggest both :D xdebug is already a name in ecosystem, reusing it can be confusing
| @@ -0,0 +1,29 @@ | |||
| version: '3.8' | |||
There was a problem hiding this comment.
i am not sure about best practice here. can we somehow differentiate that this is a docker image only to be used inside php-cs-fixer itself, and not the docker image for ppl willing to run PHP CS Fixer?
maybe we can extract it to separated package, like https://github.com/PHP-CS-Fixer/php-docker-toolkit (whatever name) ? would that work for us , or it would not let us run it from PHP-CS-Fixer path?
like, i can imagine reusing same docker-compose for any PHP tool development
There was a problem hiding this comment.
I don't think docker-compose.yaml are meant to be shared between different projects. I'd say we can safely assume this will be considered as the setup to work on the project itself, not to use it elsewhere.
| You can then build the images: | ||
|
|
||
| ```console | ||
| $ docker-compose build --parallel |
There was a problem hiding this comment.
ker@dus:~/github/PHP-CS-Fixer λ docker-compose build
ERROR: Version in "./docker-compose.yaml" is unsupported. You might be seeing this error because you're using the wrong Compose file version. Either specify a supported version (e.g "2.2" or "3.3") and place your service definitions under the `services` key, or omit the `version` key and place your service definitions at the root of the file to use version 1.
For more on the Compose file format versions, see https://docs.docker.com/compose/compose-file/
ker@dus:~/github/PHP-CS-Fixer λ docker-compose --version
docker-compose version 1.25.0, build unknown
ker@dus:~/github/PHP-CS-Fixer λ docker --version
Docker version 19.03.8, build afacb8b7f0
what am I doing wrong?
There was a problem hiding this comment.
Your Docker Compose version (1.25.0) is too old to support version 3.8 of the Compose file format (supported since 1.25.5). But I don't think features specific to this version are used here so we can probably use a lower one.
There was a problem hiding this comment.
interesting, sudo apt-get docker-compose on ubuntu brings only 1.25.0 and does not want to offer anything newer.
(yes, i know, i can download the binaries manually...)
|
|
||
| Make sure the versions installed support [Compose file format 3.8](https://docs.docker.com/compose/compose-file/). | ||
|
|
||
| Next, copy [`docker-compose.override.yaml.dist`](./docker-compose.override.yaml.dist) to `docker-compose.override.yaml` |
There was a problem hiding this comment.
question: is this step obligatory?
There was a problem hiding this comment.
Currently yes: the images require the DOCKER_USER_ID and DOCKER_GROUP_ID arguments to create a guest user that matches the host user to avoid file permission issues. If there's a better alternative, I'd be happy to update.
|
Thank you @julienfalque. |
No description provided.