Update dependency workspace-tools to ^0.40.0 (#1094)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Elizabeth Craig <elcraig@microsoft.com>

Author: renovate[bot]

change/beachball-25e2af71-4356-43fb-9a17-7762f74724d6.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Update dependency workspace-tools to ^0.40.0. This may improve detection of remote branch names in certain cases. It also includes stricter error checking for git operations, which may surface some errors which were previously hidden.",
+  "packageName": "beachball",
+  "email": "elcraig@microsoft.com",
+  "dependentChangeType": "patch"
+}

package.json

@@ -56,7 +56,7 @@
     "prompts": "^2.4.2",
     "semver": "^7.0.0",
     "toposort": "^2.0.2",
-    "workspace-tools": "^0.38.2",
+    "workspace-tools": "^0.40.0",
     "yargs-parser": "^21.0.0"
   },
   "devDependencies": {

src/__fixtures__/gitDefaults.ts

@@ -1,4 +1,4 @@
-import { type git, gitFailFast } from 'workspace-tools';
+import { gitFailFast, type GitOptions } from 'workspace-tools';
 
 export const defaultBranchName = 'master';
 export const defaultRemoteName = 'origin';
@@ -26,6 +26,6 @@ export function setDefaultBranchName(cwd: string, isRemoteRepo?: boolean): void
  * (This should NOT be used to make full snapshots of git logs, or as the primary means of testing.
  * But it can be useful for allowing backup checks for absence of strings like "warning" or "fatal".)
  */
-export function optsWithLang(opts?: Parameters<typeof git>[1]): Parameters<typeof git>[1] {
+export function optsWithLang(opts: GitOptions): GitOptions {
   return { ...opts, env: { ...opts?.env, LANG: 'en_US.UTF-8' } };
 }

src/__fixtures__/repository.ts

@@ -70,7 +70,7 @@ export class Repository {
       // Git logs are localized, so attempt to force this operation to use English so that the
       // warning check below works consistently. (It's not a big issue if it doesn't work, because
       // the warning check is just intended to make local test development easier in uncommon cases.)
-      optsWithLang()
+      optsWithLang({ cwd: this.rootPath })
     );
 
     // If git clone gives any warnings besides "you appear to have cloned an empty repository"

src/__functional__/changefile/writeChangeFiles.test.ts

@@ -64,7 +64,7 @@ describe('writeChangeFiles', () => {
     expect(cleanChangeFilePaths(repo.rootPath, changeFiles)).toEqual(expectedFiles);
 
     // and tracked
-    const trackedFiles = listAllTrackedFiles(['change/*'], repo.rootPath);
+    const trackedFiles = listAllTrackedFiles({ patterns: ['change/*'], cwd: repo.rootPath });
     expect(cleanChangeFilePaths(repo.rootPath, trackedFiles)).toEqual(expectedFiles);
 
     // and committed

src/__functional__/git/ensureSharedHistory.test.ts

@@ -28,7 +28,7 @@ describe('ensureSharedHistory', () => {
   const gitSpy = jest
     .spyOn(workspaceTools, 'git')
     // Attempt to force git to use English in logs, so we can check for absence of "warning" strings
-    .mockImplementation((args, opts) => (gitOverride || realGit)(args, optsWithLang(opts)));
+    .mockImplementation((args, opts) => (gitOverride || realGit)(args, opts && optsWithLang(opts)));
 
   /**
    * Get git spy calls, by default ignoring rev-parse (does ref exist/is shallow repo?)

src/changefile/getChangedPackages.ts

@@ -3,7 +3,7 @@ import path from 'path';
 import minimatch from 'minimatch';
 import type { ChangeFileInfo, ChangeInfoMultiple } from '../types/ChangeInfo';
 import { getChangePath } from '../paths';
-import { getChanges, getStagedChanges, git } from 'workspace-tools';
+import { getBranchChanges, getStagedChanges, git } from 'workspace-tools';
 import { getScopedPackages } from '../monorepo/getScopedPackages';
 import type { BeachballOptions } from '../types/BeachballOptions';
 import type { PackageInfos, PackageInfo } from '../types/PackageInfo';
@@ -78,7 +78,7 @@ function getAllChangedPackages(options: BeachballOptions, packageInfos: PackageI
       .map(pkg => pkg.name);
   }
 
-  const changes = [...(getChanges(branch, cwd) || []), ...(getStagedChanges(cwd) || [])];
+  const changes = [...(getBranchChanges({ branch, cwd }) || []), ...(getStagedChanges({ cwd }) || [])];
   verboseLog(`Found ${count(changes.length, 'changed file')} in branch "${branch}" (before filtering)`);
 
   if (!changes.length) {

src/changefile/readChangeFiles.ts

@@ -31,16 +31,16 @@ export function readChangeFiles(options: BeachballOptions, packageInfos: Package
   let filteredChangeFiles = allChangeFiles;
 
   if (fromRef) {
-    const changeFilesSinceFromRef = getChangesBetweenRefs(
+    const changeFilesSinceFromRef = getChangesBetweenRefs({
       fromRef,
-      'HEAD',
-      [
+      toRef: 'HEAD',
+      options: [
         '--diff-filter=d', // excluding deleted files from the diff.
         '--relative', // results will include path relative to the cwd, i.e. only file names.
       ],
-      '*.json',
-      changePath
-    );
+      pattern: '*.json',
+      cwd: changePath,
+    });
 
     filteredChangeFiles = allChangeFiles.filter(fileName => changeFilesSinceFromRef?.includes(fileName));
   }

src/changefile/writeChangeFiles.ts

@@ -16,7 +16,7 @@ export function writeChangeFiles(
 ): string[] {
   const { path: cwd, groupChanges, commit: commitChangeFiles } = options;
   const changePath = getChangePath(options);
-  const branchName = getBranchName(cwd);
+  const branchName = getBranchName({ cwd });
 
   if (!(Object.keys(changes).length && branchName)) {
     return [];
@@ -43,11 +43,11 @@ export function writeChangeFiles(
     });
   }
 
-  stage(changeFiles, cwd);
+  stage({ patterns: changeFiles, cwd });
   if (commitChangeFiles) {
     // only commit change files, ignore other staged files/changes
     const commitOptions = ['--only', path.join(changePath, '*.json')];
-    commit('Change files', cwd, commitOptions);
+    commit({ message: 'Change files', cwd, options: commitOptions });
   }
 
   console.log(

src/changelog/getPackageChangelogs.ts

@@ -35,7 +35,7 @@ export function getPackageChangelogs(
 
     if (includeCommitHashes) {
       changeFileCommits[changeFile] ??=
-        getFileAddedHash(path.join(changePath, changeFile), options.path) || commitNotAvailable;
+        getFileAddedHash({ filename: path.join(changePath, changeFile), cwd: options.path }) || commitNotAvailable;
     }
 
     changelogs[packageName].comments ??= {};