fix: remove unnecessary check and update documentation (#2)

refactor code to stop creating an empty action.
refactor code to move deploy code to stand alone methods.
change log severity to report errors.
add extra info logs to improve verbosity of the action.

Author: minherz

src/createCheck.ts

@@ -15,14 +15,20 @@
  */
 
 import { fileSync } from "tmp";
-import { writeSync } from "fs";
+import { writeSync, existsSync } from "fs";
 
 // Set up Google Application Credentials for use by the Firebase CLI
 // https://cloud.google.com/docs/authentication/production#finding_credentials_automatically
 export async function createGacFile(googleApplicationCredentials: string) {
+  try {
+    if (existsSync(googleApplicationCredentials)) {
+      return googleApplicationCredentials;
+    }
+  }
+  catch (e) {
+    // googleApplicationCredentials is not a path to a file
+  }
   const tmpFile = fileSync({ postfix: ".json" });
-
   writeSync(tmpFile.fd, googleApplicationCredentials);
-
   return tmpFile.name;
 }

src/createGACFile.ts

@@ -23,7 +23,6 @@ import {
 } from "@actions/core";
 import { context, getOctokit } from "@actions/github";
 import { existsSync } from "fs";
-import { createCheck } from "./createCheck";
 import { createGacFile } from "./createGACFile";
 import {
   deployPreview,
@@ -44,21 +43,13 @@ const googleApplicationCredentials = getInput("firebaseServiceAccount", {
   required: true,
 });
 const configuredChannelId = getInput("channelId");
-const isProductionDeploy = configuredChannelId === "live";
 const token = process.env.GITHUB_TOKEN || getInput("repoToken");
 const octokit = token ? getOctokit(token) : undefined;
 const entryPoint = getInput("entryPoint");
 const target = getInput("target");
 const firebaseToolsVersion = getInput("firebaseToolsVersion");
 
 async function run() {
-  const isPullRequest = !!context.payload.pull_request;
-
-  let finish = (details: Object) => console.log(details);
-  if (token && isPullRequest) {
-    finish = await createCheck(octokit, context);
-  }
-
   try {
     startGroup("Verifying firebase.json exists");
 
@@ -74,96 +65,93 @@ async function run() {
     if (existsSync("./firebase.json")) {
       console.log("firebase.json file found. Continuing deploy.");
     } else {
-      throw Error(
-        "firebase.json file not found. If your firebase.json file is not in the root of your repo, edit the entryPoint option of this GitHub action."
-      );
+      console.warn("firebase.json file not found. If your firebase.json file is not in the root of your repo, edit the entryPoint option of this GitHub action.");
     }
     endGroup();
 
     startGroup("Setting up CLI credentials");
     const gacFilename = await createGacFile(googleApplicationCredentials);
-    console.log(
-      "Created a temporary file with Application Default Credentials."
-    );
+    if (gacFilename != googleApplicationCredentials) {
+      console.log(
+        "Created a temporary file with Application Default Credentials."
+      );
+    }
     endGroup();
 
-    if (isProductionDeploy) {
+    if (configuredChannelId === "live") {
       startGroup("Deploying to production site");
-      const deployment = await deployProductionSite(gacFilename, {
-        projectId,
-        target,
-        firebaseToolsVersion,
-      });
-      if (deployment.status === "error") {
-        throw Error((deployment as ErrorResult).error);
-      }
+      await deployToProduction(gacFilename);
+      endGroup();
+    } else {
+      const channelId = getChannelId(configuredChannelId, context);
+      startGroup(`Deploying to Firebase preview channel ${channelId}`);
+      await deployToPreviewChannel(gacFilename, channelId);
       endGroup();
-
-      const hostname = target ? `${target}.web.app` : `${projectId}.web.app`;
-      const url = `https://${hostname}/`;
-      await finish({
-        details_url: url,
-        conclusion: "success",
-        output: {
-          title: `Production deploy succeeded`,
-          summary: `[${hostname}](${url})`,
-        },
-      });
-      return;
-    }
-
-    const channelId = getChannelId(configuredChannelId, context);
-
-    startGroup(`Deploying to Firebase preview channel ${channelId}`);
-    const deployment = await deployPreview(gacFilename, {
-      projectId,
-      expires,
-      channelId,
-      target,
-      firebaseToolsVersion,
-    });
-
-    if (deployment.status === "error") {
-      throw Error((deployment as ErrorResult).error);
     }
-    endGroup();
-
-    const { expireTime, urls } = interpretChannelDeployResult(deployment);
+  } catch (e) {
+    setFailed(e.message);
+  }
+  return undefined;
+}
 
-    setOutput("urls", urls);
-    setOutput("expire_time", expireTime);
-    setOutput("details_url", urls[0]);
+async function deployToProduction(gacFilePath: string) {
+  const deployment = await deployProductionSite(gacFilePath, {
+    projectId,
+    target,
+    firebaseToolsVersion,
+  });
+  if (deployment.status === "error") {
+    throw Error((deployment as ErrorResult).error);
+  }
+  const hostname = target ? `${target}.web.app` : `${projectId}.web.app`;
+  const url = `https://${hostname}/`;
+  console.log({
+    details_url: url,
+    conclusion: "success",
+    output: {
+      title: `Production deploy succeeded`,
+      summary: `[${hostname}](${url})`,
+    },
+  });
+  return undefined;
+}
 
-    const urlsListMarkdown =
-      urls.length === 1
-        ? `[${urls[0]}](${urls[0]})`
-        : urls.map((url) => `- [${url}](${url})`).join("\n");
+async function deployToPreviewChannel(gacFilePath: string, channelId: string) {
+  const deployment = await deployPreview(gacFilePath, {
+    projectId,
+    expires,
+    channelId,
+    target,
+    firebaseToolsVersion,
+  });
+  if (deployment.status === "error") {
+    throw Error((deployment as ErrorResult).error);
+  }
 
-    if (token && isPullRequest && !!octokit) {
-      const commitId = context.payload.pull_request?.head.sha.substring(0, 7);
+  const { expireTime, urls } = interpretChannelDeployResult(deployment);
+  setOutput("urls", urls);
+  setOutput("expire_time", expireTime);
+  setOutput("details_url", urls[0]);
 
-      await postChannelSuccessComment(octokit, context, deployment, commitId);
-    }
+  const urlsListMarkdown =
+    urls.length === 1
+      ? `[${urls[0]}](${urls[0]})`
+      : urls.map((url) => `- [${url}](${url})`).join("\n");
 
-    await finish({
-      details_url: urls[0],
-      conclusion: "success",
-      output: {
-        title: `Deploy preview succeeded`,
-        summary: getURLsMarkdownFromChannelDeployResult(deployment),
-      },
-    });
-  } catch (e) {
-    setFailed(e.message);
+  if (token && !!context.payload.pull_request && !!octokit) {
+    const commitId = context.payload.pull_request?.head.sha.substring(0, 7);
 
-    await finish({
-      conclusion: "failure",
-      output: {
-        title: "Deploy preview failed",
-        summary: `Error: ${e.message}`,
-      },
-    });
+    await postChannelSuccessComment(octokit, context, deployment, commitId);
   }
+  console.log({
+    details_url: urls[0],
+    conclusion: "success",
+    output: {
+      title: `Deploy preview succeeded`,
+      summary: getURLsMarkdownFromChannelDeployResult(deployment),
+    },
+  });
+  return undefined;
 }
 
 run();

src/index.ts

@@ -82,24 +82,26 @@ export async function postChannelSuccessComment(
   };
 
   startGroup(`Commenting on PR`);
+
   const deploySignature = createDeploySignature(result);
   const isCommentByBot = createBotCommentIdentifier(deploySignature);
 
   let commentId;
   try {
     const comments = (await github.rest.issues.listComments(commentInfo)).data;
-    for (let i = comments.length; i--; ) {
+    for (let i = comments.length; i--;) {
       const c = comments[i];
       if (isCommentByBot(c)) {
         commentId = c.id;
         break;
       }
     }
   } catch (e) {
-    console.log("Error checking for previous comments: " + e.message);
+    console.error("Error checking for previous comments: " + e.message);
   }
 
-  if (commentId) {
+  if (!!commentId) {
+    console.log("Found existing comment.");
     try {
       await github.rest.issues.updateComment({
         ...context.repo,
@@ -110,12 +112,12 @@ export async function postChannelSuccessComment(
       commentId = null;
     }
   }
-
-  if (!commentId) {
+  else {
+    console.log("New comment will be created.");
     try {
       await github.rest.issues.createComment(comment);
     } catch (e) {
-      console.log(`Error creating comment: ${e.message}`);
+      console.error(`Error creating comment: ${e.message}`);
     }
   }
   endGroup();