build: Add a docker image (#884)

Author: theofidry

.github/workflows/release.yaml

@@ -15,6 +15,10 @@ concurrency:
     group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
     cancel-in-progress: true
 
+env:
+    DOCKERFILE: Dockerfile
+    DOCKERHUB_USERNAME: humbugphp
+
 jobs:
     build-phar:
         runs-on: ubuntu-latest
@@ -71,7 +75,6 @@ jobs:
                        bin/php-scoper.phar
 
             -   name: Upload the PHAR artifact
-                if: github.event_name == 'release'
                 uses: actions/upload-artifact@v3
                 with:
                     name: php-scoper-phar
@@ -94,7 +97,91 @@ jobs:
             -   name: Upload php-scoper.phar
                 uses: softprops/action-gh-release@v1
                 with:
-                    token: ${{ secrets.PHP_SCOPER_GITHUB_TOKEN }}
+                    token: ${{ secrets.GITHUB_TOKEN }}
                     files: |
                         php-scoper.phar
                         php-scoper.phar.asc
+
+    publish-docker-image:
+        runs-on: ubuntu-latest
+        name: Publish the Docker image
+        needs:
+            - build-phar
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v4
+
+            -   uses: actions/download-artifact@v3
+                with:
+                    name: php-scoper-phar
+                    path: .
+
+            # See https://github.com/actions/download-artifact#limitations
+            # the permissions are not guaranteed to be preserved
+            -   name: Ensure PHAR is executable
+                run: |
+                    chmod 755 php-scoper.phar
+                    mv -vf php-scoper.phar bin/php-scoper.phar
+                    ./bin/php-scoper.phar --ansi --version
+
+            -   name: Set up QEMU
+                uses: docker/setup-qemu-action@v3
+
+            -   name: Set up Docker Buildx
+                uses: docker/setup-buildx-action@v3
+
+            -   name: Login to Docker Container Registry
+                if: github.event_name == 'release'
+                uses: docker/login-action@v3
+                with:
+                    username: ${{ env.DOCKERHUB_USERNAME }}
+                    password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+            -   name: Setup the Docker (release) tag(s)
+                if: github.event_name == 'release'
+                # Selects a random value for $EOF as a delimiter, and sets the DOCKER_TAGS environment variable
+                # as a multi-line environment variable.
+                run: |
+                    EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
+
+                    echo "DOCKER_TAGS<<$EOF" >> $GITHUB_ENV
+                    echo "${{ env.DOCKERHUB_USERNAME }}/php-scoper:${{ github.ref_name }}" >> $GITHUB_ENV
+                    echo "${{ env.DOCKERHUB_USERNAME }}/php-scoper:latest" >> $GITHUB_ENV
+                    echo "$EOF" >> $GITHUB_ENV
+                    echo "DOCKER_TEST_TAG=${{ env.DOCKERHUB_USERNAME }}/php-scoper:latest" >> $GITHUB_ENV
+
+            -   name: Login to GitHub Container Registry
+                if: github.event_name != 'release'
+                uses: docker/login-action@v2
+                with:
+                    registry: ghcr.io
+                    username: ${{ github.actor }}
+                    password: ${{ secrets.GITHUB_TOKEN }}
+
+            -   name: Setup the Docker tag(s)
+                if: github.event_name != 'release'
+                run: |
+                    echo "DOCKER_TAGS=ghcr.io/humbugphp/php-scoper" >> $GITHUB_ENV
+                    echo "DOCKER_TEST_TAG=ghcr.io/humbugphp/php-scoper" >> $GITHUB_ENV
+
+            -   name: Build and export to Docker
+                uses: docker/build-push-action@v3
+                with:
+                    context: .
+                    file: ${{ env.DOCKERFILE }}
+                    platforms: linux/amd64
+                    tags: ${{ env.DOCKER_TAGS }}
+                    load: true
+
+            -   name: Test the (release) image
+                run: docker run --rm ${{ env.DOCKER_TEST_TAG }} --version
+
+            -   name: Build and push
+                if: github.event_name == 'release'
+                uses: docker/build-push-action@v3
+                with:
+                    context: .
+                    file: ${{ env.DOCKERFILE }}
+                    platforms: linux/amd64
+                    tags: ${{ env.DOCKER_TAGS }}
+                    push: true

Dockerfile

@@ -0,0 +1,8 @@
+FROM php:8.1-cli-alpine
+
+COPY --from=mlocati/php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/
+RUN install-php-extensions zlib phar sodium tokenizer filter
+
+COPY bin/php-scoper.phar /php-scoper.phar
+
+ENTRYPOINT ["/php-scoper.phar"]

README.md

@@ -31,6 +31,7 @@ potentially very difficult to debug due to dissimilar or unsupported package ver
 - [Installation](docs/installation.md#installation)
     - [Phive](docs/installation.md#phive)
     - [Composer](docs/installation.md#composer)
+    - [Docker](docs/installation.md#docker)
     - [GitHub](docs/installation.md#github)
 - [Usage](#usage)
 - [Configuration](docs/configuration.md#configuration)

docs/installation.md

@@ -45,6 +45,16 @@ $ composer bin php-scoper require --dev humbug/php-scoper
 $ vendor/bin/php-scoper
 ```
 
+
+## Docker
+
+The official docker image for the project is [`humbugphp/php-scoper`][docker-image]:
+
+```shell
+docker pull humbugphp/php-scoper
+```
+
+
 ## GitHub
 
 You may download the Box PHAR directly from the [GitHub release][releases] directly.
@@ -74,6 +84,7 @@ chmod +x php-scoper.phar
 
 
 [composer]: https://getcomposer.org
+[docker-image]: https://hub.docker.com/r/humbugphp/php-scoper
 [bamarni/composer-bin-plugin]: https://github.com/bamarni/composer-bin-plugin
 [phive]: https://github.com/phar-io/phive
 [releases]: https://github.com/humbug/php-scoper/releases