Release Command: When creating a release for a tag that isn't on remo…

…te, fallback to creating a tag pointing at the --to option
intuit · Mar 29, 2021 · d052139 · d052139
1 parent 11778dd
commit d052139
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 9 deletions.
diff --git a/packages/cli/src/parse-args.ts b/packages/cli/src/parse-args.ts
@@ -470,7 +470,7 @@ export const commands: AutoCommand[] = [
     description: endent`
       Create a GitHub release for a tag. Defaults to last tag in branch.
       
-      > NOTE: The tag must already be pushed to GitHub. If it isn't GitHub will create a tag pointing to the HEAD of you default branch.
+      > NOTE: The tag must already be pushed to GitHub. If it isn't GitHub will create a tag pointing to the "to" option value.
     `,
     options: [
       dryRun,
@@ -489,7 +489,7 @@ export const commands: AutoCommand[] = [
         type: String,
         group: "main",
         description:
-          "Git revision (tag, commit sha, ...) to end release notes at. Defaults to HEAD",
+          "Git revision (tag, commit sha, ...) to end release notes at. Defaults to HEAD.",
       },
       {
         name: "use-version",

diff --git a/packages/core/src/__tests__/auto.test.ts b/packages/core/src/__tests__/auto.test.ts
@@ -948,7 +948,8 @@ describe("Auto", () => {
       expect(auto.git!.publish).toHaveBeenCalledWith(
         "releaseNotes",
         "v1.2.4",
-        false
+        false,
+        ""
       );
       expect(afterRelease).toHaveBeenCalledWith(
         expect.objectContaining({
@@ -1013,7 +1014,8 @@ describe("Auto", () => {
       expect(auto.git!.publish).toHaveBeenCalledWith(
         "releaseNotes",
         "v1.2.4",
-        true
+        true,
+        ""
       );
       expect(afterRelease).toHaveBeenCalledWith(
         expect.objectContaining({
@@ -1052,7 +1054,8 @@ describe("Auto", () => {
       expect(auto.git!.publish).toHaveBeenCalledWith(
         "releaseNotes",
         "v1.2.4",
-        false
+        false,
+        ""
       );
       expect(afterRelease).toHaveBeenCalledWith(
         expect.objectContaining({
@@ -1091,7 +1094,8 @@ describe("Auto", () => {
       expect(auto.git!.publish).toHaveBeenCalledWith(
         "releaseNotes",
         "v1.3.0",
-        false
+        false,
+        ""
       );
       expect(afterRelease).toHaveBeenCalledWith(
         expect.objectContaining({
@@ -1130,7 +1134,8 @@ describe("Auto", () => {
       expect(auto.git!.publish).toHaveBeenCalledWith(
         "releaseNotes",
         "v1.2.3+1",
-        false
+        false,
+        ""
       );
       expect(afterRelease).toHaveBeenCalledWith(
         expect.objectContaining({

diff --git a/packages/core/src/auto.ts b/packages/core/src/auto.ts
@@ -193,6 +193,8 @@ export interface IAutoHooks {
       DryRunOption & {
         /** Commit to start calculating the version from */
         from: string;
+        /** Commit to end calculating the version from */
+        to: string;
         /** The version being released */
         newVersion: string;
         /** Whether the release being made is a prerelease */
@@ -551,7 +553,8 @@ export default class Auto {
         const release = await this.git!.publish(
           options.fullReleaseNotes,
           options.newVersion,
-          options.isPrerelease
+          options.isPrerelease,
+          options.to
         );
 
         this.logger.log.info(release.data.html_url);
@@ -1472,6 +1475,7 @@ export default class Auto {
     const release = await this.hooks.makeRelease.promise({
       commits,
       from: lastTag,
+      to: await this.git.getSha(),
       isPrerelease: true,
       newVersion,
       fullReleaseNotes: releaseNotes,
@@ -1983,6 +1987,7 @@ export default class Auto {
     const release = await this.hooks.makeRelease.promise({
       dryRun,
       from: lastRelease,
+      to: to || (await this.git.getSha()),
       isPrerelease,
       newVersion,
       fullReleaseNotes: releaseNotes,

diff --git a/packages/core/src/git.ts b/packages/core/src/git.ts
@@ -845,13 +845,19 @@ export default class Git {
   }
 
   /** Create a release for the GitHub project */
-  async publish(releaseNotes: string, tag: string, prerelease = false) {
+  async publish(
+    releaseNotes: string,
+    tag: string,
+    prerelease = false,
+    fallbackCommit?: string,
+  ) {
     this.logger.verbose.info("Creating release on GitHub for tag:", tag);
 
     const result = await this.github.repos.createRelease({
       owner: this.options.owner,
       repo: this.options.repo,
       tag_name: tag,
+      target_commitish: fallbackCommit,
       name: tag,
       body: releaseNotes,
       prerelease,