Deployer Deploy Action

GitHub Action to deploy applications with PHP Deployer including automatic rollback on failure.

Features

• ✅ Automatic rollback on deployment failure
• ✅ SSH key management
• ✅ rsync support
• ✅ Configurable Deployer version
• ✅ Custom deployment options

Usage

- uses: zeroseven/action-deployer@v1
  with:
    environment: 'production'
    ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}

Inputs

Input	Description	Required	Default
php-version	PHP version	No	8.3
environment	Environment/branch name	Yes	-
ssh-key	SSH private key	Yes	-
auto-rollback	Auto rollback on failure	No	true
deployer-version	Deployer version	No	7
deployer-config	Path to deploy.php	No	deploy.php
options	Additional Deployer options	No	``

Examples

Basic Deployment

steps:
  - uses: actions/checkout@v4
  - uses: zeroseven/action-php-build@v1
  - uses: zeroseven/action-deployer@v1
    with:
      environment: 'production'
      ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}

Deployment Without Auto-Rollback

steps:
  - uses: actions/checkout@v4
  - uses: zeroseven/action-php-build@v1
  - uses: zeroseven/action-deployer@v1
    with:
      environment: 'staging'
      ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
      auto-rollback: 'false'

With Custom Options

steps:
  - uses: actions/checkout@v4
  - uses: zeroseven/action-php-build@v1
  - uses: zeroseven/action-deployer@v1
    with:
      environment: 'production'
      ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
      options: '--branch=main --tag=v1.0.0'

Required Files

Your project must include a deploy.php Deployer configuration file. See Deployer documentation for details.

Secrets

Store your SSH private key as a GitHub secret:

1. Go to Settings → Secrets and variables → Actions
2. Create a new secret named SSH_PRIVATE_KEY
3. Paste your SSH private key (including -----BEGIN/END markers)

License

MIT