Merge pull request #31458 from Expensify/Rory-CallableChecklistJob

[No QA] Fix too-big checklists

.github/actions/javascript/createOrUpdateStagingDeploy/action.yml

@@ -4,9 +4,7 @@ inputs:
     GITHUB_TOKEN:
         description: Auth token for New Expensify Github
         required: true
-    NPM_VERSION:
-        description: The new NPM version of the StagingDeployCash issue.
-        required: false
+
 runs:
     using: 'node20'
     main: './index.js'

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.js

@@ -1,3 +1,4 @@
+const fs = require('fs');
 const format = require('date-fns/format');
 const _ = require('underscore');
 const core = require('@actions/core');
@@ -6,8 +7,8 @@ const GithubUtils = require('../../../libs/GithubUtils');
 const GitUtils = require('../../../libs/GitUtils');
 
 async function run() {
-    const newVersion = core.getInput('NPM_VERSION');
-    console.log('New version found from action input:', newVersion);
+    // Note: require('package.json').version does not work because ncc will resolve that to a plain string at compile time
+    const newVersionTag = JSON.parse(fs.readFileSync('package.json')).version;
 
     try {
         // Start by fetching the list of recent StagingDeployCash issues, along with the list of open deploy blockers
@@ -35,14 +36,12 @@ async function run() {
         const currentChecklistData = shouldCreateNewDeployChecklist ? {} : GithubUtils.getStagingDeployCashData(mostRecentChecklist);
 
         // Find the list of PRs merged between the current checklist and the previous checklist
-        // Note that any time we're creating a new checklist we MUST have `NPM_VERSION` passed in as an input
-        const newTag = newVersion || _.get(currentChecklistData, 'tag');
-        const mergedPRs = await GitUtils.getPullRequestsMergedBetween(previousChecklistData.tag, newTag);
+        const mergedPRs = await GitUtils.getPullRequestsMergedBetween(previousChecklistData.tag, newVersionTag);
 
         // Next, we generate the checklist body
         let checklistBody = '';
         if (shouldCreateNewDeployChecklist) {
-            checklistBody = await GithubUtils.generateStagingDeployCashBody(newTag, _.map(mergedPRs, GithubUtils.getPullRequestURLFromNumber));
+            checklistBody = await GithubUtils.generateStagingDeployCashBody(newVersionTag, _.map(mergedPRs, GithubUtils.getPullRequestURLFromNumber));
         } else {
             // Generate the updated PR list, preserving the previous state of `isVerified` for existing PRs
             const PRList = _.reduce(
@@ -94,9 +93,9 @@ async function run() {
                 });
             }
 
-            const didVersionChange = newVersion ? newVersion !== currentChecklistData.tag : false;
+            const didVersionChange = newVersionTag !== currentChecklistData.tag;
             checklistBody = await GithubUtils.generateStagingDeployCashBody(
-                newTag,
+                newVersionTag,
                 _.pluck(PRList, 'url'),
                 _.pluck(_.where(PRList, {isVerified: true}), 'url'),
                 _.pluck(deployBlockers, 'url'),

.github/actions/javascript/createOrUpdateStagingDeploy/index.js

@@ -7,6 +7,7 @@
 /***/ 3926:
 /***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
+const fs = __nccwpck_require__(7147);
 const format = __nccwpck_require__(2168);
 const _ = __nccwpck_require__(5067);
 const core = __nccwpck_require__(2186);
@@ -15,8 +16,8 @@ const GithubUtils = __nccwpck_require__(7999);
 const GitUtils = __nccwpck_require__(669);
 
 async function run() {
-    const newVersion = core.getInput('NPM_VERSION');
-    console.log('New version found from action input:', newVersion);
+    // Note: require('package.json').version does not work because ncc will resolve that to a plain string at compile time
+    const newVersionTag = JSON.parse(fs.readFileSync('package.json')).version;
 
     try {
         // Start by fetching the list of recent StagingDeployCash issues, along with the list of open deploy blockers
@@ -44,14 +45,12 @@ async function run() {
         const currentChecklistData = shouldCreateNewDeployChecklist ? {} : GithubUtils.getStagingDeployCashData(mostRecentChecklist);
 
         // Find the list of PRs merged between the current checklist and the previous checklist
-        // Note that any time we're creating a new checklist we MUST have `NPM_VERSION` passed in as an input
-        const newTag = newVersion || _.get(currentChecklistData, 'tag');
-        const mergedPRs = await GitUtils.getPullRequestsMergedBetween(previousChecklistData.tag, newTag);
+        const mergedPRs = await GitUtils.getPullRequestsMergedBetween(previousChecklistData.tag, newVersionTag);
 
         // Next, we generate the checklist body
         let checklistBody = '';
         if (shouldCreateNewDeployChecklist) {
-            checklistBody = await GithubUtils.generateStagingDeployCashBody(newTag, _.map(mergedPRs, GithubUtils.getPullRequestURLFromNumber));
+            checklistBody = await GithubUtils.generateStagingDeployCashBody(newVersionTag, _.map(mergedPRs, GithubUtils.getPullRequestURLFromNumber));
         } else {
             // Generate the updated PR list, preserving the previous state of `isVerified` for existing PRs
             const PRList = _.reduce(
@@ -103,9 +102,9 @@ async function run() {
                 });
             }
 
-            const didVersionChange = newVersion ? newVersion !== currentChecklistData.tag : false;
+            const didVersionChange = newVersionTag !== currentChecklistData.tag;
             checklistBody = await GithubUtils.generateStagingDeployCashBody(
-                newTag,
+                newVersionTag,
                 _.pluck(PRList, 'url'),
                 _.pluck(_.where(PRList, {isVerified: true}), 'url'),
                 _.pluck(deployBlockers, 'url'),
@@ -191,9 +190,9 @@ const {getPreviousVersion, SEMANTIC_VERSION_LEVELS} = __nccwpck_require__(8007);
 
 /**
  * @param {String} tag
+ * @param {String} [shallowExcludeTag] when fetching the given tag, exclude all history reachable by the shallowExcludeTag (used to make fetch much faster)
  */
-function fetchTag(tag) {
-    const previousPatchVersion = getPreviousVersion(tag, SEMANTIC_VERSION_LEVELS.PATCH);
+function fetchTag(tag, shallowExcludeTag = '') {
     let shouldRetry = true;
     let needsRepack = false;
     while (shouldRetry) {
@@ -209,11 +208,9 @@ function fetchTag(tag) {
 
             command = `git fetch origin tag ${tag} --no-tags`;
 
-            // Exclude commits reachable from the previous patch version (i.e: previous checklist),
-            // so that we don't have to fetch the full history
-            // Note that this condition would only ever _not_ be true in the 1.0.0-0 edge case
-            if (previousPatchVersion !== tag) {
-                command += ` --shallow-exclude=${previousPatchVersion}`;
+            // Note that this condition is only ever NOT true in the 1.0.0-0 edge case
+            if (shallowExcludeTag && shallowExcludeTag !== tag) {
+                command += ` --shallow-exclude=${shallowExcludeTag}`;
             }
 
             console.log(`Running command: ${command}`);
@@ -240,8 +237,10 @@ function fetchTag(tag) {
  * @returns {Promise<Array<Object<{commit: String, subject: String, authorName: String}>>>}
  */
 function getCommitHistoryAsJSON(fromTag, toTag) {
-    fetchTag(fromTag);
-    fetchTag(toTag);
+    // Fetch tags, exclude commits reachable from the previous patch version (i.e: previous checklist), so that we don't have to fetch the full history
+    const previousPatchVersion = getPreviousVersion(fromTag, SEMANTIC_VERSION_LEVELS.PATCH);
+    fetchTag(fromTag, previousPatchVersion);
+    fetchTag(toTag, previousPatchVersion);
 
     console.log('Getting pull requests merged between the following tags:', fromTag, toTag);
     return new Promise((resolve, reject) => {

.github/actions/javascript/getDeployPullRequestList/index.js

@@ -133,9 +133,9 @@ const {getPreviousVersion, SEMANTIC_VERSION_LEVELS} = __nccwpck_require__(8007);
 
 /**
  * @param {String} tag
+ * @param {String} [shallowExcludeTag] when fetching the given tag, exclude all history reachable by the shallowExcludeTag (used to make fetch much faster)
  */
-function fetchTag(tag) {
-    const previousPatchVersion = getPreviousVersion(tag, SEMANTIC_VERSION_LEVELS.PATCH);
+function fetchTag(tag, shallowExcludeTag = '') {
     let shouldRetry = true;
     let needsRepack = false;
     while (shouldRetry) {
@@ -151,11 +151,9 @@ function fetchTag(tag) {
 
             command = `git fetch origin tag ${tag} --no-tags`;
 
-            // Exclude commits reachable from the previous patch version (i.e: previous checklist),
-            // so that we don't have to fetch the full history
-            // Note that this condition would only ever _not_ be true in the 1.0.0-0 edge case
-            if (previousPatchVersion !== tag) {
-                command += ` --shallow-exclude=${previousPatchVersion}`;
+            // Note that this condition is only ever NOT true in the 1.0.0-0 edge case
+            if (shallowExcludeTag && shallowExcludeTag !== tag) {
+                command += ` --shallow-exclude=${shallowExcludeTag}`;
             }
 
             console.log(`Running command: ${command}`);
@@ -182,8 +180,10 @@ function fetchTag(tag) {
  * @returns {Promise<Array<Object<{commit: String, subject: String, authorName: String}>>>}
  */
 function getCommitHistoryAsJSON(fromTag, toTag) {
-    fetchTag(fromTag);
-    fetchTag(toTag);
+    // Fetch tags, exclude commits reachable from the previous patch version (i.e: previous checklist), so that we don't have to fetch the full history
+    const previousPatchVersion = getPreviousVersion(fromTag, SEMANTIC_VERSION_LEVELS.PATCH);
+    fetchTag(fromTag, previousPatchVersion);
+    fetchTag(toTag, previousPatchVersion);
 
     console.log('Getting pull requests merged between the following tags:', fromTag, toTag);
     return new Promise((resolve, reject) => {

.github/libs/GitUtils.js

@@ -6,9 +6,9 @@ const {getPreviousVersion, SEMANTIC_VERSION_LEVELS} = require('../libs/versionUp
 
 /**
  * @param {String} tag
+ * @param {String} [shallowExcludeTag] when fetching the given tag, exclude all history reachable by the shallowExcludeTag (used to make fetch much faster)
  */
-function fetchTag(tag) {
-    const previousPatchVersion = getPreviousVersion(tag, SEMANTIC_VERSION_LEVELS.PATCH);
+function fetchTag(tag, shallowExcludeTag = '') {
     let shouldRetry = true;
     let needsRepack = false;
     while (shouldRetry) {
@@ -24,11 +24,9 @@ function fetchTag(tag) {
 
             command = `git fetch origin tag ${tag} --no-tags`;
 
-            // Exclude commits reachable from the previous patch version (i.e: previous checklist),
-            // so that we don't have to fetch the full history
-            // Note that this condition would only ever _not_ be true in the 1.0.0-0 edge case
-            if (previousPatchVersion !== tag) {
-                command += ` --shallow-exclude=${previousPatchVersion}`;
+            // Note that this condition is only ever NOT true in the 1.0.0-0 edge case
+            if (shallowExcludeTag && shallowExcludeTag !== tag) {
+                command += ` --shallow-exclude=${shallowExcludeTag}`;
             }
 
             console.log(`Running command: ${command}`);
@@ -55,8 +53,10 @@ function fetchTag(tag) {
  * @returns {Promise<Array<Object<{commit: String, subject: String, authorName: String}>>>}
  */
 function getCommitHistoryAsJSON(fromTag, toTag) {
-    fetchTag(fromTag);
-    fetchTag(toTag);
+    // Fetch tags, exclude commits reachable from the previous patch version (i.e: previous checklist), so that we don't have to fetch the full history
+    const previousPatchVersion = getPreviousVersion(fromTag, SEMANTIC_VERSION_LEVELS.PATCH);
+    fetchTag(fromTag, previousPatchVersion);
+    fetchTag(toTag, previousPatchVersion);
 
     console.log('Getting pull requests merged between the following tags:', fromTag, toTag);
     return new Promise((resolve, reject) => {

.github/workflows/createDeployChecklist.yml

@@ -0,0 +1,28 @@
+name: Create or update deploy checklist
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  createChecklist:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: ./.github/actions/composite/setupNode
+
+      - name: Set up git for OSBotify
+        id: setupGitForOSBotify
+        uses: ./.github/actions/composite/setupGitForOSBotifyApp
+        with:
+          GPG_PASSPHRASE: ${{ secrets.LARGE_SECRET_PASSPHRASE }}
+          OS_BOTIFY_APP_ID: ${{ secrets.OS_BOTIFY_APP_ID }}
+          OS_BOTIFY_PRIVATE_KEY: ${{ secrets.OS_BOTIFY_PRIVATE_KEY }}
+
+      - name: Create or update deploy checklist
+        uses: ./.github/actions/javascript/createOrUpdateStagingDeploy
+        with:
+          GITHUB_TOKEN: ${{ steps.setupGitForOSBotify.outputs.OS_BOTIFY_API_TOKEN }}

.github/workflows/deployBlocker.yml

@@ -6,27 +6,19 @@ on:
       - labeled
 
 jobs:
+  updateChecklist:
+    if: github.event.label.name == 'DeployBlockerCash'
+    uses: ./.github/workflows/createDeployChecklist.yml
+
   deployBlocker:
+    if: github.event.label.name == 'DeployBlockerCash'
     runs-on: ubuntu-latest
-    if: ${{ github.event.label.name == 'DeployBlockerCash' }}
-
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - uses: ./.github/actions/composite/setupGitForOSBotifyApp
-        id: setupGitForOSBotify
-        with:
-          GPG_PASSPHRASE: ${{ secrets.LARGE_SECRET_PASSPHRASE }}
-          OS_BOTIFY_APP_ID: ${{ secrets.OS_BOTIFY_APP_ID }}
-          OS_BOTIFY_PRIVATE_KEY: ${{ secrets.OS_BOTIFY_PRIVATE_KEY }}
-
-      - name: Update StagingDeployCash with new deploy blocker
-        uses: ./.github/actions/javascript/createOrUpdateStagingDeploy
-        with:
-          GITHUB_TOKEN: ${{ steps.setupGitForOSBotify.outputs.OS_BOTIFY_API_TOKEN }}
-
-      - run: gh issue edit ${{ github.event.issue.number }} --add-label 'Engineering,Hourly' --remove-label 'Daily,Weekly,Monthly'
+      - name: Give the issue/PR the Hourly, Engineering labels
+        run: gh issue edit ${{ github.event.issue.number }} --add-label 'Engineering,Hourly' --remove-label 'Daily,Weekly,Monthly'
         env:
           GITHUB_TOKEN: ${{ github.token }}
 
@@ -51,9 +43,11 @@ jobs:
         run: |
           gh issue comment ${{ github.event.issue.number }} --body "$(cat <<'EOF'
           :wave: Friendly reminder that deploy blockers are time-sensitive ⏱ issues! [Check out the open \`StagingDeployCash\` deploy checklist](https://github.com/Expensify/App/issues?q=is%3Aopen+is%3Aissue+label%3AStagingDeployCash) to see the list of PRs included in this release, then work quickly to do one of the following:
+
           1. Identify the pull request that introduced this issue and revert it.
           2. Find someone who can quickly fix the issue.
           3. Fix the issue yourself.
+
           EOF
           )"
         env:

.github/workflows/platformDeploy.yml

@@ -36,24 +36,9 @@ jobs:
   # Note: we're updating the checklist before running the deploys and assuming that it will succeed on at least one platform
   deployChecklist:
     name: Create or update deploy checklist
-    runs-on: ubuntu-latest
+    uses: ./.github/workflows/createDeployChecklist.yml
     if: ${{ github.event_name != 'release' }}
     needs: validateActor
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup Node
-        uses: Expensify/App/.github/actions/composite/setupNode@main
-
-      - name: Set version
-        id: getVersion
-        run: echo "VERSION=$(npm run print-version --silent)" >> "$GITHUB_OUTPUT"
-
-      - name: Create or update staging deploy
-        uses: Expensify/App/.github/actions/javascript/createOrUpdateStagingDeploy@main
-        with:
-          GITHUB_TOKEN: ${{ secrets.OS_BOTIFY_TOKEN }}
-          NPM_VERSION: ${{ steps.getVersion.outputs.VERSION }}
 
   android:
     name: Build and deploy Android

.gitignore

@@ -107,6 +107,7 @@ tsconfig.tsbuildinfo
 
 # Workflow test logs
 /workflow_tests/logs/
+/workflow_tests/repo/
 
 # Yalc
 .yalc