add dry-run info to afterShipIt hook

intuit · Nov 18, 2020 · fd96fc7 · fd96fc7
1 parent 861412c
commit fd96fc7
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/docs/pages/docs/plugins/release-lifecycle-hooks.mdx b/docs/pages/docs/plugins/release-lifecycle-hooks.mdx
@@ -339,6 +339,7 @@ Ran after the `shipit` command has run.
   - `newVersion` - The new version that was release
   - `commits` - the commits in the release
   - `context` - The type of release that was created (`latest`, `next`, `canary`, or `old`)
+  - `dryRun` - Whether the run is a dry run
 
 ```ts
 auto.hooks.afterShipIt.tap("MyPlugin", async ({ context }) => {

diff --git a/packages/core/src/auto.ts b/packages/core/src/auto.ts
@@ -153,7 +153,7 @@ export interface IAutoHooks {
   /** Ran after the `shipit` command has run. */
   afterShipIt: AsyncParallelHook<
     [
-      {
+      DryRunOption & {
         /** The version published in the shipit run */
         newVersion: string | undefined;
         /** The commits the version was published for */
@@ -1532,6 +1532,7 @@ export default class Auto {
       newVersion,
       commitsInRelease,
       context,
+      dryRun: args.dryRun,
     });
   }
 

diff --git a/plugins/gradle/src/index.ts b/plugins/gradle/src/index.ts
@@ -238,8 +238,8 @@ export default class GradleReleasePluginPlugin implements IPlugin {
       ]);
     });
 
-    auto.hooks.afterShipIt.tapPromise(this.name, async () => {
-      if (!this.snapshotRelease) {
+    auto.hooks.afterShipIt.tapPromise(this.name, async ({ dryRun }) => {
+      if (!this.snapshotRelease || dryRun) {
         return;
       }
 

diff --git a/plugins/maven/src/index.ts b/plugins/maven/src/index.ts
@@ -277,8 +277,8 @@ export default class MavenPlugin implements IPlugin {
       ]);
     });
 
-    auto.hooks.afterShipIt.tapPromise(this.name, async () => {
-      if (!this.snapshotRelease) {
+    auto.hooks.afterShipIt.tapPromise(this.name, async ({ dryRun }) => {
+      if (!this.snapshotRelease || dryRun) {
         return;
       }