Huawei AppGallery Publishing Gradle Plugin

The plugin allows to publish the android release build files (*.apk and *.aab) to the Huawei AppGallery by use official Huawei Publish API (v2)

:construction: That's unofficial plugin. We made it for ourselves and are sharing it for you.

Table of contents

• Features
• Compatibility
• Adding the plugin to your project
  • Using the Gradle plugin DSL
  • Using the apply method
  • Quick Start Plugin Configuration
  • Full Plugin Configuration
• Plugin usage
• CLI Plugin Configuration
• Known Huawei Publishing API Issues
• FAQ

Features

The following features are available:

• :white_check_mark: Publish APK or AAB build file in Huawei AppGallery
• :white_check_mark: Submit the build on all users after getting store approve
• :white_check_mark: Publish the build on a part of users (Release Phases)
• :white_check_mark: Update Release Notes for publishing build (Release Notes)
• :white_check_mark: Update App Basic Info for publishing build
• :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

The following features are missing:

• :children_crossing: Change App Store Information: description, app icon, screenshots and etc.

The following features doesn't support Huawei Publishing API:

• :no_entry: Update appname, title and description.
• :no_entry: Rollout Holding

Compatibility

The Android Gradle Plugin often changes the Variant API, so a different version of AGP corresponds to a specific version of the current plugin

Adding the plugin to your project

in application module ./app/build.gradle

Using the Gradle plugin DSL

plugins {
    id("com.android.application")
    id("ru.cian.huawei-publish-gradle-plugin")
}

Using the apply method

buildscript {
    repositories {
        gradlePluginPortal()
    }

    dependencies {
        classpath "ru.cian.huawei-plugin:plugin:<PLUGIN_VERSION>"
    }
}

apply plugin: 'com.android.application'
apply plugin: 'ru.cian.huawei-publish-gradle-plugin'

Quick Start Plugin Configuration

Before using the plugin you should get client_id and client_secret from AppGallery Connect API Getting Started.

Minimal configuration for plugin usage:

Full Plugin Configuration

Also the plugin support different buildType and flavors. So for demo and full flavors and release buildType just change instances like that:

huaweiPublish {
    instances {
        create("release") {
            ...
        }
        create("demoRelease")
            ...
        }
        create("fullRelease")
            ...
        }
    }
}

Plugin usage

Gradle generate publishHuaweiAppGallery<*> task for all BuildType and Flavor configurations.

:warning: Note! The plugin will publish already existed build file. Before uploading you should build it yourself. Be careful. Don't publish old build file.

./gradlew assembleRelease publishHuaweiAppGalleryRelease

or

./gradlew bundleRelease publishHuaweiAppGalleryRelease

CLI Plugin Configuration

You can change plugin configuration by CLI. There are all the same parameters as in the plugin gradle configuration. CLI params are more priority than gradle configuration params.

./gradlew assembleRelease publishHuaweiAppGalleryRelease \
    --credentials = "<BASE64_ENCODED_CREDENTIALS>" \  # High priority than `credentialsPath`;
    --credentialsPath="./sample-kotlin/huawei-credentials.json" \  # Low priority than `credentials`;
    --deployType=publish \
    --buildFormat=apk \
    --buildFile="./app/outputs/apk/release/app-release.apk"
    --publishSocketTimeoutInSeconds=60 \
    --publishTimeoutMs=600000 \
    --publishPeriodMs=15000 \
    --releaseTime="2025-10-21T06:00:00+0300" \ 
    --releasePhaseStartTime=2020-11-13T08:01:02+0300 \
    --releasePhaseEndTime=2020-11-20T15:30:00+0300 \
    --releasePhasePercent=5.0 \
    --releaseNotes="en_EN:/home/<USERNAME>/str/project/release_notes_en.txt;ru_RU:/home/<USERNAME>/str/project/release_notes_ru.txt" \
    --appBasicInfo="/sample-kotlin/app-basic-info.json"

Examples

Known Huawei Publishing API Issues

List of known problems and solutions with the plugin and Huawei AppGallery API that users of the plugin have encountered:

• I use correct client_id and client_secret but get Huawei AppGallery Connect API - 403 client token authorization fail
• There is no way to publish build to open testing track in AppGallery. See issues/34
• You can't upload and publish the same version twice if you publish with submition on users first time. Second one you will get the error:

  
  Task :app:publishHuaweiAppGalleryRelease FAILED

Execution failed for task ':app:publishHuaweiAppGalleryRelease'.

Update App File Info is failed. Response: UpdateAppFileInfoResponse(ret=Ret(code=204144647, msg=[cds]update service failed, additional msg is [The new service has can't be edited service,which can't be updated!]))

* Huawei Developer Console doesn't save list of countries from previous release. To fix that just use `appBasicInfo` param with json `{"publishCountry": "BY,MD,RU,AM,AZ,GE,KZ,KG,MN,TJ,TM,UZ"}`. For more info see parameter description and [issue/41](https://github.com/cianru/huawei-appgallery-publish-gradle-plugin/issues/41).      

FAQ

License

Copyright 2020 Aleksandr Mirko

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.