Add release asset upload to GH Actions

Author: dennisameling

.github/workflows/mautic-asset-upload/.gitignore

@@ -0,0 +1 @@
+vendor

.github/workflows/mautic-asset-upload/composer.json

@@ -0,0 +1,8 @@
+{
+    "name": "mautic/upload-release-asset",
+    "description": "Updates the release asset (x.x.x.zip) to the m.mautic.org instance",
+    "type": "project",
+    "require": {
+        "mautic/api-library": "^2.16"
+    }
+}

.github/workflows/mautic-asset-upload/composer.lock

@@ -0,0 +1,94 @@
+<?php
+
+declare(strict_types=1);
+
+use Mautic\Auth\ApiAuth;
+use Mautic\MauticApi;
+
+require __DIR__.'/vendor/autoload.php';
+
+if ('cli' !== php_sapi_name()) {
+    die('This script can only run on the command line');
+}
+
+$vars = [
+    1 => 'instanceUrl',
+    2 => 'username',
+    3 => 'password',
+    4 => 'mauticVersion',
+    5 => 'assetCategoryId',
+    6 => 'fileToUpload',
+];
+
+foreach ($vars as $id => $var) {
+    if (empty($_SERVER['argv'][$id])) {
+        echo "Argument ${id} (${var}) is missing. Run this script as \"php upload.php ".implode(' ', $vars)."\"\n";
+        exit(1);
+    }
+
+    $$var = $_SERVER['argv'][$id];
+}
+
+// Set up the authentication
+$settings = [
+    'userName'   => $username,
+    'password'   => $password,
+];
+
+// Initiate the auth object specifying to use BasicAuth
+$initAuth = new ApiAuth();
+$auth     = $initAuth->newAuth($settings, 'BasicAuth');
+$api      = new MauticApi();
+
+/** @var \Mautic\Api\Files */
+$filesApi = $api->newApi('files', $auth, $instanceUrl);
+
+/** @var \Mautic\Api\Assets */
+$assetApi = $api->newApi('assets', $auth, $instanceUrl);
+
+/**
+ * Upload the file.
+ */
+$filesApi->setFolder('assets');
+// File should be an absolute path!
+$fileRequest = [
+    'file' => $fileToUpload,
+];
+
+$response = $filesApi->create($fileRequest);
+
+if (isset($response['error'])) {
+    echo $response['error']['code'].': '.$response['error']['message']."\n";
+    exit(1);
+}
+
+if (!isset($response['file']) || !isset($response['file']['name'])) {
+    echo 'An unknown error occurred while uploading the release asset to our Mautic instance. '
+        ."Please try again or debug locally (we don't provide logs in CI for security reasons)\n";
+    exit(1);
+}
+
+/**
+ * Create the actual asset based on the file we just uploaded.
+ */
+$data = [
+    'title'           => "Mautic ${mauticVersion}",
+    'storageLocation' => 'local',
+    'file'            => $response['file']['name'],
+    'category'        => $assetCategoryId,
+    'isPublished'     => false,
+];
+
+$response = $assetApi->create($data);
+
+if (isset($response['error'])) {
+    echo $response['error']['code'].': '.$response['error']['message']."\n";
+    exit(1);
+}
+
+if (!isset($response['asset']['id']) || !isset($response['asset']['downloadUrl'])) {
+    echo "Unknown error occurred while creating asset. Please debug locally.\n";
+    exit(1);
+}
+
+echo 'Successfully created asset with ID '.$response['asset']['id']." 🚀\n";

.github/workflows/mautic-asset-upload/upload.php

@@ -209,3 +209,40 @@ jobs:
       with:
         name: update-logs
         path: ./mautic-testing/var/logs/*
+
+  upload-release-asset:
+    name: Upload release asset to m.mautic.org
+    needs: [release, test-fresh-install, test-update-install]
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Get tag name
+      run: echo "MAUTIC_VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
+
+    - name: Setup PHP, with composer and extensions
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: 7.4
+        extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite, mysql, pdo_mysql
+
+    - name: Install dependencies
+      working-directory: ./.github/workflows/mautic-asset-upload
+      run: composer install --prefer-dist --no-progress
+
+    - name: Download full installation package from previous step
+      uses: actions/download-artifact@v2
+      with:
+        name: ${{ env.MAUTIC_VERSION }}.zip
+
+    # Category ID is 2 for Mautic release assets on m.mautic.org, that's why you're seeing "2" in the command below
+    - name: Upload release asset ZIP to m.mautic.org
+      run: |
+        php ./.github/workflows/mautic-asset-upload/upload.php \
+        https://m.mautic.org \
+        "${{ secrets.MAUTIC_INSTANCE_USER }}" \
+        "${{ secrets.MAUTIC_INSTANCE_PASSWORD }}" \
+        "${{ env.MAUTIC_VERSION }}" \
+        2 \
+        "${{ github.workspace }}/${{ env.MAUTIC_VERSION }}.zip"

.github/workflows/release.yml

@@ -5,7 +5,8 @@ $finder = PhpCsFixer\Finder::create()
     ->in(__DIR__.'/app/config')
     ->in(__DIR__.'/app/middlewares')
     ->in(__DIR__.'/app/migrations')
-    ->in(__DIR__.'/plugins');
+    ->in(__DIR__.'/plugins')
+    ->in(__DIR__.'/.github/workflows/mautic-asset-upload');
 
 return PhpCsFixer\Config::create()
     ->setRules([