Merge pull request #18 from cianru/snapshot-0.5.1

Snapshot 0.5.1

CHANGELOG.md

@@ -1,3 +1,21 @@
+# 0.5.1
+
+##### Add
+* [issue#15](https://github.com/cianru/rustore-publish-gradle-plugin/issues/15) Support of `publishType` param to control the publish process.
+```kotlin
+    /**
+     * (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`
+     */
+    publishType = ru.cian.rustore.publish.PublishType.INSTANTLY
+```
+
 # 0.5.0
 
 ##### Add

README.md

@@ -12,8 +12,8 @@
   </h1>
 </p>
 
-![Version](https://img.shields.io/badge/GradlePortal-0.5.0-green.svg)
-![Version](https://img.shields.io/badge/Gradle-8.*-pink.svg)
+[//]: # (![Version]&#40;https://img.shields.io/badge/GradlePortal-0.5.0-green.svg&#41;)
+<img src="https://img.shields.io/maven-metadata/v.svg?label=Gradle%20Plugins%20Portal&metadataUrl=https%3A%2F%2Fplugins.gradle.org%2Fm2%2Fru%2Fcian%2Frustore-publish-gradle-plugin%2Fru.cian.rustore-publish-gradle-plugin.gradle.plugin%2Fmaven-metadata.xml" />
 [![License](https://img.shields.io/github/license/srs/gradle-node-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
 
 The plugin use [Rustore API](https://help.rustore.ru/rustore/for_developers/work_with_RuStore_API/publish_RuStore_API) to publish Android build file to the [RuStore](https://rustore.ru). 
@@ -123,7 +123,7 @@ rustorePublish {
         * CLI: `--buildFormat`, available values:
         * ----| 'apk'
         * ----| 'aab'
-        * Gradle Extention DSL, available values:
+        * Gradle Extension DSL, available values:
         * ----| ru.cian.rustore.publish.BuildFormat.APK
         * ----| ru.cian.rustore.publish.BuildFormat.AAB
         * Default value: `apk`
@@ -182,7 +182,7 @@ rustorePublish {
        * CLI: `--buildFormat`, available values:
        * ----| 'apk'
        * ----| 'aab'
-       * Gradle Extention DSL, available values:
+       * Gradle Extension DSL, available values:
        * ----| ru.cian.rustore.publish.BuildFormat.APK
        * ----| ru.cian.rustore.publish.BuildFormat.AAB
        * Default value: `apk`
@@ -203,7 +203,7 @@ rustorePublish {
        * 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: `--publishTimeoutMs`
+       * CLI: `--requestTimeout`
        */
       requestTimeout = 300
 
@@ -215,13 +215,25 @@ rustorePublish {
        * CLI: `--mobileServicesType`
        * ----| 'Unknown'
        * ----| 'HMS'
-       * Gradle Extention DSL, available values:
+       * Gradle Extension DSL, available values:
        * ----| ru.cian.rustore.publish.MobileServicesType.UNKNOWN
        * ----| ru.cian.rustore.publish.MobileServicesType.HMS
        * Default value: `Unknown`
        */
       mobileServicesType = ru.cian.rustore.publish.MobileServicesType.UNKNOWN
 
+        /**
+         * (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`
+         */  
+      publishType = ru.cian.rustore.publish.PublishType.INSTANTLY
+
       /**
        * (Optional)
        * Release Notes settings. For mote info see ReleaseNote param desc.
@@ -270,7 +282,7 @@ rustorePublish {
             credentialsPath = "$rootDir/rustore-credentials-release.json"
             buildFormat = "apk"
             buildFile = "$rootDir/app/build/outputs/apk/release/app-release.apk"
-            requestTimeout = 60
+            requestTimeout = 60 // 1min
             mobileServicesType = "Unknown"
             releaseNotes = [
                 new ru.cian.rustore.publish.ReleaseNote(
@@ -334,6 +346,7 @@ CLI params are more priority than gradle configuration params.
     --credentialsPath="/sample-kotlin/rustore-credentials.json" \
     --buildFormat=apk \
     --buildFile="/sample-kotlin/app/build/outputs/apk/release/app-release.apk" \
+    --requestTimeout=300 \ # 5min
     --mobileServicesType="Unknown" \
     --releaseNotes="ru_RU:/home/<USERNAME>/str/project/release_notes_ru.txt"
 ```

gradle/libs.versions.toml

@@ -13,7 +13,7 @@ kotlin = "1.9.23"
 detekt = "1.23.4"
 junitJupiter = "5.9.3"
 androidGradlePlugin = "8.0.2"
-sampleRustorePlugin = "0.5.0-alpha02"
+sampleRustorePlugin = "0.5.1-alpha01"
 
 [libraries]
 appcompat = "androidx.appcompat:appcompat:1.6.1"

plugin/gradle.properties

@@ -9,7 +9,7 @@ android.enableJetifier=true
 ####################################################################################################
 
 GROUP_ID=ru.cian.rustore-plugin
-VERSION_NAME=0.5.0
+VERSION_NAME=0.5.1
 
 POM_ARTIFACT_ID=rustore-publish-gradle-plugin
 POM_NAME=Rustore Publish Gradle Plugin

plugin/src/main/kotlin/ru/cian/rustore/publish/PluginConfig.kt

@@ -4,7 +4,7 @@ import java.io.File
 
 internal data class PluginConfig(
     val credentials: Credentials,
-    val deployType: DeployType,
+    val publishType: PublishType,
     val artifactFormat: BuildFormat,
     val requestTimeout: Long?,
     val mobileServicesType: MobileServicesType,

plugin/src/main/kotlin/ru/cian/rustore/publish/RustorePublishCli.kt

@@ -1,7 +1,7 @@
 package ru.cian.rustore.publish
 
 internal data class RustorePublishCli(
-    val deployType: DeployType? = null,
+    val publishType: PublishType? = null,
     val credentialsPath: String? = null,
     val keyId: String? = null,
     val clientSecret: String? = null,

plugin/src/main/kotlin/ru/cian/rustore/publish/RustorePublishExtension.kt

@@ -27,7 +27,7 @@ class RustorePublishExtensionConfig(
      *  var param by GradleProperty(project, String::class.java)
      */
     var credentialsPath: String? = null
-    var deployType = DeployType.PUBLISH
+    var publishType = PublishType.INSTANTLY
     var requestTimeout: Long? = null
     var mobileServicesType: MobileServicesType = MobileServicesType.UNKNOWN
     var buildFormat: BuildFormat = BuildFormat.APK
@@ -52,7 +52,7 @@ class RustorePublishExtensionConfig(
         return "RustorePublishExtensionConfig(" +
             "name='$name', " +
             "credentialsPath='$credentialsPath', " +
-            "deployType='$deployType', " +
+            "deployType='$publishType', " +
             "requestTimeout='$requestTimeout', " +
             "mobileServicesType='$mobileServicesType', " +
             "buildFormat='$buildFormat', " +
@@ -111,19 +111,19 @@ enum class MobileServicesType(val value: String) {
     UNKNOWN("Unknown"),
 }
 
-enum class DeployType {
+enum class PublishType {
     /**
-     * Deploy without draft saving and submit on users;
+     * Manual publication. After review you should publish it manually;
      */
-    UPLOAD_ONLY,
+    MANUAL,
 
     /**
-     * Deploy and save as draft without submit on users;
+     * Automatically publish on all users after reviewing store approve;
      */
-    DRAFT,
+    INSTANTLY,
 
     /**
-     * Deploy, save as draft and submit build on users;
+     * Delayed publication. You should set publishDateTime;
      */
-    PUBLISH,
+//    DELAYED, // FIXME: Implement delayed publication after adding of `publishDateTime` API param;
 }

plugin/src/main/kotlin/ru/cian/rustore/publish/RustorePublishTask.kt

@@ -39,14 +39,6 @@ open class RustorePublishTask
 
     private val logger by lazy { Logger(project) }
 
-    @get:Internal
-    @set:Option(
-        option = "deployType",
-        description = "How to deploy build: 'publish' to all users or create 'draft' " +
-            "without publishing or 'upload-only' without draft creation"
-    )
-    var deployType: DeployType? = null
-
     @get:Internal
     @set:Option(
         option = "credentialsPath",
@@ -126,6 +118,13 @@ open class RustorePublishTask
     )
     var releaseNotes: String? = null
 
+    @get:Internal
+    @set:Option(
+        option = "publishType",
+        description = "How to publish build file. Available values: ['manual', 'instantly']."
+    )
+    var publishType: PublishType? = null
+
     @get:Internal
     @set:Option(option = "apiStub", description = "Use RestAPI stub instead of real RestAPI requests")
     var apiStub: Boolean? = false
@@ -149,7 +148,7 @@ open class RustorePublishTask
             )
 
         val cli = RustorePublishCli(
-            deployType = deployType,
+            publishType = publishType,
             credentialsPath = credentialsPath,
             keyId = keyId,
             clientSecret = clientSecret,
@@ -212,6 +211,7 @@ open class RustorePublishTask
             token = token,
             applicationId = config.applicationId,
             whatsNew = config.releaseNotes?.first()?.newFeatures ?: "",
+            publishType = config.publishType.name,
         )
 
         logger.v("5/6. Upload build file '${config.artifactFile}'")

plugin/src/main/kotlin/ru/cian/rustore/publish/models/request/AppDraftRequest.kt

@@ -5,4 +5,6 @@ import com.google.gson.annotations.SerializedName
 internal data class AppDraftRequest(
     @SerializedName("whatsNew")
     val whatsNew: String,
+    @SerializedName("publishType")
+    val publishType: String,
 )

plugin/src/main/kotlin/ru/cian/rustore/publish/service/RustoreService.kt

@@ -18,6 +18,7 @@ internal interface RustoreService {
         token: String,
         applicationId: String,
         whatsNew: String,
+        publishType: String,
     ): Int
 
     @Suppress("LongParameterList")

plugin/src/main/kotlin/ru/cian/rustore/publish/service/RustoreServiceImpl.kt

@@ -61,9 +61,11 @@ internal class RustoreServiceImpl(
         token: String,
         applicationId: String,
         whatsNew: String,
+        publishType: String,
     ): Int {
         val bodyRequest = AppDraftRequest(
             whatsNew = whatsNew,
+            publishType = publishType,
         )
 
         logger.i("""
@@ -72,7 +74,8 @@ internal class RustoreServiceImpl(
             --header 'Content-Type: application/json' \
             --header 'Public-Token: $token' \
             --data-raw '{
-                "whatsNew": "$whatsNew"
+                "whatsNew": "$whatsNew",
+                "publishType": "$publishType"
             }'            
         """.trimIndent())
 
@@ -111,10 +114,11 @@ internal class RustoreServiceImpl(
                 token = token,
                 applicationId = applicationId,
                 whatsNew = whatsNew,
+                publishType = publishType,
             )
         }
 
-        logger.v("response=$response")
+        logger.i("response=$response")
         return response.body
     }
 
@@ -180,7 +184,7 @@ internal class RustoreServiceImpl(
             headers = headers
         )
 
-        logger.v("response=$response")
+        logger.i("response=$response")
 
         check(response.code == "OK") {
             "Build file uploading is failed! " +
@@ -234,7 +238,7 @@ internal class RustoreServiceImpl(
             ),
         )
 
-        logger.v("response=$response")
+        logger.i("response=$response")
 
         return response.code == "OK"
     }

plugin/src/main/kotlin/ru/cian/rustore/publish/utils/ConfigProvider.kt

@@ -22,7 +22,7 @@ internal class ConfigProvider(
 
         val requestTimeout = cli.requestTimeout?.toLongOrNull() ?: extension.requestTimeout
         val mobileServicesType = cli.mobileServicesType ?: extension.mobileServicesType
-        val deployType = cli.deployType ?: extension.deployType
+        val publishType = cli.publishType ?: extension.publishType
         val artifactFormat = cli.buildFormat ?: extension.buildFormat
         val customBuildFilePath: String? = cli.buildFile ?: extension.buildFile
         val releaseTime: String? = cli.releaseTime ?: extension.releaseTime
@@ -44,7 +44,7 @@ internal class ConfigProvider(
 
         return PluginConfig(
             credentials = credentialsConfig,
-            deployType = deployType,
+            publishType = publishType,
             requestTimeout = requestTimeout,
             mobileServicesType = mobileServicesType,
             artifactFormat = actualArtifactFormat,