Add constant and warning comment in workflow

Author: roryabraham

.github/actions/javascript/getDeployPullRequestList/getDeployPullRequestList.ts

@@ -7,6 +7,8 @@ import GitUtils from '@github/libs/GitUtils';
 
 type WorkflowRun = RestEndpointMethodTypes['actions']['listWorkflowRuns']['response']['data']['workflow_runs'][number];
 
+const BUILD_AND_DEPLOY_JOB_NAME_PREFIX = 'Build and deploy';
+
 /**
  * This function checks if a given release is a valid baseTag to get the PR list with `git log baseTag...endTag`.
  *
@@ -45,7 +47,7 @@ async function wasDeploySuccessful(runID: number) {
             filter: 'latest',
         })
     ).data.jobs;
-    return jobsForWorkflowRun.some((job) => job.name.startsWith('Build and deploy') && job.conclusion === 'success');
+    return jobsForWorkflowRun.some((job) => job.name.startsWith(BUILD_AND_DEPLOY_JOB_NAME_PREFIX) && job.conclusion === 'success');
 }
 
 /**

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

@@ -11502,6 +11502,7 @@ const github = __importStar(__nccwpck_require__(5438));
 const ActionUtils_1 = __nccwpck_require__(6981);
 const GithubUtils_1 = __importDefault(__nccwpck_require__(9296));
 const GitUtils_1 = __importDefault(__nccwpck_require__(1547));
+const BUILD_AND_DEPLOY_JOB_NAME_PREFIX = 'Build and deploy';
 /**
  * This function checks if a given release is a valid baseTag to get the PR list with `git log baseTag...endTag`.
  *
@@ -11535,7 +11536,7 @@ async function wasDeploySuccessful(runID) {
         run_id: runID,
         filter: 'latest',
     })).data.jobs;
-    return jobsForWorkflowRun.some((job) => job.name.startsWith('Build and deploy') && job.conclusion === 'success');
+    return jobsForWorkflowRun.some((job) => job.name.startsWith(BUILD_AND_DEPLOY_JOB_NAME_PREFIX) && job.conclusion === 'success');
 }
 /**
  * This function checks if a given deploy workflow is a valid basis for comparison when listing PRs merged between two versions.

.github/workflows/platformDeploy.yml

@@ -38,6 +38,7 @@ jobs:
     secrets: inherit
 
   android:
+    # WARNING: getDeployPullRequestList depends on this job name. do not change job name without adjusting that action accordingly
     name: Build and deploy Android
     needs: validateActor
     if: ${{ fromJSON(needs.validateActor.outputs.IS_DEPLOYER) }}
@@ -122,6 +123,7 @@ jobs:
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}
 
   desktop:
+    # WARNING: getDeployPullRequestList depends on this job name. do not change job name without adjusting that action accordingly
     name: Build and deploy Desktop
     needs: validateActor
     if: ${{ fromJSON(needs.validateActor.outputs.IS_DEPLOYER) }}
@@ -165,6 +167,7 @@ jobs:
           GITHUB_TOKEN: ${{ github.token }}
 
   iOS:
+    # WARNING: getDeployPullRequestList depends on this job name. do not change job name without adjusting that action accordingly
     name: Build and deploy iOS
     needs: validateActor
     if: ${{ fromJSON(needs.validateActor.outputs.IS_DEPLOYER) }}
@@ -276,6 +279,7 @@ jobs:
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}
 
   web:
+    # WARNING: getDeployPullRequestList depends on this job name. do not change job name without adjusting that action accordingly
     name: Build and deploy Web
     needs: validateActor
     if: ${{ fromJSON(needs.validateActor.outputs.IS_DEPLOYER) }}