Release v0.5.0

cianru · Sep 13, 2024 · fe0f99c · fe0f99c
1 parent 72f02ee
commit fe0f99c
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 30 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,43 @@
+# 0.5.0
+
+##### Add
+* [issue#9](https://github.com/cianru/rustore-publish-gradle-plugin/issues/9) Support of AAB files. Now you can publish AAB files to Rustore.
+Just use a new parameter `buildFormat` in your configuration:
+```kotlin
+configure<ru.cian.rustore.publish.RustorePublishExtension> {
+    instances {
+        register("release") {
+            buildFormat = ru.cian.rustore.publish.BuildFormat.AAB 
+        }
+    }
+}
+```
+if your file is large, you can increase the timeout by a new parameter `requestTimeout` in seconds:
+```kotlin
+configure<ru.cian.rustore.publish.RustorePublishExtension> {
+    instances {
+        register("release") {
+            ...
+            buildFormat = ru.cian.rustore.publish.BuildFormat.AAB 
+            requestTimeout = 1800 // seconds;
+            ....
+        }
+    }
+}
+```
+
+##### Breaking Changes
+* Remove support of Sonatype. It means that you can't use the plugin from Maven Central. You must to use the Gradle Portal. 
+  To do this, you need to add the following code to your `settings.gradle.kts`:
+  ```kotlin
+  pluginManagement {
+      repositories {
+          gradlePluginPortal()
+      }
+  }
+  ```
+
+
 # 0.4.0
 
 ##### Breaking Changes

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@
 ![Version](https://img.shields.io/badge/Gradle-8.*-pink.svg)
 [![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 *.apk build file to the [RuStore](https://rustore.ru). 
+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). 
 
 :construction: _That's unofficial plugin. We made it for ourselves and are sharing it for you._
 
@@ -39,14 +39,13 @@ The plugin use [Rustore API](https://help.rustore.ru/rustore/for_developers/work
 
 The following features are available:
 
-- :white_check_mark: Publish APK build file in RuStore
+- :white_check_mark: Publish APK and AAB build file in RuStore
 - :white_check_mark: Submit the build on all users after getting store approve
 - :white_check_mark: Update Release Notes for publishing build (Release Notes)
 - :white_check_mark: Separated settings for different configurations build types and flavors
 - :white_check_mark: Support of Gradle Portal and Gradle DSL
-- :white_check_mark: Support of Gradle 8.+
 - :white_check_mark: Support of Configuration Cache
-- :white_check_mark: Support of AppBundle
+- :white_check_mark: Support of Gradle 8.+
 
 The following features are missing:
 
@@ -115,16 +114,21 @@ rustorePublish {
        * Default value: `null` (but plugin wait that you provide credentials by CLI params)
        * CLI: `--credentialsPath`
        */
-      credentialsPath = "$rootDir/rustore-credentials-release.json"
-
-      /**
-       * 'apk' or 'aab' for corresponding build 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)
-       * Default value: `apk`
-       * CLI: `--buildFormat`
-       */
-      buildFormat = ru.cian.rustore.publish.BuildFormat.APK      
+       credentialsPath = "$rootDir/rustore-credentials-release.json"
+
+       /**
+        * 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 Extention DSL, available values:
+        * ----| ru.cian.rustore.publish.BuildFormat.APK
+        * ----| ru.cian.rustore.publish.BuildFormat.AAB
+        * Default value: `apk`
+        */
+       buildFormat = ru.cian.rustore.publish.BuildFormat.APK
     }
   }
 }
@@ -155,6 +159,7 @@ rustorePublish {
   instances {
     create("release") {
       /**
+       * (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:
@@ -168,25 +173,33 @@ rustorePublish {
        * CLI: `--credentialsPath`
        */
       credentialsPath = "$rootDir/rustore-credentials-release.json"
-
-      /**
-       * 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`
-       */
-      buildFile = "$rootDir/app/build/outputs/apk/release/app-release.apk"
-
+
       /**
-       * 'apk' or 'aab' for corresponding build format.
+       * (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 Extention DSL, available values:
+       * ----| ru.cian.rustore.publish.BuildFormat.APK
+       * ----| ru.cian.rustore.publish.BuildFormat.AAB
        * Default value: `apk`
-       * CLI: `--buildFormat`
        */
       buildFormat = ru.cian.rustore.publish.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`
+        */
+       buildFile = "$rootDir/app/build/outputs/apk/release/app-release.apk"
+
       /**
+       * (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)
@@ -195,16 +208,22 @@ rustorePublish {
       requestTimeout = 300
 
       /**
-       * Type of mobile services used in application. Available values: [\"Unknown\", \"HMS\"].
-       * For more details see param `servicesType` in documentation " +
+       * (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/
-       * Type: ru.cian.rustore.publish.MobileServicesType (Optional)
-       * Default value: UNKNOWN
        * CLI: `--mobileServicesType`
+       * ----| 'Unknown'
+       * ----| 'HMS'
+       * Gradle Extention 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)
        * Release Notes settings. For mote info see ReleaseNote param desc.
        * Type: List<ReleaseNote> (Optional)
        * Default value: `null`

diff --git a/plugin/gradle.properties b/plugin/gradle.properties
@@ -9,7 +9,7 @@ android.enableJetifier=true
 ####################################################################################################
 
 GROUP_ID=ru.cian.rustore-plugin
-VERSION_NAME=0.5.0-alpha02
+VERSION_NAME=0.5.0
 
 POM_ARTIFACT_ID=rustore-publish-gradle-plugin
 POM_NAME=Rustore Publish Gradle Plugin