Step-by-Step Guide: TYPO3 Auto Deployment with Bitbucket CI/CD

- .ddev
- config
  -- sites
    -- default
  -- system
    -- settings.php
    -- additional.php
- packages
  -- your-custom-package
- composer.json
- deploy.php
- bitbucket-pipelines.yml
- phpstan.neon

image: php:8.1

definitions:
  steps:
    - step: &code-analysis
        name: PHPStan
        caches:
          - composer
        script:
          - composer install --ignore-platform-reqs --no-progress --no-interaction
          - if [ -e vendor/bin/phpstan ]; then php -d memory_limit=2G vendor/bin/phpstan analyse; fi

    - step: &build
        name: Composer
        caches:
          - composer
        artifacts:
          - public/**
          - packages/**
          - config/**
          - vendor/**
        script:
          - composer install --ignore-platform-reqs --no-dev --verbose --prefer-dist --no-progress --no-interaction --optimize-autoloader

    - step: &build-frontend
        name: Node.js
        image: node:19.9.0-alpine3.18
        caches:
          - node
        artifacts:
          - public/**
        script:
          - yarn
          - yarn build

    - step: &deploy
        name: Deploy
        caches:
          - composer
        script:
          - composer global require deployer/deployer:^6.3 deployer/recipes --dev --no-progress --no-interaction
          - "`composer global config bin-dir --absolute`/dep --file=./deploy.php deploy -vv --hosts=${TARGET_HOSTS}"

pipelines:
  branches:
    main:
      - parallel:
          steps:
            - step:
                <<: *code-analysis
            - step:
                <<: *build
            - step:
                <<: *build-frontend
      - step:
          <<: *deploy
          deployment: Production

<?php declare(strict_types=1);

namespace Deployer;

require 'recipe/common.php';
require 'recipe/rsync.php';

function env(string $name): string|array
{
  $value = getenv($name);
  if ($value === false) {
    throw new \RuntimeException(\sprintf(
      'Environment variable \'%s\' missing.',
      $name,
    ));
  }

  return $value;
}

host('main')
  ->hostname(env('SSH_HOST'))
  ->user(env('SSH_USER'))
  ->set('deploy_path', env('DEPLOY_PATH'))
  ->set('writable_mode', 'chmod')
  ->set('keep_releases', '3');

// Prepare Directory Structure
$sharedDirectories = [
  'public/fileadmin',
  //'public/typo3temp',
  //'var',
];
set('shared_dirs', $sharedDirectories);

$sharedFiles = [
  '.env',
  'public/.htaccess',
];
set('shared_files', $sharedFiles);

$writeableDirectories = [
  'public/fileadmin',
  'public/typo3temp',
  'var',
];
set('writable_dirs', $writeableDirectories);

$exclude = [
  '.ddev',
  'deploy.php',
  'package.json',
  'package-lock.json',
  '.env',
  'var/',
  'public/fileadmin/',
  'public/typo3temp/'
];

// Ready for Rsync
set('rsync', [
    'exclude' => array_merge($sharedDirectories, $sharedFiles, $exclude),
    'exclude-file' => false,
    'include' => [],
    'include-file' => false,
    'filter' => [],
    'filter-file' => false,
    'filter-perdir' => false,
    'flags' => 'avz',
    'options' => ['delete'],
    'timeout' => 300
]);
set('rsync_src', '.');

// Execute TYPO3 CLIs
task('typo3:extension:setup', function() {
    cd('{{release_path}}');
    run('vendor/bin/typo3 extension:setup');
});

task('typo3:database:updateschema', function() {
    cd('{{release_path}}');
    run('vendor/bin/typo3 database:updateschema');
});

task('typo3:cache:flush', function() {
    cd('{{release_path}}');
    run('vendor/bin/typo3 cache:flush');
});

task('typo3:cache:warmup', function() {
  cd('{{release_path}}');
  run('vendor/bin/typo3 cache:warmup');
});

task('typo3:language:update', function() {
    cd('{{release_path}}');
    run('vendor/bin/typo3 language:update');
});

// Let's Deploy Now!
task('deploy', [
    'deploy:prepare',
    'deploy:lock',
    'deploy:release',
    'rsync:warmup',
    'rsync',
    'deploy:shared',
    'deploy:writable',
    'typo3:extension:setup',
    //'typo3:database:updateschema',
    'typo3:language:update',
    'typo3:cache:flush',
    'typo3:cache:warmup',
    'deploy:symlink',
    'deploy:unlock',
    'cleanup',
    'success'
]);

// unlock after failure
after('deploy:failed', 'deploy:unlock');

{
	"name": "typo3/bitbucket-project-template",
	"description" : "TYPO3 CMS Distribution - Bitbucket Project Template",
	"license": "GPL-2.0-or-later",
	"type": "project",
	"config": {
		"allow-plugins": {
			"typo3/class-alias-loader": true,
			"typo3/cms-composer-installers": true,
			"helhum/dotenv-connector": true,
			"phpstan/extension-installer": true
		},
		"platform": {
			"php": "8.2"
		},
		"sort-packages": true
	},
	"prefer-stable": true,
	"minimum-stability": "dev",
	"repositories": {
		"local-packages": {
			"type": "path",
			"url": "packages/*"
		}
	},
	"require": {
		"helhum/dotenv-connector": "^3",
		"typo3/cms-backend": "^12",
		"typo3/cms-belog": "^12",
		"typo3/cms-beuser": "^12",
		"typo3/cms-core": "^12",
		"typo3/cms-dashboard": "^12",
		"typo3/cms-extbase": "^12",
		"typo3/cms-extensionmanager": "^12",
		"typo3/cms-felogin": "^12",
		"typo3/cms-filelist": "^12",
		"typo3/cms-fluid": "^12",
		"typo3/cms-fluid-styled-content": "^12",
		"typo3/cms-form": "^12",
		"typo3/cms-frontend": "^12",
		"typo3/cms-info": "^12",
		"typo3/cms-install": "^12",
		"typo3/cms-lowlevel": "^12",
		"typo3/cms-rte-ckeditor": "^12",
		"typo3/cms-seo": "^12",
		"typo3/cms-setup": "^12",
		"typo3/cms-sys-note": "^12",
		"typo3/cms-t3editor": "^12",
		"typo3/cms-tstemplate": "^12",
		"typo3/cms-viewpage": "^12"
	},
	"require-dev": {
		"friendsofphp/php-cs-fixer": "^3.13.0",
		"helmich/typo3-typoscript-lint": "^3.0.0",
		"php-coveralls/php-coveralls": "^2.5.3",
		"phpunit/phpunit": "^9.5.26",
		"saschaegerer/phpstan-typo3": "^1.8",
		"seld/jsonlint": "^1.9.0",
		"squizlabs/php_codesniffer": "^3.7.1",
		"symfony/yaml": "^5.4 || ^6.1",
		"typo3/cms-fluid-styled-content": "^11.5.4 || ^12.0",
		"typo3/coding-standards": "^0.5.5"
	}
}

TYPO3_TRUSTED_HOSTS=.*.*
TYPO3_CONTEXT=Production
TYPO3_DB_DATABASE=
TYPO3_DB_USERNAME=
TYPO3_DB_PASSWORD=
TYPO3_DB_HOST=
TYPO3_DB_PORT=3306
TYPO3_DB_DRIVER=mysqli

SSH_HOST=
SSH_USER=
DEPLOY_PATH=