iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

build: list feat commits in patch branch in relase review script (#36651) 

PR Close #36651
This commit is contained in:
Andrew Scott 2020-04-15 16:49:48 -07:00 committed by Matias Niemelä
parent 351759906b
commit d7e9d8746a
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
scripts/compare-master-to-patch.js
View File

@ -14,6 +14,9 @@
* This script compares commits in master and patch branches to find the delta between them. This is * This script compares commits in master and patch branches to find the delta between them. This is
* useful for release reviews, to make sure all the necessary commits were included into the patch * useful for release reviews, to make sure all the necessary commits were included into the patch
* branch and there is no discrepancy. * branch and there is no discrepancy.
*
* Additionally, lists all 'feat' commits that were merged to the patch branch to aid in ensuring
* features are only released to master.
*/ */
const {exec} = require('shelljs'); const {exec} = require('shelljs');
@ -57,6 +60,10 @@ function maybeExtractReleaseVersion(commit) {
return matches ? matches[1] || matches[2] : null; return matches ? matches[1] || matches[2] : null;
} }
/**
* @param rawGitCommits
* @returns {Map<string, [string, string]>} - Map of commit message to [commit info, version]
*/
function collectCommitsAsMap(rawGitCommits) { function collectCommitsAsMap(rawGitCommits) {
const commits = toArray(rawGitCommits); const commits = toArray(rawGitCommits);
const commitsMap = new Map(); const commitsMap = new Map();
@ -81,6 +88,10 @@ function collectCommitsAsMap(rawGitCommits) {
return commitsMap; return commitsMap;
} }
function getCommitInfoAsString(commitInfo, version) {
return `[${version}+] ${commitInfo}`;
}
/** /**
* Returns a list of items present in `mapA`, but *not* present in `mapB`. * Returns a list of items present in `mapA`, but *not* present in `mapB`.
* This function is needed to compare 2 sets of commits and return the list of unique commits in the * This function is needed to compare 2 sets of commits and return the list of unique commits in the
@ -90,12 +101,26 @@ function diff(mapA, mapB) {
const result = []; const result = [];
mapA.forEach((value, key) => { mapA.forEach((value, key) => {
if (!mapB.has(key)) { if (!mapB.has(key)) {
result.push(`[${value[1]}+] ${value[0]}`); result.push(getCommitInfoAsString(value[1], value[0]));
} }
}); });
return result; return result;
} }
/**
* @param {Map<string, [string, string]>} commitsMap - commit map from collectCommitsAsMap
* @returns {string[]} List of commits with commit messages that start with 'feat'
*/
function listFeatures(commitsMap) {
return Array.from(commitsMap.keys()).reduce((result, key) => {
if (key.startsWith('feat')) {
const value = commitsMap.get(key);
result.push(getCommitInfoAsString(value[1], value[0]));
}
return result;
}, []);
}
function getBranchByTag(tag) { function getBranchByTag(tag) {
const version = semver(tag); const version = semver(tag);
return `${version.major}.${version.minor}.x`; // e.g. 9.0.x return `${version.major}.${version.minor}.x`; // e.g. 9.0.x
@ -141,7 +166,10 @@ ${diff(masterCommitsMap, patchCommitsMap).join('\n') || 'No extra commits'}
***** Only in PATCH (${branch}) ***** ***** Only in PATCH (${branch}) *****
${diff(patchCommitsMap, masterCommitsMap).join('\n') || 'No extra commits'} ${diff(patchCommitsMap, masterCommitsMap).join('\n') || 'No extra commits'}
***** Features in PATCH (${branch}) - should always be empty *****
${listFeatures(patchCommitsMap).join('\n') || 'No extra commits'}
`); `);
} }
main(); main();