static.md

Static site

Deploy a static site.

Recipe

You can copy an example deployment file:

cp vendor/studio24/deployer-recipes/examples/static.php ./deploy.php

Tasks

The static site recipe has 3 new tasks it runs:

deploy:local_build

Checks out code from git to a local temporary folder and builds your website files. This runs a sub-task called local_build to run all the required website build commands.

You can control where the project is checked out from via build_root

local_build

Builds static site. All commands run relative to the build_path.

We recommend you override this in your deploy.php script, e.g.

task('local_build', function() {
    runLocally('composer install');
    runLocally('./vendor/bin/design-system');
});

Sub-processes

Please note build commands run via Symfony Process which runs each command in a sub-process.

Therefore, if you need to run commands that need to pass information to subsequent commands, use && to join multiple commands into one command.

NVM commands

If you want to run NPM commands via NVM, you can use the convenience function nvm($command) to automatically prepend source ~/.nvm/nvm.sh && nvm use && to run NPM commands via the correct version.

task('local_build', function() {
    runLocally(nvm('npm install'));
    runLocally(nvm('npm build'));
});

Real-time output

If you want to see real time output on a build command pass the real_time_output option:

task('local_build', function() {
    runLocally(nvm('npm install'));
    runLocally(nvm('npm build'), options: ['real_time_output' => true]);
});

Please note, in Deployer 8 this is changing to the forceOutput argument:

runLocally('npm build', 'forceOutput' => true);

deploy:rsync

Rsyncs files from local to the remote server.

You need to define which local folder website files are built into via build_folder

You can control which remote folder files are synced to via rsync_folder

Configuration

Required configuration

• build_folder: directory that contains built website files (e.g. _dist)

Optional configuration

• build_root: root directory to store build files (default is ~/.deployer)
• rsync_folder: directory to rsync files to, relative to release_path (default is nothing, so files are rsynched to release_path)