Upsun SDK for PHP

CAUTION: This project is currently in Beta, meaning features and APIs may evolve over time. Please report bugs or request new features by creating a GitHub issue.

​

Installation

composer require upsun/upsun-sdk-php

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

​

Authentication

use Upsun\UpsunConfig;
use Upsun\UpsunClient;

$config = new UpsunConfig(apiToken: getenv('UPSUN_API_TOKEN'));
$upsunClient = new UpsunClient($config);

​

Usage

​

Example: List organizations

$organizations = $upsunClient->organizations->list();

​

Example: List projects in an organization

$projects = $upsunClient->projects->list('<organizationId>');

​

Example: Redeploy an environment

$response = $upsunClient->environments->redeploy('<projectId>', '<environmentId>');

​

Development

git clone git@github.com:upsun/upsun-sdk-php.git
composer install

​

Architecture of this SDK

• From the JSON specs of our API
• Using @openapitools/openapi-generator-cli
• Which generates:
  • PHP Models (in src/Model/)
  • PHP APIs (in src/Api/)
• Higher-level PHP (Facade) oriented Tasks (in src/Core/Tasks/)

​

Regenerating API & Model classes

composer run spec:install
composer run spec:full

​

Contributing

​

Publishing

1. update your local

git fetch
git checkout main
git pull

2. check existing tags on https://github.com/upsun/upsun-sdk-php/tags
3. create a new tag from your local

git tag v<x.y.z>
git push --tag

4. Go on release page: https://github.com/upsun/upsun-sdk-php/releases
5. create a new release based on the previously created tag (Do not forget to autogenerate description in the form)
6. check publishing action status: https://github.com/upsun/upsun-sdk-php/actions
7. check new release version on https://packagist.org/packages/upsun/upsun-sdk-php

​

Tests

composer install
composer run test

​

License