masterfermin02/cloud-ways-deploy

A deployment tool written in PHP for cloudways.

Maintainers

Details

github.com/masterfermin02/cloudways-deployment

Homepage

Source

Issues

Installs: 6

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 3

Forks: 0

Open Issues: 0

v1.0.1 2021-03-14 03:31 UTC

Requires

  • php: ^8.0

Requires (Dev)

BSD-3-Clause 7d7eabe4925e42579aeff6780eb749ca0a6f0e67

This package is auto-updated.

Last update: 2024-10-23 23:34:11 UTC

README

Social Card of cloudways deployment tool

cloudways-deployment

GitHub forks GitHub starts license

A deployment tool written in PHP to deploy apps to cloudways.

Installation and usage

This package requires PHP 8 or higher.

  • Install by composer
composer require masterfermin02/cloud-ways-deploy

Use

  • Config your git webhook doc
  • Deploy example script:
<?php declare(strict_types=1);

require __DIR__ . '/../vendor/autoload.php';

use Dotenv\Dotenv;

$dotenv = Dotenv::createImmutable(__DIR__ . '/../');
$dotenv->load();

use App\Input;
use CloudWays\Deploy\Client;
use CloudWays\Requester;
use CloudWays\Server;

$apiKey = $_ENV['API_KEY']; // API key clouds ways key
$API_URL = $_ENV['API_URL']; // your cloudways server api url
$email = $_ENV['DEPLOYMENT_EMAIL']; // your email to receive notifiy on deploy finish
$input = Input::create(array_merge($_GET, $_POST));

// git web hook example url http://yourserver/deployApplication.php?server_id=1234&app_id=1234&git_url=git_url&branch_name=master&deploy_path=path_to_your_app
$gitPullResponse = Client::create($email, $apiKey, Requester::create($API_URL))
->execute(Server::create(
    $input->get('server_id'),
    $input->get('git_url'),
    $input->get('branch_name'),
    $input->get('app_id')
));

echo (json_encode($gitPullResponse));

Testing

Run the tests with:

composer test

Contributing

Please see CONTRIBUTING for details.

Credits