Merge pull request #49563 from Expensify/Rory-CallableDeployCommentsW…

…orkflow Callable deploy comments workflow
Expensify · Sep 24, 2024 · 06a59ad · 06a59ad
2 parents e232163 + 613f893
commit 06a59ad
Show file tree

Hide file tree

Showing 6 changed files with 158 additions and 32 deletions.
diff --git a/.github/actions/javascript/markPullRequestsAsDeployed/action.yml b/.github/actions/javascript/markPullRequestsAsDeployed/action.yml
@@ -14,7 +14,6 @@ inputs:
     GITHUB_TOKEN:
         description: "Github token for authentication"
         required: true
-        default: "${{ github.token }}"
     ANDROID:
         description: "Android job result ('success', 'failure', 'cancelled', or 'skipped')"
         required: true
@@ -27,6 +26,12 @@ inputs:
     WEB:
         description: "Web job result ('success', 'failure', 'cancelled', or 'skipped')"
         required: true
+    DATE:
+        description: "The date of deployment"
+        required: false
+    NOTE:
+        description: "Additional note from the deployer"
+        required: false
 runs:
     using: "node20"
     main: "./index.js"
diff --git a/.github/actions/javascript/markPullRequestsAsDeployed/index.js b/.github/actions/javascript/markPullRequestsAsDeployed/index.js
@@ -12713,16 +12713,25 @@ async function run() {
     const desktopResult = getDeployTableMessage(core.getInput('DESKTOP', { required: true }));
     const iOSResult = getDeployTableMessage(core.getInput('IOS', { required: true }));
     const webResult = getDeployTableMessage(core.getInput('WEB', { required: true }));
+    const date = core.getInput('DATE');
+    const note = core.getInput('NOTE');
     function getDeployMessage(deployer, deployVerb, prTitle) {
         let message = `🚀 [${deployVerb}](${workflowURL}) to ${isProd ? 'production' : 'staging'}`;
-        message += ` by https://github.com/${deployer} in version: ${version} 🚀`;
+        message += ` by https://github.com/${deployer} in version: ${version} `;
+        if (date) {
+            message += `on ${date}`;
+        }
+        message += `🚀`;
         message += `\n\nplatform | result\n---|---\n🤖 android 🤖|${androidResult}\n🖥 desktop 🖥|${desktopResult}`;
         message += `\n🍎 iOS 🍎|${iOSResult}\n🕸 web 🕸|${webResult}`;
         if (deployVerb === 'Cherry-picked' && !/no ?qa/gi.test(prTitle ?? '')) {
             // eslint-disable-next-line max-len
             message +=
                 '\n\n@Expensify/applauseleads please QA this PR and check it off on the [deploy checklist](https://github.com/Expensify/App/issues?q=is%3Aopen+is%3Aissue+label%3AStagingDeployCash) if it passes.';
         }
+        if (note) {
+            message += `\n\n_Note:_ ${note}`;
+        }
         return message;
     }
     if (isProd) {

diff --git a/.github/actions/javascript/markPullRequestsAsDeployed/markPullRequestsAsDeployed.ts b/.github/actions/javascript/markPullRequestsAsDeployed/markPullRequestsAsDeployed.ts
@@ -55,9 +55,16 @@ async function run() {
     const iOSResult = getDeployTableMessage(core.getInput('IOS', {required: true}) as PlatformResult);
     const webResult = getDeployTableMessage(core.getInput('WEB', {required: true}) as PlatformResult);
 
+    const date = core.getInput('DATE');
+    const note = core.getInput('NOTE');
+
     function getDeployMessage(deployer: string, deployVerb: string, prTitle?: string): string {
         let message = `🚀 [${deployVerb}](${workflowURL}) to ${isProd ? 'production' : 'staging'}`;
-        message += ` by https://github.com/${deployer} in version: ${version} 🚀`;
+        message += ` by https://github.com/${deployer} in version: ${version} `;
+        if (date) {
+            message += `on ${date}`;
+        }
+        message += `🚀`;
         message += `\n\nplatform | result\n---|---\n🤖 android 🤖|${androidResult}\n🖥 desktop 🖥|${desktopResult}`;
         message += `\n🍎 iOS 🍎|${iOSResult}\n🕸 web 🕸|${webResult}`;
 
@@ -67,6 +74,10 @@ async function run() {
                 '\n\n@Expensify/applauseleads please QA this PR and check it off on the [deploy checklist](https://github.com/Expensify/App/issues?q=is%3Aopen+is%3Aissue+label%3AStagingDeployCash) if it passes.';
         }
 
+        if (note) {
+            message += `\n\n_Note:_ ${note}`;
+        }
+
         return message;
     }
 

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -649,34 +649,14 @@ jobs:
           GITHUB_TOKEN: ${{ github.token }}
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}
 
-  postGithubComment:
-    name: Post a GitHub comments on all deployed PRs when platforms are done building and deploying
-    runs-on: ubuntu-latest
+  postGithubComments:
+    uses: ./.github/workflows/postDeployComments.yml
     if: ${{ always() && fromJSON(needs.checkDeploymentSuccess.outputs.IS_AT_LEAST_ONE_PLATFORM_DEPLOYED) }}
     needs: [prep, android, desktop, iOS, web, checkDeploymentSuccess, createPrerelease, finalizeRelease]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Node
-        uses: ./.github/actions/composite/setupNode
-
-      - name: Get Release Pull Request List
-        id: getReleasePRList
-        uses: ./.github/actions/javascript/getDeployPullRequestList
-        with:
-          TAG: ${{ needs.prep.outputs.APP_VERSION }}
-          GITHUB_TOKEN: ${{ secrets.OS_BOTIFY_TOKEN }}
-          IS_PRODUCTION_DEPLOY: ${{ fromJSON(env.SHOULD_DEPLOY_PRODUCTION) }}
-
-      - name: Comment on issues
-        uses: ./.github/actions/javascript/markPullRequestsAsDeployed
-        with:
-          PR_LIST: ${{ steps.getReleasePRList.outputs.PR_LIST }}
-          IS_PRODUCTION_DEPLOY: ${{ fromJSON(env.SHOULD_DEPLOY_PRODUCTION) }}
-          DEPLOY_VERSION: ${{ needs.prep.outputs.APP_VERSION }}
-          GITHUB_TOKEN: ${{ secrets.OS_BOTIFY_TOKEN }}
-          ANDROID: ${{ needs.android.result }}
-          DESKTOP: ${{ needs.desktop.result }}
-          IOS: ${{ needs.iOS.result }}
-          WEB: ${{ needs.web.result }}
+    with:
+      version: ${{ needs.prep.outputs.APP_VERSION }}
+      env: ${{ github.ref == 'refs/heads/production' && 'production' || 'staging' }}
+      android: ${{ needs.android.result }}
+      ios: ${{ needs.iOS.result }}
+      web: ${{ needs.web.result }}
+      desktop: ${{ needs.desktop.result }}
diff --git a/.github/workflows/postDeployComments.yml b/.github/workflows/postDeployComments.yml
@@ -0,0 +1,118 @@
+name: Post Deploy Comments
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        description: The version that was deployed
+        required: true
+        type: string
+      env:
+        description: The environment that was deployed (staging or prod)
+        required: true
+        type: string
+      android:
+        description: Android deploy status
+        required: true
+        type: string
+      ios:
+        description: iOS deploy status
+        required: true
+        type: string
+      web:
+        description: Web deploy status
+        required: true
+        type: string
+      desktop:
+        description: Desktop deploy status
+        required: true
+        type: string
+  workflow_dispatch:
+    inputs:
+      version:
+        description: The version that was deployed
+        required: true
+        type: string
+      env:
+        description: The environment that was deployed (staging or prod)
+        required: true
+        type: choice
+        options:
+          - staging
+          - production
+      android:
+        description: Android deploy status
+        required: true
+        type: choice
+        options:
+          - success
+          - failure
+          - cancelled
+          - skipped
+      ios:
+        description: iOS deploy status
+        required: true
+        type: choice
+        options:
+          - success
+          - failure
+          - cancelled
+          - skipped
+      web:
+        description: Web deploy status
+        required: true
+        type: choice
+        options:
+          - success
+          - failure
+          - cancelled
+          - skipped
+      desktop:
+        description: Desktop deploy status
+        required: true
+        type: choice
+        options:
+          - success
+          - failure
+          - cancelled
+          - skipped
+      date:
+        description: The date when this deploy occurred
+        required: false
+        type: string
+      note:
+        description: Any additional note you want to include with the deploy comment
+        required: false
+        type: string
+
+jobs:
+  postDeployComments:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: ./.github/actions/composite/setupNode
+
+      - name: Get pull request list
+        id: getPullRequestList
+        uses: ./.github/actions/javascript/getDeployPullRequestList
+        with:
+          TAG: ${{ inputs.version }}
+          GITHUB_TOKEN: ${{ github.token }}
+          IS_PRODUCTION_DEPLOY: ${{ inputs.env == 'production' }}
+
+      - name: Comment on issues
+        uses: ./.github/actions/javascript/markPullRequestsAsDeployed
+        with:
+          PR_LIST: ${{ steps.getPullRequestList.outputs.PR_LIST }}
+          IS_PRODUCTION_DEPLOY: ${{ inputs.env == 'production' }}
+          DEPLOY_VERSION: ${{ inputs.version }}
+          GITHUB_TOKEN: ${{ github.token }}
+          ANDROID: ${{ inputs.android }}
+          DESKTOP: ${{ inputs.desktop }}
+          IOS: ${{ inputs.ios }}
+          WEB: ${{ inputs.web }}
+          DATE: ${{ inputs.date }}
+          NOTE: ${{ inputs.note }}
diff --git a/tests/unit/markPullRequestsAsDeployedTest.ts b/tests/unit/markPullRequestsAsDeployedTest.ts
@@ -84,6 +84,9 @@ function mockGetInputDefaultImplementation(key: string): boolean | string {
         case 'DESKTOP':
         case 'WEB':
             return 'success';
+        case 'DATE':
+        case 'NOTE':
+            return '';
         default:
             throw new Error('Trying to access invalid input');
     }