Changelog script fix (#5227)

Author: vhuseinova-msft

common/scripts/changelog/check.mjs

@@ -16,15 +16,22 @@ import { CHANGE_DIR_BETA, CHANGE_DIR_STABLE } from "./constants.mjs";
 
 async function main() {
   const [base, head] = parseArgs(process.argv);
-  const gitLogStdoutStableChangeFiles = await exec_output(`git log --name-status ${base}..${head} -- ${CHANGE_DIR_STABLE}`);
-  const gitLogStdoutBetaChangeFiles = await exec_output(`git log --name-status ${base}..${head} -- ${CHANGE_DIR_BETA}`);
 
-  const newStableChangeFiles = parseNewChangeFiles(gitLogStdoutStableChangeFiles);
-  const newBetaChangeFiles = parseNewChangeFiles(gitLogStdoutBetaChangeFiles);
-  const newChangeFilesCount = (newStableChangeFiles?.length ?? 0) + (newBetaChangeFiles?.length ?? 0);
+  // Check if the changelog files are present. 
+  // For this, check for new files (`git diff --diff-filter=A`) in the changelog directory(`-- ${CHANGE_DIR}`
+  // or`-- ${CHANGE_DIR_BETA}`) and return only the file names and statuses(`--name-status`).
+  // See https://git-scm.com/docs/git-diff for more info.
+  const changedStableFiles = await exec_output(`git diff --diff-filter=A --name-status ${base}..${head} -- ${CHANGE_DIR_STABLE}`);
+  const changedBetaFiles = await exec_output(`git diff --diff-filter=A --name-status ${base}..${head} -- ${CHANGE_DIR_BETA}`);
+  // Process the output to get the list of files
+  const stableFiles = parseNewChangeFiles(changedStableFiles);
+  const betaFiles = parseNewChangeFiles(changedBetaFiles);
+  const finalChangeFiles = [...stableFiles, ...betaFiles];
+
+  const newChangeFilesCount = finalChangeFiles.length;
 
   if (newChangeFilesCount === 0) {
-    console.error('No changefile detected! Please run `rush changelog` to document your change. Or if your changes do not affect the published packages in any way, please add `do not need changelog` label to the PR.');
+    console.error('No changefile detected! Please run `rush changelog` to document your change. Or if your changes do not affect the published packages in any way, please add `does not need changelog` label to the PR.');
     process.exit(1);
   }
   console.log(`Found ${newChangeFilesCount} changefiles. All is good!`)

common/scripts/changelog/utils.mjs

@@ -1,11 +1,11 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-const NEW_CHANGE_FILE_REGEXP = /\s*change\/(.*\.json)\s*/;
-
 export function parseNewChangeFiles(stdout) {
+    // Split the output into lines
     const lines = stdout.split('\n');
-    const matches = lines.map(line => line.match(NEW_CHANGE_FILE_REGEXP)).filter(match => !!match);
-    // Extract the first capture group.
-    return matches.map(match => match[1]);
+    // Filter out the empty lines (`lines` list might have empty lines as part of the output)
+    const matches = lines.filter(line => line && line.toString().trim().length > 0);
+    // Parse the change file name from the output (remove the status and return only file information)
+    return matches.map(line => line.split('\t')[1]);
 }