Update script with skipPrompts option (#6294)

Author: hsubox76

.github/workflows/release-staging.yml

@@ -45,19 +45,6 @@ jobs:
       uses: changesets/action@v1
       env:
         GITHUB_TOKEN: ${{ secrets.OSS_BOT_GITHUB_TOKEN }}
-    - name: Get release version
-      id: get-version
-      # STAGING_VERSION = version with staging hash, e.g. 1.2.3-20430523
-      # BASE_VERSION = version without staging hash, e.g. 1.2.3
-      run: |
-        VERSION_SCRIPT="const pkg = require('./packages/firebase/package.json'); console.log(pkg.version);"
-        VERSION=`node -e "${VERSION_SCRIPT}"`
-        echo "::set-output name=STAGING_VERSION::$VERSION"
-        BASE_VERSION=$(echo ${{ steps.get-version.outputs.STAGING_VERSION }} | cut -d "-" -f 1)
-        echo "::set-output name=BASE_VERSION::$BASE_VERSION"
-    - name: Echo version in shell
-      run: |
-        echo "Staging release ${{ steps.get-version.outputs.STAGING_VERSION }}"
     - name: Publish to NPM
       # --skipTests No need to run tests
       # --skipReinstall Yarn install has already been run
@@ -116,6 +103,19 @@ jobs:
         NPM_TOKEN_APP_CHECK_COMPAT: ${{ secrets.NPM_TOKEN_APP_CHECK_COMPAT }}
         NPM_TOKEN_API_DOCUMENTER: ${{ secrets.NPM_TOKEN_API_DOCUMENTER }}
         CI: true
+    - name: Get release version
+      id: get-version
+      # STAGING_VERSION = version with staging hash, e.g. 1.2.3-20430523
+      # BASE_VERSION = version without staging hash, e.g. 1.2.3
+      run: |
+        VERSION_SCRIPT="const pkg = require('./packages/firebase/package.json'); console.log(pkg.version);"
+        VERSION=`node -e "${VERSION_SCRIPT}"`
+        echo "::set-output name=STAGING_VERSION::$VERSION"
+        BASE_VERSION=$(echo ${{ steps.get-version.outputs.STAGING_VERSION }} | cut -d "-" -f 1)
+        echo "::set-output name=BASE_VERSION::$BASE_VERSION"
+    - name: Echo version in shell
+      run: |
+        echo "Staging release ${{ steps.get-version.outputs.STAGING_VERSION }}"
     - name: Launch E2E tests workflow
       # Trigger e2e-test.yml
       run: |

scripts/release/cli.ts

@@ -43,11 +43,17 @@ yargs
         default: false
       },
       releaseType: {
-        type: 'string'
+        type: 'string',
+        desc: '"Staging" or "Production" - this is case sensitive!'
       },
       dryRun: {
         type: 'boolean',
         default: false
+      },
+      skipPrompts: {
+        type: 'boolean',
+        default: false,
+        desc: 'Skip all interactive prompts (needed if running in CI)'
       }
     },
     argv => runRelease(argv)

scripts/release/release.ts

@@ -35,14 +35,16 @@ interface releaseOptions {
   ignoreUnstaged: boolean;
   releaseType?: string;
   dryRun?: boolean;
+  skipPrompts: boolean;
 }
 
 export async function runRelease({
   skipReinstall,
   skipTests,
   ignoreUnstaged,
   releaseType: inputReleaseType,
-  dryRun
+  dryRun,
+  skipPrompts
 }: releaseOptions) {
   try {
     /**
@@ -88,21 +90,25 @@ export async function runRelease({
       return responses.releaseType;
     })();
 
+    console.log(`Publishing ${inputReleaseType} release.`);
+
     /**
      * Bump versions for staging release
      * NOTE: For prod, versions are bumped in a PR which should be merged before running this script
      */
     if (releaseType === ReleaseType.Staging) {
       const updatedPackages = await bumpVersionForStaging();
 
-      // We don't need to validate versions for prod releases because prod releases
-      // are validated in the version bump PR which should be merged before running this script
-      const { versionCheck } = await prompt([
-        validateVersions(updatedPackages)
-      ]);
+      if (!skipPrompts) {
+        // We don't need to validate versions for prod releases because prod releases
+        // are validated in the version bump PR which should be merged before running this script
+        const { versionCheck } = await prompt([
+          validateVersions(updatedPackages)
+        ]);
 
-      if (!versionCheck) {
-        throw new Error('Version check failed');
+        if (!versionCheck) {
+          throw new Error('Version check failed');
+        }
       }
     }