Deploy to Pantheon

Uses action-deploy-to-remote-repository and Pantheon terminus to deploy files/folders from a local GitHub action repository to a Pantheon environment.

Notes:

• This action depends upon the upstream action action-deploy-to-remote-repository and it's associated requirements (eg. ssh-key.
• This action assumes that production branches are deployed to Pantheon dev environment (via a git commit to Pantheon's master branch), and all other branch names are deployed to a Pantheon multisite branch environment of the same name (unless overridden with pantheon_env_name).
• If autopromote is set, the action will use terminus env:deploy to advance from dev -> test -> live Pantheon environments.
• There are special considerations for the .pantheon folder.

Usage

Example deploy to a remote repository:

name: Deploy to Pantheon Live

on:
  push:
    branches:
      - production

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v3

    # Build your project here
    # ...

    - name: Deploy to Pantheon
      uses: alleyinteractive/action-deploy-to-pantheon@v1
      with:
        pantheon_site: 'your-site-name'
        pantheon_site_id: '12345678-YOUR-SITE-ID00-123456789123'
        pantheon_machine_token: ${{ secrets.SSH_KEY }}
        ssh_key: ${{ secrets.SSH_KEY }}
        destination_directory: 'wp-content/'
        autopromote: 'true'
        pantheon_env_name: ${{ github.ref_name }}

.pantheon folder

If a .pantheon/pantheon.yml file or .pantheon/private folder are present, this action will copy them to the root of the repository (as pantheon.yml or ./private respectively). This is useful for projects that are rooted at wp-content but still want to version control their Pantheon configuration or private files.

Inputs

Specify using with keyword. See all upstream inputs for action-deploy-to-remote-repository.

base_directory

• Specify the base directory to sync from.
• Accepts a string.
• Defaults to the root of the repository (.). NOTE You likely want a trailing slash if you're syncing a subdirectory. (eg. wp-content/)
• Inherited from action-deploy-to-remote-repository.

destination_directory

• Specify the destination directory to sync to.
• Accepts a string.
• Defaults to the root of the remote repository (.).
• Inherited from action-deploy-to-remote-repository.

exclude_list

• Specify a comma-separated list of files and directories to exclude from sync.
• Accepts a string. (e.g. .git, .gitmodules)
• Defaults to .git, .gitmodules, .pantheon.
• Inherited from action-deploy-to-remote-repository.

ssh-key

• SSH key to use for remote repository authentication.
• Accepts a string (private key).
• Required.
• Inherited from action-deploy-to-remote-repository.

pantheon_site

• Specify the name of the Pantheon site to deploy to.
• Accepts a string.
• Required.

pantheon_site_id

• Specify the ID of the Pantheon site to deploy to.
• Accepts a string.
• Required.

pantheon_machine_token

• Specify the Pantheon machine token to use.
• Accepts a string.
• Required.

terminus_version

• Specify the version of terminus to use.
• Accepts a string.
• Defaults to '3.2.1'.

pantheon_env_name

• Specify the Pantheon environment name to deploy to.
• Accepts a string.
• Required.

autopromote

• Specify whether to autopromote the deployment to test and live Pantheon environments.
• Accepts a string. (e.g. true or false)
• Defaults to false.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

This project is actively maintained by Alley Interactive.

• Ben Bolton
• All Contributors

License

The GNU General Public License (GPL) license. Please see License File for more information.