Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 3.37 KB

README.md

File metadata and controls

103 lines (68 loc) · 3.37 KB
Raw

Cloudways API Git Pull Action

Cloudways allows you to deploy your WordPress project (plugin, theme or entire site) from Git using the Cloudways API.

This GitHub Action will deploy your last project changes from GitHub to your Cloudways server.

Configuration

To use this GitHub Action you need:

  1. Cloudways account.
  2. Cloudways API Key.
  3. Deployment Via Git already configured.
  4. Cloudways' data stored in your GitHub repository secrets.

Cloudways provides you an easy way to get it in its own platform or read this guide about how to generate it.

Also, you can read this guide to know how to set up your Deployment Via Git functionality in Cloudways.

Secrets

You can specify the Cloudways' data right into your Workflow file but that is not recommended for security reasons.

Instead, you must use GitHub Secrets for your repository with the following names:

  • CLOUDWAYS_EMAIL
  • CLOUDWAYS_API_KEY
  • CLOUDWAYS_SERVER_ID
  • CLOUDWAYS_APP_ID
  • CLOUDWAYS_BRANCH_NAME
  • CLOUDWAYS_DEPLOY_PATH

Follow the exact secrets names in your Workflow file, so you can identify those quickly.

GitHub Secrets are set in your repository settings.

Required Inputs

You must provide all of these inputs in your Workflow file.

  • email
  • api-key
  • server-id
  • app-id
  • branch-name
  • deploy-path

Usage

To get started, you might want to copy the content of the next example into .github/workflows/cloudways-deploy.yml and push that file to your repository.

In the example, the deployment will start when you create and push a new tag. You can change that behavior, for example, when you create a release or a simple push to your main branch.

name: Cloudways API Git Pull

on:
  push:
    tags:
      - "*"

jobs:
  tag:
    name: New Tag

    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Cloudways API Git Pull
        uses: roelmagdaleno/cloudways-api-git-pull-action@stable
        with:
          email: ${{ secrets.CLOUDWAYS_EMAIL }}
          api-key: ${{ secrets.CLOUDWAYS_API_KEY }}
          server-id: ${{ secrets.CLOUDWAYS_SERVER_ID }}
          app-id: ${{ secrets.CLOUDWAYS_APP_ID }}
          branch-name: ${{ secrets.CLOUDWAYS_BRANCH_NAME }}
          deploy-path: ${{ secrets.CLOUDWAYS_DEPLOY_PATH }}

If you don't see your last changes in your server after run the GitHub Action then check whether your Git branch is updated with the changes.

deploy-path

The deploy-path input is the path your deployment will paste the project last changes.

If you want to deploy inside the public_html then its value must be an empty string.

If you want to deploy, for example, to a plugin folder then the deploy-path value must be:

deploy-path: 'wp-content/plugins/<plugin-name>/'

As you can see, we don't need to specify the public_html string to the path.

It's important to finish the path with a slash.

License

This GitHub Action is available for use and remix under the MIT license.