Skip to content

Commit

Permalink
Documentation for v2.3 (#589)
Browse files Browse the repository at this point in the history 
Signed-off-by: Alex Saveau <[email protected]>
  • Loading branch information
@SUPERCILEX
SUPERCILEX authored Jul 13, 2019
1 parent 8ab46b2 commit a922e80
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 38 deletions.
65 changes: 43 additions & 22 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@
</a>
</p>

Gradle Play Publisher is a Gradle plugin that allows you to upload your App Bundle or APK and other
app details to the Google Play Store.
Gradle Play Publisher is Android's unofficial release automation Gradle Plugin. It can do anything
from building, uploading, and then promoting your App Bundle or APK to publishing app listings and
other metadata.

## Table of contents

Expand All @@ -33,6 +34,7 @@ app details to the Google Play Store.
1. [Common configuration](#common-configuration)
1. [Publishing an App Bundle](#publishing-an-app-bundle)
1. [Publishing APKs](#publishing-apks)
1. [Uploading an Internal Sharing artifact](#uploading-an-internal-sharing-artifact)
1. [Promoting artifacts](#promoting-artifacts)
1. [Handling version conflicts](#handling-version-conflicts)
1. [Managing Play Store metadata](#managing-play-store-metadata)
Expand Down Expand Up @@ -68,9 +70,9 @@ changes, GPP may be used.

### Signing configuration

If no publishing tasks were created, you most likely haven't added a valid signing configuration to
your release builds. Be sure to
[add one](https://developer.android.com/studio/publish/app-signing#gradle-sign).
To successfully upload apps to the Play Store, they must be signed with your developer key. Make
sure you have
[a valid signing configuration](https://developer.android.com/studio/publish/app-signing#gradle-sign).

### Service Account

Expand Down Expand Up @@ -185,12 +187,18 @@ GPP follows the Android Gradle Plugin's naming convention: `[action][Variant][Th
Lifecycle tasks to publish multiple product flavors at once are also available. For example,
`publishBundle` publishes all variants.

To find available tasks, run `./gradlew tasks` and look under the publishing section.
To find available tasks, run `./gradlew tasks --group publishing` and use
`./gradlew help --task [task]` where `task` is something like `publishBundle` to get more detailed
documentation for a specific task.

> Note: if a task conflict occurs, say with the `maven-publish` plugin for example, be sure to apply
> the GPP plugin _last_. Conflicting tasks will then be prefixed with `gpp` (ex: `publish` ->
> `gppPublish`).
## Managing artifacts

GPP supports uploading both the App Bundle and APK. Once uploaded, GPP also supports promoting those
artifacts.
artifacts to different tracks.

### Common configuration

Expand All @@ -209,10 +217,12 @@ Example configuration:

```kt
play {
// ...
// Overrides defaults
track = "production"
userFraction = 0.5
releaseStatus = "inProgress"

// ...
}
```

Expand Down Expand Up @@ -250,15 +260,18 @@ a custom release name for the alpha track in the `play/release-names/alpha.txt`
My custom release name
```

There is also a `--release-name` CLI option for quick access. For example,
`./gradlew publishBundle --release-name "Hello World!"`.

> Note: the Play Store limits your release names to a maximum of 50 characters.
#### Uploading a pre-existing artifact

By default GPP will rebuild your project before every release. In advanced use cases, this might not
be the desired behavior. For example, if you need to inject translations into your APK or App Bundle
_after_ building it but _before_ publishing it. Or maybe it's a simple as you already having an
artifact you want to publish. GPP supports this class of use cases by letting you specify a
directory in which publishable artifacts may be found:
after building it but before publishing it. Or perhaps you simply already have an artifact you wish
to publish. GPP supports this class of use cases by letting you specify a directory in which
publishable artifacts may be found:

```kt
play {
Expand Down Expand Up @@ -295,6 +308,12 @@ play {

Run `./gradlew publishApk`. Splits will be uploaded if available.

### Uploading an Internal Sharing artifact

Run `./gradlew uploadReleasePrivateBundle` for App Bundles and `./gradlew uploadReleasePrivateApk`
for APKs. To upload an existing artifact, read about
[how to do so](#uploading-a-pre-existing-artifact).

### Promoting artifacts

Existing releases can be promoted and/or updated to the [configured track](#common-configuration)
Expand Down Expand Up @@ -362,6 +381,8 @@ descriptions to in-app purchases and subscriptions.
GPP includes a bootstrap task that pulls down your existing listing and initializes everything for
you. To use it, run `./gradlew bootstrap`.

> Note: if you have a pre-existing `play` folder, it will be reset.
### Directory structure

GPP follows the Android Gradle Plugin's source set
Expand Down Expand Up @@ -411,17 +432,17 @@ for the same media type. While file names are arbitrary, they will be uploaded i
and presented on the Play Store as such. Therefore, we recommend using a number as the file name
(`1.png` for example). Both PNG and JPEG images are supported.

Directory | Max # of images
--- | ---
`icon` | 1
`feature-graphic` | 1
`promo-graphic` | 1
`phone-screenshots` | 8
`tablet-screenshots` | 8
`large-tablet-screenshots` | 8
`tv-banner` | 1
`tv-screenshots` | 8
`wear-screenshots` | 8
Directory | Max # of images | Image dimension constraints (px)
--- | --- | ---
`icon` | 1 | 512x512
`feature-graphic` | 1 | 1024x500
`promo-graphic` | 1 | 180x120
`phone-screenshots` | 8 | [320..3840]x[320..3840]
`tablet-screenshots` | 8 | [320..3840]x[320..3840]
`large-tablet-screenshots` | 8 | [320..3840]x[320..3840]
`tv-banner` | 1 | 1280x720
`tv-screenshots` | 8 | [320..3840]x[320..3840]
`wear-screenshots` | 8 | [320..3840]x[320..3840]

### Publishing in-app products

Expand Down
48 changes: 32 additions & 16 deletions plugin/src/main/kotlin/com/github/triplet/gradle/play/PlayPublisherPlugin.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,37 +54,44 @@ class PlayPublisherPlugin : Plugin<Project> {

val bootstrapAllTask = project.newTask<BootstrapLifecycleTask>(
"bootstrap",
"Downloads the Play Store listing metadata for all variants.",
"Downloads the Play Store listing metadata for all variants. See " +
"https://github.com/Triple-T/gradle-play-publisher#quickstart",
arrayOf(bootstrapOptionsHolder)
)
val publishAllTask = project.newTask<GlobalPublishableArtifactLifecycleTask>(
"publish",
"Uploads APK or App Bundle and all Play Store metadata for every variant.",
"Uploads APK or App Bundle and all Play Store metadata for every variant. See " +
"https://github.com/Triple-T/gradle-play-publisher#managing-artifacts",
arrayOf(baseExtension)
)
val publishApkAllTask = project.newTask<PublishableTrackLifecycleTask>(
"publishApk",
"Uploads APK for every variant.",
"Uploads APK for every variant. See " +
"https://github.com/Triple-T/gradle-play-publisher#publishing-apks",
arrayOf(baseExtension, transientTrackOptionsHolder)
)
val publishBundleAllTask = project.newTask<PublishableTrackLifecycleTask>(
"publishBundle",
"Uploads App Bundle for every variant.",
"Uploads App Bundle for every variant. See " +
"https://github.com/Triple-T/gradle-play-publisher#publishing-an-app-bundle",
arrayOf(baseExtension, transientTrackOptionsHolder)
)
val promoteReleaseAllTask = project.newTask<UpdatableTrackLifecycleTask>(
"promoteArtifact",
"Promotes a release for every variant.",
"Promotes a release for every variant. See " +
"https://github.com/Triple-T/gradle-play-publisher#promoting-artifacts",
arrayOf(baseExtension, transientTrackOptionsHolder)
)
val publishListingAllTask = project.newTask<WriteTrackLifecycleTask>(
"publishListing",
"Uploads all Play Store metadata for every variant.",
"Uploads all Play Store metadata for every variant. See " +
"https://github.com/Triple-T/gradle-play-publisher#publishing-listings",
arrayOf(baseExtension)
)
val publishProductsAllTask = project.newTask(
"publishProducts",
"Uploads all Play Store in-app products for every variant."
"Uploads all Play Store in-app products for every variant. See " +
"https://github.com/Triple-T/gradle-play-publisher#publishing-in-app-products"
)

val android = project.the<AppExtension>()
Expand Down Expand Up @@ -139,7 +146,8 @@ class PlayPublisherPlugin : Plugin<Project> {

val bootstrapTask = project.newTask<Bootstrap>(
"bootstrap$variantName",
"Downloads the Play Store listing metadata for variant '$name'.",
"Downloads the Play Store listing metadata for variant '$name'. See " +
"https://github.com/Triple-T/gradle-play-publisher#quickstart",
arrayOf(extension, this, bootstrapOptionsHolder)
)
bootstrapAllTask { dependsOn(bootstrapTask) }
Expand All @@ -161,7 +169,8 @@ class PlayPublisherPlugin : Plugin<Project> {

val publishListingTask = project.newTask<PublishListing>(
"publish${variantName}Listing",
"Uploads all Play Store metadata for variant '$name'.",
"Uploads all Play Store metadata for variant '$name'. See " +
"https://github.com/Triple-T/gradle-play-publisher#publishing-listings",
arrayOf(extension, this)
) { resDir.set(resourceDir) }
publishListingAllTask { dependsOn(publishListingTask) }
Expand All @@ -173,7 +182,8 @@ class PlayPublisherPlugin : Plugin<Project> {

val publishProductsTask = project.newTask<PublishProducts>(
"publish${variantName}Products",
"Uploads all Play Store in-app products for variant '$name'.",
"Uploads all Play Store in-app products for variant '$name'. See " +
"https://github.com/Triple-T/gradle-play-publisher#publishing-in-app-products",
arrayOf(extension, this)
) { resDir.set(resourceDir) }
publishProductsAllTask { dependsOn(publishProductsTask) }
Expand All @@ -197,7 +207,8 @@ class PlayPublisherPlugin : Plugin<Project> {
}
val publishApkTask = project.newTask<PublishApk>(
"publish${variantName}Apk",
"Uploads APK for variant '$name'.",
"Uploads APK for variant '$name'. See " +
"https://github.com/Triple-T/gradle-play-publisher#publishing-apks",
arrayOf(extension, this, transientTrackOptionsHolder)
) {
resDir.set(resourceDir)
Expand All @@ -214,7 +225,8 @@ class PlayPublisherPlugin : Plugin<Project> {

project.newTask<PublishInternalSharingApk>(
"upload${variantName}PrivateApk",
"Uploads Internal Sharing APK for variant '$name'.",
"Uploads Internal Sharing APK for variant '$name'. See " +
"https://github.com/Triple-T/gradle-play-publisher#uploading-an-internal-sharing-artifact",
arrayOf(extension, this)
) { dependsOn(publishApkTaskDependenciesHack) }

Expand All @@ -236,7 +248,8 @@ class PlayPublisherPlugin : Plugin<Project> {
}
val publishBundleTask = project.newTask<PublishBundle>(
"publish${variantName}Bundle",
"Uploads App Bundle for variant '$name'.",
"Uploads App Bundle for variant '$name'. See " +
"https://github.com/Triple-T/gradle-play-publisher#publishing-an-app-bundle",
arrayOf(extension, this, transientTrackOptionsHolder)
) {
resDir.set(resourceDir)
Expand All @@ -248,13 +261,15 @@ class PlayPublisherPlugin : Plugin<Project> {

project.newTask<PublishInternalSharingBundle>(
"upload${variantName}PrivateBundle",
"Uploads Internal Sharing App Bundle for variant '$name'.",
"Uploads Internal Sharing App Bundle for variant '$name'. See " +
"https://github.com/Triple-T/gradle-play-publisher#uploading-an-internal-sharing-artifact",
arrayOf(extension, this)
) { dependsOn(publishBundleTaskDependenciesHack) }

val promoteReleaseTask = project.newTask<PromoteRelease>(
"promote${variantName}Artifact",
"Promotes a release for variant '$name'.",
"Promotes a release for variant '$name'. See " +
"https://github.com/Triple-T/gradle-play-publisher#promoting-artifacts",
arrayOf(extension, this, transientTrackOptionsHolder)
) {
resDir.set(resourceDir)
Expand All @@ -265,7 +280,8 @@ class PlayPublisherPlugin : Plugin<Project> {

val publishTask = project.newTask<GlobalPublishableArtifactLifecycleTask>(
"publish$variantName",
"Uploads APK or App Bundle and all Play Store metadata for variant '$name'.",
"Uploads APK or App Bundle and all Play Store metadata for variant '$name'. See " +
"https://github.com/Triple-T/gradle-play-publisher#managing-artifacts",
arrayOf(extension)
) {
dependsOn(if (extension.defaultToAppBundles) publishBundleTask else publishApkTask)
Expand Down

0 comments on commit a922e80

Please sign in to comment.