loading...

Distributing projects compiled into PHAR

ajardin profile image Alexandre Jardin Originally published at ajardin.fr on ・3 min read

We have seen, in a previous article, how it is possible to compile a Symfony project as a PHAR. If this manipulation is quite simple to set up, the distribution must be straightforward to avoid wasting time for the project maintainers.

As a reminder, we need to have two projects in this context: a source project (i.e. readable source code) and a binary project (i.e. PHAR archive). It will therefore be necessary to set up automated processes so that the binary is updated after each commit and after each new release.

I will use the syntax of GitHub Actions to illustrate the rest of the article, but the logic remains the same if you use GitLab, for example.

Initialization

Before going any further, we must initialize the file which will contain the configuration: .github/workflows/continuous-deployment.yml at the root of our project. In this first example, we need to trigger an automated process after each commit on the master branch.

Then, we will start to complete it with: the name of the automated process, the name of the event that triggers it, and the system requirements for its execution.

name: Continuous Deployment

on:
  push:
    branches: ['master']

jobs:
  tests:
    name: Deployment
    runs-on: ubuntu-latest

    steps:
      - name: 'Prepare the build context'
        uses: actions/checkout@v1

      - name: 'Install system requirements'
        run: |
          sudo apt update
          sudo apt install -y libicu-dev
          sudo apt-fast install -y --no-install-recommends \
            php7.4 php7.4-ctype php7.4-intl php7.4-mbstring php7.4-pcov php7.4-sqlite php7.4-xml

Enter fullscreen mode Exit fullscreen mode

Permissions

In addition to the system prerequisites, there are two other things to consider.

  1. The configuration of an SSH key with write access to the binary project.
  2. The Git configuration to keep a clean history and sign automatic commits.

Signing commits is not required. The most important thing is do not enter your private key directly in this file. Instead, use the GitHub secrets.

      - name: 'Load the keys used to deploy the PHAR archive'
        run: |
          mkdir -p ~/.ssh
          echo "$" > ~/.ssh/id_rsa
          chmod 600 ~/.ssh/id_rsa
          echo "$" | gpg --import

      - name: 'Configure the committer identity'
        run: |
          git config --global user.email "name@domain.tld"
          git config --global user.name "Firstname Lastname"
          git config --global commit.gpgsign "true"
          git config --global user.signingkey "XXXXXXXXXXXXXXXX"

Enter fullscreen mode Exit fullscreen mode

Building process

Just before compiling, we have to install the project dependencies. I usually take advantage of this step to check that there is no desynchronization between my composer.json file and my composer.lock file.

This last prerequisite passed, we can execute the compilation of our project.

      - name: 'Install Composer dependencies'
        run: |
          composer validate --strict --ansi
          composer install --optimize-autoloader --classmap-authoritative --ansi

      - name: 'Compile the PHAR archive'
        run: |
          composer dump-env prod
          ./bin/console cache:warmup
          docker run --volume="$(pwd):/app:delegated" ajardin/humbug-box compile --ansi

Enter fullscreen mode Exit fullscreen mode

Deployment process

It’s now time to update the binary project. Here is a procedure that allows keeping an intelligible history.

  1. First, we clone the binary project into a temporary directory.
  2. We copy the previously generated PHAR inside this one.
  3. We index the change, and we include in the commit message a reference to the commit which is at the origin of the automated process.
  4. And finally, we push these changes on the binary project.

By doing this, we will have an almost similar history between the two projects.

      - name: 'Prepare the local Git repository which contains the PHAR archive'
        run: |
          git clone git@github.com:origanization/project.git /tmp/project
          mkdir -p /tmp/project/bin/
          cp ./build/project.phar /tmp/project/bin/project

      - name: 'Update the remote Git repository which contains the PHAR archive'
        run: |
          cd /tmp/project
          git add bin/project
          git commit --message="Update to commit https://github.com/origanization/project-source/commit/$"
          git push origin HEAD:master

Enter fullscreen mode Exit fullscreen mode

Releases management

The release of a new release is almost identical to the deployment of a new commit. Only the event that triggers the process and the final step are different.

name: Release Version

on:
  push:
    tags: ['v*.*.*']

jobs:
  release:
    name: Release
    runs-on: ubuntu-latest

    steps:

      # [...]

      - name: 'Update the remote Git repository which contains the PHAR archive'
        run: |
          tag_name=$(git show "$" --no-patch --format="" | head -n1 | awk '{print $2}')
          tag_message=$(git show "$" --no-patch --format="" | tail -n1)
          cd /tmp/project

          git add bin/project
          git commit --message="Update to version ${tag_name}"
          git push origin HEAD:master

          git tag "${tag_name}" --message="${tag_message}" --force --sign
          git push origin "${tag_name}" --force

Enter fullscreen mode Exit fullscreen mode

Composer

Last but not least, you need to add a composer.json file to the binary project to indicate the location of the PHAR archive. This way, Composer will be able to process it correctly.

{
    "name": "organization/project",
    "...": "...",
    "bin": "bin/xyz"
}

Enter fullscreen mode Exit fullscreen mode

Thanks for reading!

Discussion

pic
Editor guide