Skip to content

[No QA] Refactor createOrUpdateStagingDeploy for clarity and maintainability #83119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
roryabraham wants to merge 5 commits into
base: main
Choose a base branch
from
+1,225 −22,239
Draft

[No QA] Refactor createOrUpdateStagingDeploy for clarity and maintainability #83119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dff55b2
Refactor createOrUpdateStagingDeploy for clarity and maintainability
roryabraham Feb 20, 2026
e450865
Fix CI: spellcheck typo, rebuild action bundles
roryabraham Feb 20, 2026
79bc7f5
Remove action wrapper and run script directly via ts-node
roryabraham Feb 21, 2026
7516d47
Unify isVerified/isResolved into isChecked with a single ChecklistIte…
roryabraham Feb 21, 2026
8080d1d
Merge remote-tracking branch 'origin/main' into rory-cleanup-staging-…
roryabraham Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
247 changes: 0 additions & 247 deletions .github/actions/javascript/authorChecklist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15685,9 +15685,7 @@ const utils_1 = __nccwpck_require__(3030);
const plugin_paginate_rest_1 = __nccwpck_require__(4193);
const plugin_throttling_1 = __nccwpck_require__(9968);
const request_error_1 = __nccwpck_require__(537);
const arrayDifference_1 = __importDefault(__nccwpck_require__(7532));
const CONST_1 = __importDefault(__nccwpck_require__(9873));
const isEmptyObject_1 = __nccwpck_require__(6497);
class GithubUtils {
static internalOctokit;
/**
Expand Down Expand Up @@ -15766,219 +15764,6 @@ class GithubUtils {
// eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
return this.internalOctokit.paginate;
}
/**
* Finds one open `StagingDeployCash` issue via GitHub octokit library.
*/
static getStagingDeployCash() {
return this.octokit.issues
.listForRepo({
owner: CONST_1.default.GITHUB_OWNER,
repo: CONST_1.default.APP_REPO,
labels: CONST_1.default.LABELS.STAGING_DEPLOY,
state: 'open',
})
.then(({ data }) => {
if (!data.length) {
throw new Error(`Unable to find ${CONST_1.default.LABELS.STAGING_DEPLOY} issue.`);
}
if (data.length > 1) {
throw new Error(`Found more than one ${CONST_1.default.LABELS.STAGING_DEPLOY} issue.`);
}
const issue = data.at(0);
if (!issue) {
throw new Error(`Found an undefined ${CONST_1.default.LABELS.STAGING_DEPLOY} issue.`);
}
return this.getStagingDeployCashData(issue);
});
}
/**
* Takes in a GitHub issue object and returns the data we want.
*/
static getStagingDeployCashData(issue) {
try {
const versionRegex = new RegExp('([0-9]+)\\.([0-9]+)\\.([0-9]+)(?:-([0-9]+))?', 'g');
const version = (issue.body?.match(versionRegex)?.[0] ?? '').replaceAll('`', '');
return {
title: issue.title,
url: issue.url,
number: this.getIssueOrPullRequestNumberFromURL(issue.url),
labels: issue.labels,
PRList: this.getStagingDeployCashPRList(issue),
PRListMobileExpensify: this.getStagingDeployCashPRListMobileExpensify(issue),
deployBlockers: this.getStagingDeployCashDeployBlockers(issue),
internalQAPRList: this.getStagingDeployCashInternalQA(issue),
isSentryChecked: issue.body ? /-\s\[x]\sI checked \[Sentry]/.test(issue.body) : false,
isGHStatusChecked: issue.body ? /-\s\[x]\sI checked \[GitHub Status]/.test(issue.body) : false,
version,
tag: `${version}-staging`,
};
}
catch (exception) {
throw new Error(`Unable to find ${CONST_1.default.LABELS.STAGING_DEPLOY} issue with correct data.`);
}
}
/**
* Parse the PRList and Internal QA section of the StagingDeployCash issue body.
*
* @private
*/
static getStagingDeployCashPRList(issue) {
let PRListSection = issue.body?.match(/pull requests:\*\*\r?\n((?:-.*\r?\n)+)\r?\n\r?\n?/) ?? null;
if (PRListSection?.length !== 2) {
// No PRs, return an empty array
console.log('Hmmm...The open StagingDeployCash does not list any pull requests, continuing...');
return [];
}
PRListSection = PRListSection[1];
const PRList = [...PRListSection.matchAll(new RegExp(`- \\[([ x])] (${CONST_1.default.PULL_REQUEST_REGEX.source})`, 'g'))].map((match) => ({
url: match[2],
number: Number.parseInt(match[3], 10),
isVerified: match[1] === 'x',
}));
return PRList.sort((a, b) => a.number - b.number);
}
static getStagingDeployCashPRListMobileExpensify(issue) {
let mobileExpensifySection = issue.body?.match(/Mobile-Expensify PRs:\*\*\r?\n((?:-.*\r?\n)+)/) ?? null;
if (mobileExpensifySection?.length !== 2) {
return [];
}
mobileExpensifySection = mobileExpensifySection[1];
const mobileExpensifyPRs = [...mobileExpensifySection.matchAll(new RegExp(`- \\[([ x])]\\s(${CONST_1.default.ISSUE_OR_PULL_REQUEST_REGEX.source})`, 'g'))].map((match) => ({
url: match[2],
number: Number.parseInt(match[3], 10),
isVerified: match[1] === 'x',
}));
return mobileExpensifyPRs.sort((a, b) => a.number - b.number);
}
/**
* Parse DeployBlocker section of the StagingDeployCash issue body.
*
* @private
*/
static getStagingDeployCashDeployBlockers(issue) {
let deployBlockerSection = issue.body?.match(/Deploy Blockers:\*\*\r?\n((?:-.*\r?\n)+)/) ?? null;
if (deployBlockerSection?.length !== 2) {
return [];
}
deployBlockerSection = deployBlockerSection[1];
const deployBlockers = [...deployBlockerSection.matchAll(new RegExp(`- \\[([ x])]\\s(${CONST_1.default.ISSUE_OR_PULL_REQUEST_REGEX.source})`, 'g'))].map((match) => ({
url: match[2],
number: Number.parseInt(match[3], 10),
isResolved: match[1] === 'x',
}));
return deployBlockers.sort((a, b) => a.number - b.number);
}
/**
* Parse InternalQA section of the StagingDeployCash issue body.
*
* @private
*/
static getStagingDeployCashInternalQA(issue) {
let internalQASection = issue.body?.match(/Internal QA:\*\*\r?\n((?:- \[[ x]].*\r?\n)+)/) ?? null;
if (internalQASection?.length !== 2) {
return [];
}
internalQASection = internalQASection[1];
const internalQAPRs = [...internalQASection.matchAll(new RegExp(`- \\[([ x])]\\s(${CONST_1.default.PULL_REQUEST_REGEX.source})`, 'g'))].map((match) => ({
url: match[2].split('-').at(0)?.trim() ?? '',
number: Number.parseInt(match[3], 10),
isResolved: match[1] === 'x',
}));
return internalQAPRs.sort((a, b) => a.number - b.number);
}
/**
* Generate the issue body and assignees for a StagingDeployCash.
*/
static generateStagingDeployCashBodyAndAssignees({ tag, PRList, PRListMobileExpensify = [], verifiedPRList = [], verifiedPRListMobileExpensify = [], deployBlockers = [], resolvedDeployBlockers = [], resolvedInternalQAPRs = [], isSentryChecked = false, isGHStatusChecked = false, previousTag = '', chronologicalSection = '', }) {
return this.fetchAllPullRequests(PRList.map((pr) => this.getPullRequestNumberFromURL(pr)))
.then((data) => {
const internalQAPRs = Array.isArray(data) ? data.filter((pr) => !(0, isEmptyObject_1.isEmptyObject)(pr.labels.find((item) => item.name === CONST_1.default.LABELS.INTERNAL_QA))) : [];
return Promise.all(internalQAPRs.map((pr) => this.getPullRequestMergerLogin(pr.number).then((mergerLogin) => ({ url: pr.html_url, mergerLogin })))).then((results) => {
// The format of this map is following:
// {
// 'https://github.com/Expensify/App/pull/9641': 'PauloGasparSv',
// 'https://github.com/Expensify/App/pull/9642': 'mountiny'
// }
const internalQAPRMap = results.reduce((acc, { url, mergerLogin }) => {
acc[url] = mergerLogin;
return acc;
}, {});
console.log('Found the following Internal QA PRs:', internalQAPRMap);
const noQAPRs = Array.isArray(data) ? data.filter((PR) => /\[No\s?QA]/i.test(PR.title)).map((item) => item.html_url) : [];
console.log('Found the following NO QA PRs:', noQAPRs);
const verifiedOrNoQAPRs = new Set([...verifiedPRList, ...verifiedPRListMobileExpensify, ...noQAPRs]);
const sortedPRList = [...new Set((0, arrayDifference_1.default)(PRList, Object.keys(internalQAPRMap)))].sort((a, b) => GithubUtils.getPullRequestNumberFromURL(a) - GithubUtils.getPullRequestNumberFromURL(b));
const sortedPRListMobileExpensify = [...new Set(PRListMobileExpensify)].sort((a, b) => GithubUtils.getPullRequestNumberFromURL(a) - GithubUtils.getPullRequestNumberFromURL(b));
const sortedDeployBlockers = [...new Set(deployBlockers)].sort((a, b) => GithubUtils.getIssueOrPullRequestNumberFromURL(a) - GithubUtils.getIssueOrPullRequestNumberFromURL(b));
// Tag version and comparison URL
// eslint-disable-next-line max-len
let issueBody = `**Release Version:** \`${tag}\`\r\n**Compare Changes:** https://github.com/${process.env.GITHUB_REPOSITORY}/compare/production...staging\r\n`;
// Add Mobile-Expensify compare link if there are Mobile-Expensify PRs
if (sortedPRListMobileExpensify.length > 0) {
issueBody += `**Mobile-Expensify Changes:** https://github.com/${CONST_1.default.GITHUB_OWNER}/${CONST_1.default.MOBILE_EXPENSIFY_REPO}/compare/production...staging\r\n`;
}
issueBody += '\r\n';
// PR list
if (sortedPRList.length > 0) {
issueBody += '**This release contains changes from the following pull requests:**\r\n';
for (const URL of sortedPRList) {
issueBody += verifiedOrNoQAPRs.has(URL) ? '- [x]' : '- [ ]';
issueBody += ` ${URL}\r\n`;
}
issueBody += '\r\n\r\n';
}
// Mobile-Expensify PR list
if (sortedPRListMobileExpensify.length > 0) {
issueBody += '**Mobile-Expensify PRs:**\r\n';
for (const URL of sortedPRListMobileExpensify) {
issueBody += verifiedOrNoQAPRs.has(URL) ? '- [x]' : '- [ ]';
issueBody += ` ${URL}\r\n`;
}
issueBody += '\r\n\r\n';
}
// Internal QA PR list
if (!(0, isEmptyObject_1.isEmptyObject)(internalQAPRMap)) {
console.log('Found the following verified Internal QA PRs:', resolvedInternalQAPRs);
issueBody += '**Internal QA:**\r\n';
for (const URL of Object.keys(internalQAPRMap)) {
const merger = internalQAPRMap[URL];
const mergerMention = `@${merger}`;
issueBody += `${resolvedInternalQAPRs.includes(URL) ? '- [x]' : '- [ ]'} `;
issueBody += `${URL}`;
issueBody += ` - ${mergerMention}`;
issueBody += '\r\n';
}
issueBody += '\r\n\r\n';
}
// Deploy blockers
if (deployBlockers.length > 0) {
issueBody += '**Deploy Blockers:**\r\n';
for (const URL of sortedDeployBlockers) {
issueBody += resolvedDeployBlockers.includes(URL) ? '- [x] ' : '- [ ] ';
issueBody += URL;
issueBody += '\r\n';
}
issueBody += '\r\n\r\n';
}
if (chronologicalSection) {
issueBody += chronologicalSection;
issueBody += '\r\n\r\n';
}
issueBody += '**Deployer verifications:**';
// eslint-disable-next-line max-len
issueBody += `\r\n- [${isSentryChecked ? 'x' : ' '}] I checked [Sentry](https://expensify.sentry.io/releases/new.expensify%40${tag}/?project=app&environment=staging) for **this release version** and verified that this release does not introduce any new crashes. More detailed instructions on this verification can be found [here](https://stackoverflowteams.com/c/expensify/questions/15095/15096).`;
// eslint-disable-next-line max-len
issueBody += `\r\n- [${isSentryChecked ? 'x' : ' '}] I checked [Sentry](https://expensify.sentry.io/releases/new.expensify%40${previousTag}/?project=app&environment=production) for **the previous release version** and verified that the release did not introduce any new crashes. Because mobile deploys use a phased rollout, completing this checklist will deploy the previous release version to 100% of users. More detailed instructions on this verification can be found [here](https://stackoverflowteams.com/c/expensify/questions/15095/15096).`;
// eslint-disable-next-line max-len
issueBody += `\r\n- [${isGHStatusChecked ? 'x' : ' '}] I checked [GitHub Status](https://www.githubstatus.com/) and verified there is no reported incident with Actions.`;
issueBody += '\r\n\r\ncc @Expensify/applauseleads\r\n';
const issueAssignees = [...new Set(Object.values(internalQAPRMap))];
const issue = { issueBody, issueAssignees };
return issue;
});
})
.catch((err) => console.warn('Error generating StagingDeployCash issue body! Continuing...', err));
}
/**
* Fetch all pull requests given a list of PR numbers.
*/
Expand Down Expand Up @@ -16287,38 +16072,6 @@ class GithubUtils {
exports["default"] = GithubUtils;


/***/ }),

/***/ 7532:
/***/ ((__unused_webpack_module, exports) => {

"use strict";

Object.defineProperty(exports, "__esModule", ({ value: true }));
/**
* This function is an equivalent of _.difference, it takes two arrays and returns the difference between them.
* It returns an array of items that are in the first array but not in the second array.
*/
function arrayDifference(array1, array2) {
return [array1, array2].reduce((a, b) => a.filter((c) => !b.includes(c)));
}
exports["default"] = arrayDifference;


/***/ }),

/***/ 6497:
/***/ ((__unused_webpack_module, exports) => {

"use strict";

Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.isEmptyObject = isEmptyObject;
function isEmptyObject(obj) {
return Object.keys(obj ?? {}).length === 0;
}


/***/ }),

/***/ 8534:
Expand Down
Loading
Loading