Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.64 KB

README.md

File metadata and controls

45 lines (27 loc) · 1.64 KB
Raw

Platform.sh Deploy action

This is a composite action designed to simplify deployment to platform.sh. One of the main reasons to write this was to avoid a basic mistake with checking out the repository. The popular Github action actions/checkout does a shallow clone by default which can sometimes break the site. This action does a full clone and sets up PHP as well before installing the CLI.

Inputs

project-id

The project ID on platform.sh. You can find this using the CLI or the web console.

cli-token

A token to access platform.sh API. See instructions on platform.sh docs.

ssh-private-key (optional)

The platform.sh CLI generates a temporary certificate for use for deployment. However, you may still choose to provide a private key that lets you push via git. Create a specialized key used only for deployment and use Github secrets to keep your key safe.

php-version

The PHP version to use. This is directly passed to shivammathur/setup-php. Default: 8.0.

force-push

An option to force push changes to the project repository on Platform.sh. Use with caution as force push overrides your commit history.

environment-name

The name of the platform.sh instance on which to act. Default: The current branch name.

Outputs

No outputs.

Example usage

uses: axelerant/platformsh-deploy-action@v1
with:
  project-id: ${{ secrets.PlatformProjectId }}
  cli-token: ${{ secrets.PlatformCliToken }}
  ssh-private-key: ${{ secrets.PlatformSshKey }}
  php-version: 8.1
  force-push: true