Merge pull request #2334 from amalik2/beforeVersion

feat: add in beforeVersion lifecycle hook
intuit · Mar 1, 2023 · f7827d4 · f7827d4
2 parents 296fa0e + a80cacf
commit f7827d4
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 5 deletions.
diff --git a/docs/pages/docs/plugins/release-lifecycle-hooks.mdx b/docs/pages/docs/plugins/release-lifecycle-hooks.mdx
@@ -95,6 +95,19 @@ _Other examples:_
 
 - [all-contributors](../generated/all-contributors) - Make a commit for new contributions
 
+## beforeVersion
+
+Ran before the package has been versioned. Useful for iterating through the list of
+commits that are going to be included in the current release, and applying/overriding
+the version bump (major/minor/patch) labels applied to the PRs corresponding to those commits.
+
+```ts
+auto.hooks.beforeVersion.tapPromise(
+  "NPM",
+  async ({ dryRun, commits, from }) => {}
+);
+```
+
 ## version
 
 Increment the version the package.

diff --git a/packages/core/src/auto.ts b/packages/core/src/auto.ts
@@ -240,6 +240,17 @@ export interface IAutoHooks {
       }
     ]
   >;
+  /** Ran before the package has been versioned. */
+  beforeVersion: AsyncSeriesHook<
+    [
+      DryRunOption & {
+        /** Commit to start calculating the version from */
+        from: string;
+        /** The commits included in the release */
+        commits: IExtendedCommit[];
+      }
+    ]
+  >;
   /** Version the package. This is a good opportunity to `git tag` the release also.  */
   version: AsyncSeriesHook<
     [
@@ -1727,6 +1738,18 @@ export default class Auto {
       throw this.createErrorMessage();
     }
 
+    const lastRelease = options.from || (await this.git.getLatestRelease());
+    const commitsInRelease = await this.release.getCommitsInRelease(
+      lastRelease
+    );
+
+    this.logger.verbose.info("Calling before version hook");
+    await this.hooks.beforeVersion.promise({
+      dryRun: options.dryRun,
+      commits: commitsInRelease,
+      from: lastRelease,
+    });
+
     const bump = await this.getVersion(options);
 
     this.logger.log.success(
@@ -1738,11 +1761,6 @@ export default class Auto {
       return;
     }
 
-    const lastRelease = options.from || (await this.git.getLatestRelease());
-    const commitsInRelease = await this.release.getCommitsInRelease(
-      lastRelease
-    );
-
     await this.makeChangelog({
       ...options,
       quiet: undefined,

diff --git a/packages/core/src/utils/make-hooks.ts b/packages/core/src/utils/make-hooks.ts
@@ -30,6 +30,7 @@ export const makeHooks = (): IAutoHooks => ({
   getPreviousVersion: new AsyncSeriesBailHook(),
   getRepository: new AsyncSeriesBailHook(),
   prCheck: new AsyncSeriesBailHook(["prInformation"]),
+  beforeVersion: new AsyncSeriesHook(["context"]),
   version: new AsyncSeriesHook(["version"]),
   afterVersion: new AsyncSeriesHook(["context"]),
   publish: new AsyncSeriesHook(["version"]),