https://github.com/roelmagdaleno/cloudways-api-git-pull-action
This GitHub Action will deploy your last project changes from GitHub to your Cloudways server.
https://github.com/roelmagdaleno/cloudways-api-git-pull-action
cloudways deploy github-actions
Last synced: about 1 month ago
JSON representation
This GitHub Action will deploy your last project changes from GitHub to your Cloudways server.
- Host: GitHub
- URL: https://github.com/roelmagdaleno/cloudways-api-git-pull-action
- Owner: roelmagdaleno
- Created: 2021-08-22T02:30:28.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-28T05:57:29.000Z (about 1 year ago)
- Last Synced: 2025-01-06T10:49:52.934Z (4 months ago)
- Topics: cloudways, deploy, github-actions
- Language: JavaScript
- Homepage:
- Size: 428 KB
- Stars: 19
- Watchers: 2
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cloudways API Git Pull Action
Cloudways allows you to deploy your WordPress project (plugin, theme or entire site) from Git using the [Cloudways API](https://developers.cloudways.com/).
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](https://platform.cloudways.com/api) or [read this guide about how to generate it](https://support.cloudways.com/en/articles/5136065-how-to-use-the-cloudways-api).
Also, you can read this guide to know [how to set up your Deployment Via Git functionality in Cloudways](https://support.cloudways.com/en/articles/5124087-deploy-code-to-your-application-using-git).
## 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](https://docs.github.com/es/actions/reference/encrypted-secrets).
## 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](https://docs.github.com/en/actions/reference/events-that-trigger-workflows), for example, when you create a release or a simple push to your `main` branch.
```yaml
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:
```yaml
deploy-path: 'wp-content/plugins//'
```
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.