Add description for RustorePublishExtension parameters

cianru · Oct 25, 2024 · 31d203c · 31d203c
1 parent 9c533f5
commit 31d203c
Showing 1 changed file with 86 additions and 5 deletions.
diff --git a/plugin/src/main/kotlin/ru/cian/rustore/publish/RustorePublishExtension.kt b/plugin/src/main/kotlin/ru/cian/rustore/publish/RustorePublishExtension.kt
@@ -2,6 +2,8 @@ package ru.cian.rustore.publish
 
 import groovy.lang.Closure
 import org.gradle.api.Project
+import org.gradle.api.tasks.Input
+import org.gradle.api.provider.Property
 
 open class RustorePublishExtension(
     project: Project
@@ -12,29 +14,108 @@ open class RustorePublishExtension(
     }
 
     companion object {
+
         const val MAIN_EXTENSION_NAME = "rustorePublish"
     }
 }
 
+/**
+ * For required property use GradleProperty class instance.
+ * For example:
+ *  var param by GradleProperty(project, String::class.java)
+ */
 class RustorePublishExtensionConfig(
     val name: String,
     val project: Project
 ) {
 
     /**
-     * For required property use GradleProperty class instance.
-     * For example:
-     *  var param by GradleProperty(project, String::class.java)
+     * (Required)
+     * Path to json file with RuStore credentials params (`key_id` and `client_secret`).
+     * How to get credentials see [[RU] Rustore API Getting Started](https://www.rustore.ru/help/work-with-rustore-api/api-authorization-process/).
+     * Plugin credential json example:
+     * {
+     *   "key_id": "<KEY_ID>",
+     *   "client_secret": "<CLIENT_SECRET>"
+     * }
+     *
+     * Type: String (Optional)
+     * Default value: `null` (but plugin wait that you provide credentials by CLI params)
+     * CLI: `--credentialsPath`
      */
     var credentialsPath: String? = null
+
+    /**
+     * (Optional)
+     * CLI: `--publishType`
+     * ----| 'instantly' – the application will be published immediately after the review process is completed.
+     * ----| 'manual' – the application must be published manually by the developer after ther review process is completed.
+     * Gradle Extension DSL, available values:
+     * ----| ru.cian.rustore.publish.PublishType.INSTANTLY
+     * ----| ru.cian.rustore.publish.PublishType.MANUAL
+     * Default value: `instantly`
+     */
     var publishType = PublishType.INSTANTLY
+
+    /**
+     * (Optional)
+     * The time in seconds to wait for the publication to complete. Increase it if you build is large.
+     * Type: Long (Optional)
+     * Default value: `300` // (5min)
+     * CLI: `--requestTimeout`
+     */
     var requestTimeout: Long? = null
+
+    /**
+     * (Optional)
+     * Type of mobile services used in application.
+     * For more details see param `servicesType` in documentation:
+     * https://www.rustore.ru/help/work-with-rustore-api/api-upload-publication-app/apk-file-upload/file-upload-apk/
+     * CLI: `--mobileServicesType`
+     * ----| 'Unknown'
+     * ----| 'HMS'
+     * Gradle Extension DSL, available values:
+     * ----| ru.cian.rustore.publish.MobileServicesType.UNKNOWN
+     * ----| ru.cian.rustore.publish.MobileServicesType.HMS
+     * Default value: `Unknown`
+     */
     var mobileServicesType: MobileServicesType = MobileServicesType.UNKNOWN
+
+    /**
+     * (Required)
+     * Build file format.
+     * See https://www.rustore.ru/help/developers/publishing-and-verifying-apps/app-publication/upload-aab how to prepare project for loading of aab files.
+     * Type: String (Optional)
+     * CLI: `--buildFormat`, available values:
+     * ----| 'apk'
+     * ----| 'aab'
+     * Gradle Extension DSL, available values:
+     * ----| ru.cian.rustore.publish.BuildFormat.APK
+     * ----| ru.cian.rustore.publish.BuildFormat.AAB
+     * Default value: `apk`
+     */
     var buildFormat: BuildFormat = BuildFormat.APK
+
+    /**
+     * (Optional)
+     * Path to build file if you would like to change default path. "null" means use standard path for "apk" and "aab" files.
+     * Type: String (Optional)
+     * Default value: `null`
+     * CLI: `--buildFile`
+     */
     var buildFile: String? = null
+
+    /**
+     * (Optional)
+     * Release Notes settings. For mote info see ReleaseNote param desc.
+     * Type: List<ReleaseNote> (Optional)
+     * Default value: `null`
+     * CLI: (see ReleaseNotes param desc.)
+     */
+    var releaseNotes: List<ReleaseNote>? = null
+
     var releaseTime: String? = null
     var releasePhase: ReleasePhaseExtension? = null
-    var releaseNotes: List<ReleaseNote>? = null
 
     init {
         require(name.isNotBlank()) {
@@ -52,7 +133,7 @@ class RustorePublishExtensionConfig(
         return "RustorePublishExtensionConfig(" +
             "name='$name', " +
             "credentialsPath='$credentialsPath', " +
-            "deployType='$publishType', " +
+            "publishType='$publishType', " +
             "requestTimeout='$requestTimeout', " +
             "mobileServicesType='$mobileServicesType', " +
             "buildFormat='$buildFormat', " +