Merge pull request #45 from boswelja/name-output-improvements

Name output improvements

README.md

@@ -18,9 +18,14 @@ The service account json in plain text, provided via a secret, etc.
 
 **Required:** The package name, or Application Id, of the app you are uploading
 
-### `releaseFiles`
+### `releaseFile`
+**DEPRECATED:** Please switch to using `releaseFiles` as this will be removed in the future  
+The Android release file to upload (.apk or .aab) 
 
-**Required:** The Android release file(s) to upload (.apk or .aab). Multiple files are separated by ','.
+### `releaseFiles`
+**CAVEAT:** Either this or `releaseFile` are required  
+
+The Android release file(s) to upload (.apk or .aab). Multiple files are separated by ','.
 
 ### `releaseName`
 
@@ -29,14 +34,14 @@ The release name. Not required to be unique. If not set, the name is generated f
 ### `track`
 
 **Required:** The track in which you want to assign the uploaded app.  
-**Default:** `production`  
+**Default:** `production`   
 _Values:_ `alpha`, `beta`, `internal`, `production`, `internalsharing`
 
 ### `inAppUpdatePriority`
 
 In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority.
 
-**Default:** `0`
+**Default:** `0`  
 _Values:_ `[0, 5]`
 
 ### `userFraction`
@@ -67,6 +72,10 @@ The mapping.txt file used to de-obfuscate your stack traces from crash reports
 
 ## Outputs
 
+### `releaseName`
+
+The name of the release published to Google Play, which is generated on commit by default
+
 ### `internalSharingDownloadUrl`
 
 The download url for an app that was uploaded using the `track` `internalsharing`

action.yml

@@ -1,41 +1,44 @@
 name: 'Upload Android Release to Play Store'
-description: 'An action to upload a signed Android release (.apk or .aab) to the Google Play Store Developer Console'
+description: "An action to upload a signed Android release (.apk or .aab) to the Google Play Store Developer Console"
 author: 'r0adkll'
 branding:
   icon: 'truck'
   color: 'orange'
 inputs:
   serviceAccountJson:
-    description: 'The service account json private key file to authorize the upload request'
+    description: "The service account json private key file to authorize the upload request"
     required: false
   serviceAccountJsonPlainText:
-    description: 'The raw json text of the service account private key to authorize the upload request'
+    description: "The raw json text of the service account private key to authorize the upload request"
     required: false
   packageName:
-    description: 'The package name, or Application Id, of the app you are uploading'
+    description: "The package name, or Application Id, of the app you are uploading"
     required: true
+  releaseFile:
+    description: "The Android release file to upload (.apk or .aab)"
+    required: false
   releaseFiles:
     description: "The Android release file(s) to upload (.apk or .aab). Separated by  a ',' for multiple artifacts"
-    required: true
+    required: false
   releaseName:
-    description: 'The name of this release. If not set it's generated automatically from the APKs versionName'
+    description: "The name of this release. If not set it's generated automatically from the APKs versionName"
     required: false
   track:
-    description: 'The track in which you want to assign the uploaded app.'
+    description: "The track in which you want to assign the uploaded app."
     default: 'production'
     required: true
   inAppUpdatePriority:
-    description: 'In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0.'
+    description: "In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0."
     default: '0'
     required: false
   userFraction:
-    description: 'Portion of users who should get the staged version of the app. Accepts values between 0.0 and 1.0 (exclusive-exclusive).'
+    description: "Portion of users who should get the staged version of the app. Accepts values between 0.0 and 1.0 (exclusive-exclusive)."
     required: false
   whatsNewDirectory:
-    description: 'The directory of localized whats new files'
+    description: "The directory of localized whats new files"
     required: false
   mappingFile:
-    description: 'The mapping.txt file used to de-obfuscate your stack traces from crash reports'
+    description: "The mapping.txt file used to de-obfuscate your stack traces from crash reports"
     required: false
 outputs:
   internalSharingDownloadUrl:

lib/edits.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
@@ -80,6 +80,8 @@ function uploadToPlayStore(options, releaseFiles) {
             // Simple check to see whether commit was successful
             if (res.data.id != null) {
                 core.debug(`Successfully committed ${res.data.id}`);
+                const name = options.name || (yield getPublishedReleaseName(res.data, options));
+                core.setOutput("releaseName", name);
                 return Promise.resolve(res.data.id);
             }
             else {
@@ -249,3 +251,13 @@ function uploadBundle(appEdit, options, bundleReleaseFile) {
         return res.data;
     });
 }
+function getPublishedReleaseName(appEdit, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const track = yield androidPublisher.edits.tracks.get({
+            editId: appEdit.id,
+            track: options.track
+        });
+        const release = track.data.releases[0]; // We only ever create one release, so grab the first one
+        return release.name;
+    });
+}

lib/main.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
@@ -36,12 +36,14 @@ const auth = new google.auth.GoogleAuth({
     scopes: ['https://www.googleapis.com/auth/androidpublisher']
 });
 function run() {
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const serviceAccountJson = core.getInput('serviceAccountJson', { required: false });
             const serviceAccountJsonRaw = core.getInput('serviceAccountJsonPlainText', { required: false });
             const packageName = core.getInput('packageName', { required: true });
-            const releaseFiles = core.getInput('releaseFiles', { required: true }).split(',').filter(x => x !== '');
+            const releaseFile = core.getInput('releaseFile', { required: false });
+            const releaseFiles = ((_b = (_a = core.getInput('releaseFiles', { required: false })) === null || _a === void 0 ? void 0 : _a.split(',')) === null || _b === void 0 ? void 0 : _b.filter(x => x !== '')) || [];
             const releaseName = core.getInput('releaseName', { required: false });
             const track = core.getInput('track', { required: true });
             const inAppUpdatePriority = core.getInput('inAppUpdatePriority', { required: false });
@@ -52,6 +54,7 @@ function run() {
             if (!serviceAccountJson && !serviceAccountJsonRaw) {
                 console.log("No service account json key provided!");
                 core.setFailed("You must provide one of 'serviceAccountJson' or 'serviceAccountJsonPlainText' to use this action");
+                return;
             }
             // If the user has provided the raw plain text via secrets, or w/e, then write to file and
             // set appropriate env variable for the auth
@@ -80,7 +83,7 @@ function run() {
             }
             // Validate the inAppUpdatePriority to be a valid number in within [0, 5]
             let inAppUpdatePriorityInt = parseInt(inAppUpdatePriority);
-            if (~isNaN(inAppUpdatePriorityInt)) {
+            if (!isNaN(inAppUpdatePriorityInt)) {
                 if (inAppUpdatePriorityInt < 0 || inAppUpdatePriorityInt > 5) {
                     core.setFailed('inAppUpdatePriority must be between 0 and 5, inclusive-inclusive');
                     return;
@@ -89,13 +92,32 @@ function run() {
             else {
                 inAppUpdatePriorityInt = undefined;
             }
-            // Check release files
-            for (const releaseFile of releaseFiles) {
+            // Check release files while maintaining backward compatibility
+            let validatedReleaseFiles = [];
+            if (releaseFiles.length == 0 && !releaseFile) {
+                core.setFailed(`You must provide either 'releaseFile' or 'releaseFiles' in your configuration.`);
+                return;
+            }
+            else if (releaseFiles.length == 0 && releaseFile) {
+                core.warning(`WARNING!! 'releaseFile' is deprecated and will be removed in a future release. Please migrate to 'releaseFiles'.`);
                 core.debug(`Validating ${releaseFile} exists`);
                 if (!fs.existsSync(releaseFile)) {
                     core.setFailed(`Unable to find release file @ ${releaseFile}`);
                     return;
                 }
+                else {
+                    validatedReleaseFiles = [releaseFile];
+                }
+            }
+            else if (releaseFiles.length > 0) {
+                for (const file of releaseFiles) {
+                    core.debug(`Validating ${file} exists`);
+                    if (!fs.existsSync(file)) {
+                        core.setFailed(`Unable to find release file @ ${file}`);
+                        return;
+                    }
+                }
+                validatedReleaseFiles = releaseFiles;
             }
             if (whatsNewDir != undefined && whatsNewDir.length > 0 && !fs.existsSync(whatsNewDir)) {
                 core.setFailed(`Unable to find 'whatsnew' directory @ ${whatsNewDir}`);
@@ -115,7 +137,7 @@ function run() {
                 whatsNewDir: whatsNewDir,
                 mappingFile: mappingFile,
                 name: releaseName
-            }, releaseFiles);
+            }, validatedReleaseFiles);
             console.log(`Finished uploading to the Play Store`);
         }
         catch (error) {

lib/whatsnew.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };

src/edits.ts

@@ -77,6 +77,8 @@ export async function uploadToPlayStore(options: EditOptions, releaseFiles: stri
         // Simple check to see whether commit was successful
         if (res.data.id != null) {
             core.debug(`Successfully committed ${res.data.id}`);
+            const name = options.name || (await getPublishedReleaseName(res.data, options));
+            core.setOutput("releaseName", name)
             return Promise.resolve(res.data.id!);
         } else {
             core.setFailed(`Error ${res.status}: ${res.statusText}`);
@@ -238,3 +240,12 @@ async function uploadBundle(appEdit: AppEdit, options: EditOptions, bundleReleas
 
     return res.data
 }
+
+async function getPublishedReleaseName(appEdit: AppEdit, options: EditOptions): Promise<String | null | undefined> {
+    const track = await androidPublisher.edits.tracks.get({
+        editId: appEdit.id!,
+        track: options.track
+    })
+    const release = track.data.releases![0] // We only ever create one release, so grab the first one
+    return release.name
+}

src/main.ts

@@ -12,7 +12,10 @@ async function run() {
         const serviceAccountJson = core.getInput('serviceAccountJson', { required: false });
         const serviceAccountJsonRaw = core.getInput('serviceAccountJsonPlainText', { required: false});
         const packageName = core.getInput('packageName', { required: true });
-        const releaseFiles = core.getInput('releaseFiles', { required: true }).split(',').filter(x => x !== '');
+        const releaseFile = core.getInput('releaseFile', { required: false });
+        const releaseFiles = core.getInput('releaseFiles', { required: false })
+            ?.split(',')
+            ?.filter(x => x !== '') || [];
         const releaseName = core.getInput('releaseName', { required: false });
         const track = core.getInput('track', { required: true });
         const inAppUpdatePriority = core.getInput('inAppUpdatePriority', { required: false });
@@ -24,6 +27,7 @@ async function run() {
         if (!serviceAccountJson && !serviceAccountJsonRaw) {
             console.log("No service account json key provided!");
             core.setFailed("You must provide one of 'serviceAccountJson' or 'serviceAccountJsonPlainText' to use this action");
+            return;
         }
 
         // If the user has provided the raw plain text via secrets, or w/e, then write to file and
@@ -56,7 +60,7 @@ async function run() {
 
         // Validate the inAppUpdatePriority to be a valid number in within [0, 5]
         let inAppUpdatePriorityInt: number | undefined = parseInt(inAppUpdatePriority);
-        if (~isNaN(inAppUpdatePriorityInt)) {
+        if (!isNaN(inAppUpdatePriorityInt)) {
             if (inAppUpdatePriorityInt < 0 || inAppUpdatePriorityInt > 5) {
                 core.setFailed('inAppUpdatePriority must be between 0 and 5, inclusive-inclusive');
                 return;
@@ -65,13 +69,29 @@ async function run() {
             inAppUpdatePriorityInt = undefined;
         }
 
-        // Check release files
-        for (const releaseFile of releaseFiles) {
+        // Check release files while maintaining backward compatibility
+        let validatedReleaseFiles: string[] = [];
+        if (releaseFiles.length == 0 && !releaseFile) {
+            core.setFailed(`You must provide either 'releaseFile' or 'releaseFiles' in your configuration.`);
+            return;
+        } else if (releaseFiles.length == 0 && releaseFile) {
+            core.warning(`WARNING!! 'releaseFile' is deprecated and will be removed in a future release. Please migrate to 'releaseFiles'.`);
             core.debug(`Validating ${releaseFile} exists`)
             if (!fs.existsSync(releaseFile)) {
                 core.setFailed(`Unable to find release file @ ${releaseFile}`);
-                return
+                return;
+            } else {
+                validatedReleaseFiles = [releaseFile];
             }
+        } else if (releaseFiles.length > 0) {
+            for (const file of releaseFiles) {
+                core.debug(`Validating ${file} exists`)
+                if (!fs.existsSync(file)) {
+                    core.setFailed(`Unable to find release file @ ${file}`);
+                    return;
+                }
+            }
+            validatedReleaseFiles = releaseFiles;
         }
 
         if (whatsNewDir != undefined && whatsNewDir.length > 0 && !fs.existsSync(whatsNewDir)) {
@@ -95,7 +115,7 @@ async function run() {
             whatsNewDir: whatsNewDir,
             mappingFile: mappingFile,
             name: releaseName
-        }, releaseFiles);
+        }, validatedReleaseFiles);
 
         console.log(`Finished uploading to the Play Store`)
     } catch (error) {