Skip to content
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

[No QA] Add more verbose logs to fetchRefIfNeeded #21468

Merged
merged 2 commits into from
Jun 23, 2023
Merged

[No QA] Add more verbose logs to fetchRefIfNeeded #21468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa4e24f
Add more verbose logs to fetchRefIfNeeded
roryabraham Jun 23, 2023
c7b959f
Correctly fetch tags in GitUtils
roryabraham Jun 23, 2023
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
53 changes: 30 additions & 23 deletions .github/actions/javascript/createOrUpdateStagingDeploy/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,38 +218,45 @@ const CONST = __nccwpck_require__(4097);
const sanitizeStringForJSONParse = __nccwpck_require__(9338);

/**
* @param {String} ref
* @param {String} tag
*/
function fetchRefIfNeeded(ref) {
function fetchTagIfNeeded(tag) {
try {
console.log(`Checking if ref ${ref} exists locally`);
const command = `git rev-parse --verify ${ref}`;
console.log(`Checking if tag ${tag} exists locally`);
const command = `git rev-parse --verify ${tag}`;
console.log(`Running command: ${command}`);
execSync(command);
const result = execSync(command).toString();
console.log(result);
} catch (e) {
console.log(`Ref ${ref} not found locally, attempting to fetch it.`);
const command = `git fetch origin ${ref}`;
console.log(`Tag ${tag} not found locally, attempting to fetch it.`);
let command = `git fetch origin refs/tags/${tag}:refs/tags/${tag}`;
console.log(`Running command: ${command}`);
execSync(command);
let result = execSync(command).toString();
console.log(result);
console.log('Verifying that the tag is now available...');
command = `git rev-parse --verify ${tag}`;
console.log(`Running command: ${command}`);
result = execSync(command).toString();
console.log(result);
}
}

/**
* Get merge logs between two refs (inclusive) as a JavaScript object.
* Get merge logs between two tags (inclusive) as a JavaScript object.
*
* @param {String} fromRef
* @param {String} toRef
* @param {String} fromTag
* @param {String} toTag
* @returns {Promise<Array<Object<{commit: String, subject: String, authorName: String}>>>}
*/
function getCommitHistoryAsJSON(fromRef, toRef) {
fetchRefIfNeeded(fromRef);
fetchRefIfNeeded(toRef);
function getCommitHistoryAsJSON(fromTag, toTag) {
fetchTagIfNeeded(fromTag);
fetchTagIfNeeded(toTag);

console.log('Getting pull requests merged between the following refs:', fromRef, toRef);
console.log('Getting pull requests merged between the following tags:', fromTag, toTag);
return new Promise((resolve, reject) => {
let stdout = '';
let stderr = '';
const args = ['log', '--format={"commit": "%H", "authorName": "%an", "subject": "%s"},', `${fromRef}...${toRef}`];
const args = ['log', '--format={"commit": "%H", "authorName": "%an", "subject": "%s"},', `${fromTag}...${toTag}`];
console.log(`Running command: git ${args.join(' ')}`);
const spawnedProcess = spawn('git', args);
spawnedProcess.on('message', console.log);
Expand Down Expand Up @@ -314,19 +321,19 @@ function getValidMergedPRs(commits) {
}

/**
* Takes in two git refs and returns a list of PR numbers of all PRs merged between those two refs
* Takes in two git tags and returns a list of PR numbers of all PRs merged between those two tags
*
* @param {String} fromRef
* @param {String} toRef
* @param {String} fromTag
* @param {String} toTag
* @returns {Promise<Array<String>>} – Pull request numbers
*/
function getPullRequestsMergedBetween(fromRef, toRef) {
return getCommitHistoryAsJSON(fromRef, toRef).then((commitList) => {
console.log(`Commits made between ${fromRef} and ${toRef}:`, commitList);
function getPullRequestsMergedBetween(fromTag, toTag) {
return getCommitHistoryAsJSON(fromTag, toTag).then((commitList) => {
console.log(`Commits made between ${fromTag} and ${toTag}:`, commitList);

// Find which commit messages correspond to merged PR's
const pullRequestNumbers = getValidMergedPRs(commitList);
console.log(`List of pull requests merged between ${fromRef} and ${toRef}`, pullRequestNumbers);
console.log(`List of pull requests merged between ${fromTag} and ${toTag}`, pullRequestNumbers);
return pullRequestNumbers;
});
}
Expand Down
53 changes: 30 additions & 23 deletions .github/actions/javascript/getDeployPullRequestList/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,38 +152,45 @@ const CONST = __nccwpck_require__(4097);
const sanitizeStringForJSONParse = __nccwpck_require__(9338);

/**
* @param {String} ref
* @param {String} tag
*/
function fetchRefIfNeeded(ref) {
function fetchTagIfNeeded(tag) {
try {
console.log(`Checking if ref ${ref} exists locally`);
const command = `git rev-parse --verify ${ref}`;
console.log(`Checking if tag ${tag} exists locally`);
const command = `git rev-parse --verify ${tag}`;
console.log(`Running command: ${command}`);
execSync(command);
const result = execSync(command).toString();
console.log(result);
} catch (e) {
console.log(`Ref ${ref} not found locally, attempting to fetch it.`);
const command = `git fetch origin ${ref}`;
console.log(`Tag ${tag} not found locally, attempting to fetch it.`);
let command = `git fetch origin refs/tags/${tag}:refs/tags/${tag}`;
console.log(`Running command: ${command}`);
execSync(command);
let result = execSync(command).toString();
console.log(result);
console.log('Verifying that the tag is now available...');
command = `git rev-parse --verify ${tag}`;
console.log(`Running command: ${command}`);
result = execSync(command).toString();
console.log(result);
}
}

/**
* Get merge logs between two refs (inclusive) as a JavaScript object.
* Get merge logs between two tags (inclusive) as a JavaScript object.
*
* @param {String} fromRef
* @param {String} toRef
* @param {String} fromTag
* @param {String} toTag
* @returns {Promise<Array<Object<{commit: String, subject: String, authorName: String}>>>}
*/
function getCommitHistoryAsJSON(fromRef, toRef) {
fetchRefIfNeeded(fromRef);
fetchRefIfNeeded(toRef);
function getCommitHistoryAsJSON(fromTag, toTag) {
fetchTagIfNeeded(fromTag);
fetchTagIfNeeded(toTag);

console.log('Getting pull requests merged between the following refs:', fromRef, toRef);
console.log('Getting pull requests merged between the following tags:', fromTag, toTag);
return new Promise((resolve, reject) => {
let stdout = '';
let stderr = '';
const args = ['log', '--format={"commit": "%H", "authorName": "%an", "subject": "%s"},', `${fromRef}...${toRef}`];
const args = ['log', '--format={"commit": "%H", "authorName": "%an", "subject": "%s"},', `${fromTag}...${toTag}`];
console.log(`Running command: git ${args.join(' ')}`);
const spawnedProcess = spawn('git', args);
spawnedProcess.on('message', console.log);
Expand Down Expand Up @@ -248,19 +255,19 @@ function getValidMergedPRs(commits) {
}

/**
* Takes in two git refs and returns a list of PR numbers of all PRs merged between those two refs
* Takes in two git tags and returns a list of PR numbers of all PRs merged between those two tags
*
* @param {String} fromRef
* @param {String} toRef
* @param {String} fromTag
* @param {String} toTag
* @returns {Promise<Array<String>>} – Pull request numbers
*/
function getPullRequestsMergedBetween(fromRef, toRef) {
return getCommitHistoryAsJSON(fromRef, toRef).then((commitList) => {
console.log(`Commits made between ${fromRef} and ${toRef}:`, commitList);
function getPullRequestsMergedBetween(fromTag, toTag) {
return getCommitHistoryAsJSON(fromTag, toTag).then((commitList) => {
console.log(`Commits made between ${fromTag} and ${toTag}:`, commitList);

// Find which commit messages correspond to merged PR's
const pullRequestNumbers = getValidMergedPRs(commitList);
console.log(`List of pull requests merged between ${fromRef} and ${toRef}`, pullRequestNumbers);
console.log(`List of pull requests merged between ${fromTag} and ${toTag}`, pullRequestNumbers);
return pullRequestNumbers;
});
}
Expand Down
53 changes: 30 additions & 23 deletions .github/libs/GitUtils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,45 @@ const CONST = require('./CONST');
const sanitizeStringForJSONParse = require('./sanitizeStringForJSONParse');

/**
* @param {String} ref
* @param {String} tag
*/
function fetchRefIfNeeded(ref) {
function fetchTagIfNeeded(tag) {
try {
console.log(`Checking if ref ${ref} exists locally`);
const command = `git rev-parse --verify ${ref}`;
console.log(`Checking if tag ${tag} exists locally`);
const command = `git rev-parse --verify ${tag}`;
console.log(`Running command: ${command}`);
execSync(command);
const result = execSync(command).toString();
console.log(result);
} catch (e) {
console.log(`Ref ${ref} not found locally, attempting to fetch it.`);
const command = `git fetch origin ${ref}`;
console.log(`Tag ${tag} not found locally, attempting to fetch it.`);
let command = `git fetch origin refs/tags/${tag}:refs/tags/${tag}`;
console.log(`Running command: ${command}`);
execSync(command);
let result = execSync(command).toString();
console.log(result);
console.log('Verifying that the tag is now available...');
command = `git rev-parse --verify ${tag}`;
console.log(`Running command: ${command}`);
result = execSync(command).toString();
console.log(result);
}
}

/**
* Get merge logs between two refs (inclusive) as a JavaScript object.
* Get merge logs between two tags (inclusive) as a JavaScript object.
*
* @param {String} fromRef
* @param {String} toRef
* @param {String} fromTag
* @param {String} toTag
* @returns {Promise<Array<Object<{commit: String, subject: String, authorName: String}>>>}
*/
function getCommitHistoryAsJSON(fromRef, toRef) {
fetchRefIfNeeded(fromRef);
fetchRefIfNeeded(toRef);
function getCommitHistoryAsJSON(fromTag, toTag) {
fetchTagIfNeeded(fromTag);
fetchTagIfNeeded(toTag);

console.log('Getting pull requests merged between the following refs:', fromRef, toRef);
console.log('Getting pull requests merged between the following tags:', fromTag, toTag);
return new Promise((resolve, reject) => {
let stdout = '';
let stderr = '';
const args = ['log', '--format={"commit": "%H", "authorName": "%an", "subject": "%s"},', `${fromRef}...${toRef}`];
const args = ['log', '--format={"commit": "%H", "authorName": "%an", "subject": "%s"},', `${fromTag}...${toTag}`];
console.log(`Running command: git ${args.join(' ')}`);
const spawnedProcess = spawn('git', args);
spawnedProcess.on('message', console.log);
Expand Down Expand Up @@ -100,19 +107,19 @@ function getValidMergedPRs(commits) {
}

/**
* Takes in two git refs and returns a list of PR numbers of all PRs merged between those two refs
* Takes in two git tags and returns a list of PR numbers of all PRs merged between those two tags
*
* @param {String} fromRef
* @param {String} toRef
* @param {String} fromTag
* @param {String} toTag
* @returns {Promise<Array<String>>} – Pull request numbers
*/
function getPullRequestsMergedBetween(fromRef, toRef) {
return getCommitHistoryAsJSON(fromRef, toRef).then((commitList) => {
console.log(`Commits made between ${fromRef} and ${toRef}:`, commitList);
function getPullRequestsMergedBetween(fromTag, toTag) {
return getCommitHistoryAsJSON(fromTag, toTag).then((commitList) => {
console.log(`Commits made between ${fromTag} and ${toTag}:`, commitList);

// Find which commit messages correspond to merged PR's
const pullRequestNumbers = getValidMergedPRs(commitList);
console.log(`List of pull requests merged between ${fromRef} and ${toRef}`, pullRequestNumbers);
console.log(`List of pull requests merged between ${fromTag} and ${toTag}`, pullRequestNumbers);
return pullRequestNumbers;
});
}
Expand Down