CI/CD: Automatic deployment for TYPO3 Projects

Code Quality Checks

• PHP Linting (for example, php -l)
• Code style tests and fixing
• Static Analysis (for example PHPstan or Psalm)
• Linting of other used formats like TypoScript, XML, and YAML.

Unit and Functional Testing

• Unit tests
• Functional tests
• Acceptance tests

Building Artifacts

• Installing required extensions and other PHP packages via Composer
• Compile frontend assets (e.g., SCSS, JavaScript) using tools like Webpack, Gulp or Vite.

Deployment

• File Synchronization: Deploy code and assets using tools like Rsync, Deployer, or Git-based workflows.
• Database Migrations: Run database migrations using TYPO3’s vendor/bin/typo3 extension:setup or vendor/bin/typo3 database:updateschema if helhum/typo3-console is installed.
• Cache Clearing: Clear TYPO3 caches (vendor/bin/typo3 cache:flush).

Environment configuration

Manage environment-specific settings using .env / dotenv files or Plain PHP configuration files.

Typical CI/CD Tools Used

CI/CD Platforms

GitHub Actions, GitLab CI, Jenkins, or CircleCI

Code Quality

PHP-CS-Fixer, PHPstan, and TypoScript-Lint

Testing

PHPUnit with the TYPO3 Testing Framework

Build Tools

Docker or Podman, Composer, Webpack, Gulp, or Vite

Deployment Tools

Deployer, Rsync, Helm, Ansible, GitOps

Using GitLab CI

The t3start:gitlab-template provides a predefined .gitlab-ci.yml and a Deployer recipe that you can customize to your needs.

Even if you already set up your project you can find valuable examples there.

Using GitHub Actions

In the following code-block you find a very simplified example of what a deployment workflow with GitHub Actions might look like.

For a more life like example see the .github-ci.yml of Stefan Frömken's TYPO3 Lexicon.

name: TYPO3 CI/CD Pipeline

on:
  push:
    branches: [ "main" ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Set up PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.3'

      - name: Install Dependencies
        run: composer install --prefer-dist

      - name: Lint PHP
        run: find . -name "*.php" -exec php -l {} \;

      - name: Run PHPStan
        run: vendor/bin/phpstan analyse

      - name: Run PHPUnit Tests
        run: vendor/bin/phpunit

      - name: Deploy (Example)
        run: |
          ssh user@server 'cd /var/www/html && git pull && composer install \
          --no-dev && ./vendor/bin/typo3 cache:flush'