pantheon-systems/Push to Pantheon

A GitHub Action that deploys code to Pantheon Dev and Multidev environments

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
ssh_keyA private key that corresponds to a public key on Pantheon: https://docs.pantheon.io/ssh-keysyes
machine_tokenA token for authenticating with Pantheon's command line: https://docs.pantheon.io/machine-tokensyes
siteThe machine name of your Pantheon site.yes
target_envThe Pantheon environment to which the deployment will be made. If left blank, the value used will be automatically derived. Pull requests will deploy to environments named "pr-[NUMBER]" and main/master branch commits will deploy to the Pantheon "dev" environmentno""
source_envThe environment from which the database and uploaded files will be copied.nolive
clone_contentIf set to true, the database and files directory will be re-cloned from the source environment. When set to false, this data is only copied upon Multidev creations. Setting this variable to true ensures fresh content but adds time to the build process that can be prohibitive for sites with large databases.nofalse
delete_old_environmentsIf set to true, Multidev environments associated with closed pull requests will be deleted after deployment completes. It is recommended to set this parameter to true for workflows that run after merges to the main branch.nofalse
git_user_nameThe name to be used with the Git commit that will be pushed to Pantheon. This value is not used on newer 'eVCS' sites for which there is no Pantheon-provided Git repo.noPantheon Automation
git_user_emailThe email address to be used with the Git commit that will be pushed to Pantheon. This value is not used on newer 'eVCS' sites for which there is no Pantheon-provided Git repo.nobot@getpantheon.com
git_commit_messageA custom commit message to be used with the Git commit that will be pushed to Pantheon. Leaving this Action parameter blank will result in a generic commit message being used. This value is not used on newer 'eVCS' sites for which there is no Pantheon-provided Git repo.no""
relative_site_rootThe root directory of the site to be deployed relative to the repository root. The vast majority of users of this action should leave this value unchanged from the default. The action will use this value to change directories after checking out the repo.no""
skip_terminus_installIf set to true, the action will skip the installation of Terminus. This is useful if you are using a custom Docker image that already has Terminus installed or you are installing it earlier in the workflow. By default, the action will check for the presence of Terminus and install it if it is not found, but if this is set to true, the action will bypass the check and skip the Terminus install.nofalse
build_tools_versionThe version of the Terminus Build Tools plugin to install. By default, the action will install the latest stable version. You can specify a specific version or branch if needed.no""
skip_build_toolsIf set to true, the action will skip the installation of the Terminus Build Tools plugin and will not use it to create Multidev environments or push code. This is useful if you just want to push the code and are not interested in syncing the database and files as part of your deploy process. By default, the action will install and use the Build Tools plugin unless this is set to true.nofalse
namedescription
target_envThe target environment the branch was deployed to
target_env_urlThe url for the target environment the branch was deployed to