From 5149a83159f2041da47fd749f79b749b65bad9f4 Mon Sep 17 00:00:00 2001 From: Jake Barnby Date: Wed, 7 Jul 2021 00:05:45 +1200 Subject: [PATCH 1/3] Allow docs per language per SDK --- app/tasks/sdks.php | 12 +++++++++--- composer.json | 2 +- composer.lock | 18 ++++++++++-------- 3 files changed, 20 insertions(+), 12 deletions(-) diff --git a/app/tasks/sdks.php b/app/tasks/sdks.php index 575d938f4..f57b2dce9 100644 --- a/app/tasks/sdks.php +++ b/app/tasks/sdks.php @@ -223,9 +223,15 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND Console::success("Remove temp directory '{$target}' for {$language['name']} SDK"); } - \exec('mkdir -p '.$resultExamples.' && cp -r '.$result.'/docs/examples '.$resultExamples); - Console::success("Copied code examples for {$language['name']} SDK to: {$resultExamples}"); - + $docDirectories = $language['docDirectories'] ?? ['']; + foreach ($docDirectories as $languageTitle => $path) { + $languagePath = strtolower($languageTitle !== 0 ? '/'.$languageTitle : ''); + \exec( + 'mkdir -p '.$resultExamples.$languagePath.' && \ + cp -r '.$result.'/docs/examples'.$languagePath.' '.$resultExamples + ); + Console::success("Copied code examples for {$language['name']} SDK to: {$resultExamples}"); + } } } diff --git a/composer.json b/composer.json index 24c64c15f..31a7afa40 100644 --- a/composer.json +++ b/composer.json @@ -62,7 +62,7 @@ "slickdeals/statsd": "3.1.0" }, "require-dev": { - "appwrite/sdk-generator": "0.11.1", + "appwrite/sdk-generator": "dev-feat-kotlin-java-docs", "swoole/ide-helper": "4.6.7", "phpunit/phpunit": "9.5.6", "vimeo/psalm": "4.7.2" diff --git a/composer.lock b/composer.lock index 233a52b58..4bb236099 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "65ff5003b9122286423aa030cb6983ea", + "content-hash": "7983e9fe8946a99fbf818b79ff202486", "packages": [ { "name": "adhocore/jwt", @@ -2403,16 +2403,16 @@ }, { "name": "appwrite/sdk-generator", - "version": "0.11.1", + "version": "dev-feat-kotlin-java-docs", "source": { "type": "git", "url": "https://github.com/appwrite/sdk-generator.git", - "reference": "9809c31f27037d088fb832cdec0e8fbc93d1d388" + "reference": "966d464728b41a8c449e99d7df4bd4ddca591a25" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/appwrite/sdk-generator/zipball/9809c31f27037d088fb832cdec0e8fbc93d1d388", - "reference": "9809c31f27037d088fb832cdec0e8fbc93d1d388", + "url": "https://api.github.com/repos/appwrite/sdk-generator/zipball/966d464728b41a8c449e99d7df4bd4ddca591a25", + "reference": "966d464728b41a8c449e99d7df4bd4ddca591a25", "shasum": "" }, "require": { @@ -2446,9 +2446,9 @@ "description": "Appwrite PHP library for generating API SDKs for multiple programming languages and platforms", "support": { "issues": "https://github.com/appwrite/sdk-generator/issues", - "source": "https://github.com/appwrite/sdk-generator/tree/0.11.1" + "source": "https://github.com/appwrite/sdk-generator/tree/feat-kotlin-java-docs" }, - "time": "2021-07-02T10:15:53+00:00" + "time": "2021-07-06T09:26:45+00:00" }, { "name": "composer/package-versions-deprecated", @@ -6066,7 +6066,9 @@ ], "aliases": [], "minimum-stability": "stable", - "stability-flags": [], + "stability-flags": { + "appwrite/sdk-generator": 20 + }, "prefer-stable": false, "prefer-lowest": false, "platform": { From defd553bd9c99345ed28d0d0ce0f6b1ec12a01d5 Mon Sep 17 00:00:00 2001 From: Jake Barnby Date: Wed, 7 Jul 2021 00:06:14 +1200 Subject: [PATCH 2/3] Add java + kotlin doc sources for android + kotlin SDK's --- app/config/platforms.php | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/app/config/platforms.php b/app/config/platforms.php index 2eebd33be..ddcb1df33 100644 --- a/app/config/platforms.php +++ b/app/config/platforms.php @@ -124,6 +124,10 @@ return [ 'gitUrl' => 'git@github.com:appwrite/sdk-for-android.git', 'gitRepoName' => 'sdk-for-android', 'gitUserName' => 'appwrite', + 'docDirectories' => [ + 'Java' => realpath(__DIR__ . '/../sdks/client-android/docs/java'), + 'Kotlin' => realpath(__DIR__ . '/../sdks/client-android/docs/kotlin') + ], ], // [ // 'key' => 'java', @@ -362,6 +366,10 @@ return [ 'gitUrl' => 'git@github.com:appwrite/sdk-for-kotlin.git', 'gitRepoName' => 'sdk-for-kotlin', 'gitUserName' => 'appwrite', + 'docDirectories' => [ + 'Java' => realpath(__DIR__ . '/../sdks/server-kotlin/docs/java'), + 'Kotlin' => realpath(__DIR__ . '/../sdks/server-kotlin/docs/kotlin') + ], ], ], ], From ccf3f41eb64029c2576a1f3d9cabab6903d364ca Mon Sep 17 00:00:00 2001 From: "Eldad A. Fux" Date: Tue, 6 Jul 2021 19:32:53 +0300 Subject: [PATCH 3/3] Update composer.json --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 31a7afa40..7aa0d4f01 100644 --- a/composer.json +++ b/composer.json @@ -62,7 +62,7 @@ "slickdeals/statsd": "3.1.0" }, "require-dev": { - "appwrite/sdk-generator": "dev-feat-kotlin-java-docs", + "appwrite/sdk-generator": "0.12.0", "swoole/ide-helper": "4.6.7", "phpunit/phpunit": "9.5.6", "vimeo/psalm": "4.7.2"