Add option to disable commit hashes in changelogs (#1052)

Author: ecraig12345

change/beachball-ec0a58b8-699d-4d02-832d-e3ae639b0f70.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Add option to disable commit hashes in changelogs (`options.changelog.includeCommitHashes`, default true)",
+  "packageName": "beachball",
+  "email": "elcraig@microsoft.com",
+  "dependentChangeType": "patch"
+}

src/__tests__/changelog/getPackageChangelogs.test.ts

@@ -1,22 +1,23 @@
-import { describe, expect, it, jest } from '@jest/globals';
+import { afterEach, describe, expect, it, jest } from '@jest/globals';
 import { getPackageChangelogs } from '../../changelog/getPackageChangelogs';
 import type { BumpInfo } from '../../types/BumpInfo';
 import type { ChangeFileInfo, ChangeSet } from '../../types/ChangeInfo';
 import type { PackageInfos } from '../../types/PackageInfo';
 import { makePackageInfos } from '../../__fixtures__/packageInfos';
+import { getFileAddedHash } from 'workspace-tools';
 
 const commit = 'deadbeef';
 const author = 'something@something.com';
 
 // Mock the methods used from workspace-tools so we don't access the filesystem
 jest.mock('workspace-tools', () => ({
   findProjectRoot: () => '.',
-  getFileAddedHash: () => commit,
+  getFileAddedHash: jest.fn(() => commit),
 }));
 
-function makeChangeInfo(pkg: string, overrides?: Partial<ChangeFileInfo>): ChangeSet[number] {
+function makeChangeInfo(pkg: string, overrides?: Partial<ChangeFileInfo>, filename?: string): ChangeSet[number] {
   return {
-    changeFile: `${pkg}.json`,
+    changeFile: filename || `${pkg}.json`,
     change: {
       comment: `comment for ${pkg}`,
       dependentChangeType: 'patch',
@@ -28,12 +29,18 @@ function makeChangeInfo(pkg: string, overrides?: Partial<ChangeFileInfo>): Chang
   };
 }
 
-const options: Parameters<typeof getPackageChangelogs>[1] = {
+const options = {
   path: '.',
   changeDir: 'change',
 };
 
 describe('getPackageChangelogs', () => {
+  const getFileAddedHashMock = getFileAddedHash as jest.MockedFunction<typeof getFileAddedHash>;
+
+  afterEach(() => {
+    getFileAddedHashMock.mockClear();
+  });
+
   it('generates correct changelog entries for a single package', () => {
     const changeFileChangeInfos: ChangeSet = [
       makeChangeInfo('foo'),
@@ -60,7 +67,9 @@ describe('getPackageChangelogs', () => {
       tag: 'foo_v1.0.0',
       version: '1.0.0',
     });
-    expect(changelogs.foo.comments.patch).toHaveLength(1);
+
+    // the fake change files use the same default filename
+    expect(getFileAddedHashMock).toHaveBeenCalledTimes(1);
   });
 
   it('generates correct changelog entries for multiple packages', () => {
@@ -97,6 +106,8 @@ describe('getPackageChangelogs', () => {
       tag: 'bar_v2.0.0',
       version: '2.0.0',
     });
+
+    expect(getFileAddedHashMock).toHaveBeenCalledTimes(2);
   });
 
   it('preserves custom properties from change files', () => {
@@ -155,7 +166,7 @@ describe('getPackageChangelogs', () => {
       tag: 'bar_v2.0.0',
       version: '2.0.0',
     });
-    expect(Object.keys(changelogs.bar.comments.patch!)).toHaveLength(1);
+    expect(getFileAddedHashMock).toHaveBeenCalledTimes(1);
   });
 
   it('records multiple comment entries when a package has a change file AND was part of a dependent bump', () => {
@@ -220,4 +231,22 @@ describe('getPackageChangelogs', () => {
     expect(changelogs.bar).toBeTruthy();
     expect(changelogs['private-pkg']).toBeUndefined();
   });
+
+  it('omits commit hashes if requested', () => {
+    const changeFileChangeInfos: ChangeSet = [makeChangeInfo('foo')];
+    const packageInfos = makePackageInfos({ foo: { version: '1.0.0' } });
+
+    const changelogs = getPackageChangelogs(
+      {
+        changeFileChangeInfos,
+        calculatedChangeTypes: { foo: 'patch' },
+        packageInfos,
+      },
+      { ...options, changelog: { includeCommitHashes: false } }
+    );
+
+    expect(changelogs.foo.comments.patch).toHaveLength(1);
+    expect(changelogs.foo.comments.patch![0].commit).toBeUndefined();
+    expect(getFileAddedHashMock).not.toHaveBeenCalled();
+  });
 });

src/changelog/getPackageChangelogs.ts

@@ -20,9 +20,10 @@ const commitNotAvailable = 'not available';
 export function getPackageChangelogs(
   bumpInfo: Pick<BumpInfo, 'changeFileChangeInfos' | 'calculatedChangeTypes' | 'packageInfos'> &
     Partial<Pick<BumpInfo, 'dependentChangedBy'>>,
-  options: Pick<BeachballOptions, 'path' | 'changeDir'>
+  options: Pick<BeachballOptions, 'path' | 'changeDir' | 'changelog'>
 ): Record<string, PackageChangelog> {
   const { changeFileChangeInfos, calculatedChangeTypes, dependentChangedBy = {}, packageInfos } = bumpInfo;
+  const includeCommitHashes = options.changelog?.includeCommitHashes !== false;
 
   const changelogs: Record<string, PackageChangelog> = {};
   const changeFileCommits: { [changeFile: string]: string } = {};
@@ -32,8 +33,10 @@ export function getPackageChangelogs(
     const { packageName, type: changeType, dependentChangeType, email, ...rest } = change;
     changelogs[packageName] ??= createPackageChangelog(packageInfos[packageName]);
 
-    changeFileCommits[changeFile] ??=
-      getFileAddedHash(path.join(changePath, changeFile), options.path) || commitNotAvailable;
+    if (includeCommitHashes) {
+      changeFileCommits[changeFile] ??=
+        getFileAddedHash(path.join(changePath, changeFile), options.path) || commitNotAvailable;
+    }
 
     changelogs[packageName].comments ??= {};
     changelogs[packageName].comments[changeType] ??= [];
@@ -71,7 +74,7 @@ export function getPackageChangelogs(
           // split publishing into two commits (one for bumps and one for changelog updates),
           // there's no way to know the hash yet. It's better to record nothing than incorrect info.
           // https://github.com/microsoft/beachball/issues/901
-          commit: commitNotAvailable,
+          ...(includeCommitHashes && { commit: commitNotAvailable }),
         });
       }
     }

src/types/ChangeInfo.ts

@@ -22,7 +22,11 @@ export interface ChangeFileInfo {
  * Info saved in each change file, plus the commit hash.
  */
 export interface ChangeInfo extends ChangeFileInfo {
-  commit: string;
+  /**
+   * Commit hash where the change was made, if available.
+   * Will be undefined if `options.change.includeCommitHashes` is false.
+   */
+  commit?: string;
 }
 
 /**

src/types/ChangeLog.ts

@@ -25,8 +25,10 @@ export interface ChangelogEntry {
    *
    * Could also be `"not available"` for other commits if there was an issue determing the hash
    * at changelog generation time.
+   *
+   * Will be undefined if `options.change.includeCommitHashes` is false.
    */
-  commit: string;
+  commit?: string;
   /** Package name the change was in */
   package: string;
   /** Extra info added to the change file via custom prompts */

src/types/ChangelogOptions.ts

@@ -53,6 +53,13 @@ export interface ChangelogOptions {
    * (If the md file is truncated, it will include a comment about referring to git for older entries.)
    */
   maxVersions?: number;
+
+  /**
+   * If true (the default), each `CHANGELOG.json` entry and `ChangeInfo` object will include the
+   * commit hash where the change was made. This can be disabled for performance reasons.
+   * @default true
+   */
+  includeCommitHashes?: boolean;
 }
 
 /**