Update documentation to link to Google's track name information (#191)

Bumps [word-wrap](https://github.com/jonschlinkert/word-wrap) from 1.2.3 to 1.2.4.
- [Release notes](https://github.com/jonschlinkert/word-wrap/releases)
- [Commits](https://github.com/jonschlinkert/word-wrap/compare/1.2.3...1.2.4)

---
updated-dependencies:
- dependency-name: word-wrap
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/release.yml

@@ -1,24 +1,16 @@
-name: "Tag & Deploy Action"
+name: "Update v1 tag"
 
 on:
-  push:
+  release:
-    branches:
+    types: [released]
-      - master
 
 jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2.5.0
 
-    - name: Install
+    - uses: rickstaa/action-create-tag@v1
-      run: npm ci
+      with:
-
+        tag: v1
-    - name: Run Tests
+        force_push_tag: true
-      run: npm run test
-
-    - name: Update v1 Tag
-      uses: hole19/git-tag-action@master
-      env:
-        TAG: v1
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -8,12 +8,12 @@ This action will help you upload an Android `.apk` or `.aab` (Android App Bundle
 | --- | --- | --- | --- |
 | releaseFiles | The Android release file(s) to upload (.apk or .aab) | Comma-separated paths. Supports glob via [fast-glob](https://github.com/mrmlnc/fast-glob) | true |
 | serviceAccountJsonPlainText | The service account json in plain text, provided via a secret, etc | The contents of your `service-account.json` | true (or serviceAccountJson) |
-| packageName | The package name, or Application Id, of the app you are uploading | A valid package name, e.g. `com.example.myapp` | true |
+| packageName | The package name, or Application Id, of the app you are uploading | A valid package name, e.g. `com.example.myapp`. The packageName must already exist in the play console account, so make sure you upload a manual apk or aab first through the console | true |
-| track | The track in which you want to assign the uploaded app. Defaults to `production` | One of `production`, `beta`, `alpha`, `internalsharing`, `internal`, or a custom track name (case sensitive) | true |
+| track | The track in which you want to assign the uploaded app. Defaults to `production` | See [APKs and Tracks](https://developers.google.com/android-publisher/tracks#adding_and_modifying_apks) documentation for calculating your target track name | true |
 | releaseName | The release name. Not required to be unique. Default is configured by Google Play Console | A user-friendly update name, e.g. `v1.0.0` | false |
 | inAppUpdatePriority | In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Defaults to `0` | `[0-5]`, where `5` is the highest priority | false |
-| userFraction | Percentage of users who should get the staged version of the app. Defaults to `1.0` | `[0.0-1.0]` | true |
+| userFraction | Percentage of users who should get the staged version of the app. | `(0.0-1.0)` | false |
-| status | Release status. Defaults to `completed` if targeting 100% rollout, `halted` for 0%, and `inProgress` for anything in between | One of `completed`, `inProgress`, `halted`, `draft` | false |
+| status | Release status. Defaults to `completed`. | One of `completed`, `inProgress`, `halted`, `draft`. Cannot be null. | false |
 | whatsNewDirectory | The directory of localized "whats new" files to upload as the release notes. The files contained in the `whatsNewDirectory` MUST use the pattern `whatsnew-<LOCALE>` where `LOCALE` is using the [`BCP 47`](https://tools.ietf.org/html/bcp47) format | A path to a valid `whatsNewDirectory` | false |
 | mappingFile | The mapping.txt file used to de-obfuscate your stack traces from crash reports | A path to a valid `mapping.txt` file | false |
 | debugSymbols | The native-debug-symbols.zip file or folder that contains your debug symbols | A path to a valid `native-debug-symbols.zip file` file or a folder | false |
@@ -48,6 +48,10 @@ with:
   debugSymbols: app/intermediates/merged_native_libs/release/out/lib
 ```
 
+## FAQ
+### I get the error "Package not found"
+Make sure you upload an apk or aab manually first by creating a release through the play console.
+
 The `whatsNewDirectory` in this example supplies changelogs for English, German and Japanese
 
 ```

__tests__/main.test.ts

@@ -8,6 +8,17 @@ async function expectRunInitiatesUpload(options: RunOptions) {
     expect(result.commands.errors).toContainEqual("The incoming JSON object does not contain a client_email field")
 }
 
+test("correct bare minimum inputs", async () => {
+    const minimumOptions = RunOptions.create()
+        .setInputs({
+            serviceAccountJsonPlainText: "{}",
+            packageName: "com.package.name",
+            releaseFiles: "./__tests__/releasefiles/*.aab",
+            track: "production",
+        })
+    await expectRunInitiatesUpload(minimumOptions)
+})
+
 test("correct inputs for complete rollout", async () => {
     // Run with the bare minimum
     const minimumOptions = RunOptions.create()
@@ -34,8 +45,8 @@ test("correct inputs for complete rollout", async () => {
             changesNotSentForReview: "true",
             existingEditId: "123"
         })
-        await expectRunInitiatesUpload(extraOptions)
+    await expectRunInitiatesUpload(extraOptions)
-    })
+})
 
 test("correct inputs for inProgress rollout", async () => {
     // Run with the bare minimum
@@ -48,7 +59,7 @@ test("correct inputs for inProgress rollout", async () => {
             userFraction: "0.99",
             status: "inProgress",
         })
-        await expectRunInitiatesUpload(minimumOptions)
+    await expectRunInitiatesUpload(minimumOptions)
 
     // Test with optional extras
     const extraOptions = RunOptions.create()
@@ -65,7 +76,7 @@ test("correct inputs for inProgress rollout", async () => {
             changesNotSentForReview: "true",
             existingEditId: "123"
         })
-        await expectRunInitiatesUpload(extraOptions)
+    await expectRunInitiatesUpload(extraOptions)
 })
 
 test("correct inputs for draft rollout", async () => {
@@ -78,7 +89,7 @@ test("correct inputs for draft rollout", async () => {
             track: "production",
             status: "draft",
         })
-        await expectRunInitiatesUpload(minimumOptions)
+    await expectRunInitiatesUpload(minimumOptions)
 
     // Test with optional extras
     const extraOptions = RunOptions.create()
@@ -94,5 +105,5 @@ test("correct inputs for draft rollout", async () => {
             changesNotSentForReview: "true",
             existingEditId: "123"
         })
-        await expectRunInitiatesUpload(extraOptions)
+    await expectRunInitiatesUpload(extraOptions)
-    })
+})

action.yml

@@ -36,7 +36,8 @@ inputs:
     required: false
   status:
     description: "Release status. This can be set to 'draft' to complete the release at some other time."
-    required: false
+    required: true
+    default: "completed"
   whatsNewDirectory:
     description: "The directory of localized whats new files"
     required: false

package.json

@@ -1,6 +1,6 @@
 {
   "name": "upload-google-play",
-  "version": "1.0.19",
+  "version": "1.1.2",
   "private": true,
   "description": "Upload an Android release (.apk or .aab) to Google Play Console",
   "main": "lib/index.js",
@@ -20,21 +20,22 @@
   "author": "r0adkll",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.10.0",
+    "@actions/core": "^1.10.1",
-    "@googleapis/androidpublisher": "^3.0.0",
+    "@googleapis/androidpublisher": "^8.4.0",
-    "fast-glob": "^3.2.12",
+    "fast-glob": "^3.3.1",
-    "jszip": "^3.10.1"
+    "jszip": "^3.10.1",
+    "p-timeout": "^6.1.2"
   },
   "devDependencies": {
-    "@types/jest": "^29.2.0",
+    "@types/jest": "^29.5.5",
-    "@types/node": "^18.11.4",
+    "@types/node": "^20.6.2",
-    "@typescript-eslint/eslint-plugin": "^5.40.1",
+    "@typescript-eslint/eslint-plugin": "^6.7.0",
-    "@typescript-eslint/parser": "^5.40.1",
+    "@typescript-eslint/parser": "^6.7.0",
-    "@vercel/ncc": "^0.34.0",
+    "@vercel/ncc": "^0.38.0",
-    "eslint": "^8.26.0",
+    "eslint": "^8.49.0",
-    "github-action-ts-run-api": "^2.2.2",
+    "github-action-ts-run-api": "^3.0.3",
-    "jest": "^29.2.1",
+    "jest": "^29.7.0",
-    "ts-jest": "^29.0.3",
+    "ts-jest": "^29.1.1",
-    "typescript": "^4.8.4"
+    "typescript": "^5.2.2"
   }
 }

src/edits.ts

@@ -13,14 +13,13 @@ import Apk = androidpublisher_v3.Schema$Apk;
 import Bundle = androidpublisher_v3.Schema$Bundle;
 import Track = androidpublisher_v3.Schema$Track;
 import InternalAppSharingArtifact = androidpublisher_v3.Schema$InternalAppSharingArtifact;
-import { Compute } from "google-auth-library/build/src/auth/computeclient";
+import { GoogleAuth } from "google-auth-library/build/src/auth/googleauth"
-import { JSONClient } from "google-auth-library/build/src/auth/googleauth"
 import { readLocalizedReleaseNotes } from "./whatsnew";
 
 const androidPublisher: AndroidPublisher = google.androidpublisher('v3');
 
 export interface EditOptions {
-    auth: Compute | JSONClient;
+    auth: GoogleAuth;
     applicationId: string;
     track: string;
     inAppUpdatePriority: number;
@@ -52,10 +51,8 @@ export async function runUpload(
         scopes: ['https://www.googleapis.com/auth/androidpublisher']
     });
 
-    const authClient = await auth.getClient();
-
     const result = await uploadToPlayStore({
-        auth: authClient,
+        auth: auth,
         applicationId: packageName,
         track: track,
         inAppUpdatePriority: inAppUpdatePriority || 0,
@@ -75,17 +72,16 @@ export async function runUpload(
 }
 
 async function uploadToPlayStore(options: EditOptions, releaseFiles: string[]): Promise<string | void> {
+    const internalSharingDownloadUrls: string[] = []
+    
     // Check the 'track' for 'internalsharing', if so switch to a non-track api
     if (options.track === 'internalsharing') {
         core.debug("Track is Internal app sharing, switch to special upload api")
-        const downloadUrls: string[] = []
         for (const releaseFile of releaseFiles) {
             core.debug(`Uploading ${releaseFile}`);
             const url = await uploadInternalSharingRelease(options, releaseFile)
-            downloadUrls.push(url)
+            internalSharingDownloadUrls.push(url)
         }
-        core.setOutput("internalSharingDownloadUrls", downloadUrls);
-        core.exportVariable("INTERNAL_SHARING_DOWNLOAD_URLS", downloadUrls);
     } else {
         // Create a new Edit
         const appEditId = await getOrCreateEdit(options)
@@ -96,6 +92,14 @@ async function uploadToPlayStore(options: EditOptions, releaseFiles: string[]):
         // Upload artifacts to Google Play, and store their version codes
         const versionCodes = await uploadReleaseFiles(appEditId, options, releaseFiles)
 
+        // Infer the download URL from the version codes
+        for (const versionCode of versionCodes) {
+            const url = inferInternalSharingDownloadUrl(options.applicationId, versionCode);
+            core.setOutput("internalSharingDownloadUrl", url);
+            core.exportVariable("INTERNAL_SHARING_DOWNLOAD_URL", url);      
+            internalSharingDownloadUrls.push(url);
+        }
+
         // Add the uploaded artifacts to the Edit track
         await addReleasesToTrack(appEditId, options, versionCodes);
 
@@ -117,6 +121,9 @@ async function uploadToPlayStore(options: EditOptions, releaseFiles: string[]):
             return Promise.reject(res.status);
         }
     }
+
+    core.setOutput("internalSharingDownloadUrls", internalSharingDownloadUrls);
+    core.exportVariable("INTERNAL_SHARING_DOWNLOAD_URLS", internalSharingDownloadUrls);    
 }
 
 async function uploadInternalSharingRelease(options: EditOptions, releaseFile: string): Promise<string> {
@@ -398,3 +405,10 @@ async function uploadReleaseFiles(appEditId: string, options: EditOptions, relea
 
     return versionCodes
 }
+
+function inferInternalSharingDownloadUrl(
+  applicationId: string,
+  versionCode: number
+) {
+  return `https://play.google.com/apps/test/${applicationId}/${versionCode}`;
+}

src/main.ts

@@ -1,8 +1,9 @@
-import * as core from '@actions/core';
+import * as core from '@actions/core'
-import * as fs from "fs";
+import * as fs from "fs"
-import { runUpload } from "./edits";
+import { runUpload } from "./edits"
 import { validateInAppUpdatePriority, validateReleaseFiles, validateStatus, validateUserFraction } from "./input-validation"
-import { unlink, writeFile } from 'fs/promises';
+import { unlink, writeFile } from 'fs/promises'
+import pTimeout from 'p-timeout'
 
 export async function run() {
     try {
@@ -12,7 +13,7 @@ export async function run() {
         const releaseFile = core.getInput('releaseFile', { required: false });
         const releaseFiles = core.getInput('releaseFiles', { required: false })
             ?.split(',')
-            ?.filter(x => x !== '') || [];
+            ?.filter(x => x !== '');
         const releaseName = core.getInput('releaseName', { required: false });
         const track = core.getInput('track', { required: true });
         const inAppUpdatePriority = core.getInput('inAppUpdatePriority', { required: false });
@@ -54,33 +55,35 @@ export async function run() {
         const validatedReleaseFiles: string[] = await validateReleaseFiles(releaseFiles ?? [releaseFile])
 
         if (whatsNewDir != undefined && whatsNewDir.length > 0 && !fs.existsSync(whatsNewDir)) {
-            core.setFailed(`Unable to find 'whatsnew' directory @ ${whatsNewDir}`);
+            core.warning(`Unable to find 'whatsnew' directory @ ${whatsNewDir}`);
-            return
         }
 
         if (mappingFile != undefined && mappingFile.length > 0 && !fs.existsSync(mappingFile)) {
-            core.setFailed(`Unable to find 'mappingFile' @ ${mappingFile}`);
+            core.warning(`Unable to find 'mappingFile' @ ${mappingFile}`);
-            return
         }
 
         if (debugSymbols != undefined && debugSymbols.length > 0 && !fs.existsSync(debugSymbols)) {
-            core.setFailed(`Unable to find 'debugSymbols' @ ${debugSymbols}`);
+            core.warning(`Unable to find 'debugSymbols' @ ${debugSymbols}`);
-            return
         }
 
-        await runUpload(
+        await pTimeout(
-            packageName,
+            runUpload(
-            track,
+                packageName,
-            inAppUpdatePriorityInt,
+                track,
-            userFractionFloat,
+                inAppUpdatePriorityInt,
-            whatsNewDir,
+                userFractionFloat,
-            mappingFile,
+                whatsNewDir,
-            debugSymbols,
+                mappingFile,
-            releaseName,
+                debugSymbols,
-            changesNotSentForReview,
+                releaseName,
-            existingEditId,
+                changesNotSentForReview,
-            status,
+                existingEditId,
-            validatedReleaseFiles
+                status,
+                validatedReleaseFiles
+            ),
+            {
+                milliseconds: 3.6e+6
+            }
         )
     } catch (error: unknown) {
         if (error instanceof Error) {