fix: change formatCommitMessage and introduce formatPullRequestTitle (#…

…270)
algolia · Sep 23, 2019 · f21e167 · f21e167
1 parent 53862e8
commit f21e167
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 37 deletions.
diff --git a/packages/shipjs-lib/src/lib/config/__tests__/defaultConfig.spec.js b/packages/shipjs-lib/src/lib/config/__tests__/defaultConfig.spec.js
@@ -1,6 +1,7 @@
 import defaultConfig from '../defaultConfig';
 const {
   formatCommitMessage,
+  formatPullRequestTitle,
   formatPullRequestMessage,
   mergeStrategy: defaultMergeStrategy,
   shouldRelease,
@@ -13,7 +14,7 @@ describe('defaultConfig', () => {
 
   it('formatCommitMessage', () => {
     const version = '0.1.2';
-    expect(formatCommitMessage({ version })).toBe(`chore: release v0.1.2`);
+    expect(formatCommitMessage({ version })).toBe(`chore: prepare v0.1.2`);
   });
 
   describe('formatPullRequestMessage', () => {
@@ -29,15 +30,19 @@ describe('defaultConfig', () => {
         toReleaseBranch: {},
       };
       const destinationBranch = 'master';
-      const message = formatPullRequestMessage({
-        repoURL,
-        baseBranch,
-        stagingBranch,
-        destinationBranch,
-        mergeStrategy,
-        currentVersion,
-        nextVersion,
-      });
+      const message = [
+        formatPullRequestTitle({ version: nextVersion }),
+        '',
+        formatPullRequestMessage({
+          repoURL,
+          baseBranch,
+          stagingBranch,
+          destinationBranch,
+          mergeStrategy,
+          currentVersion,
+          nextVersion,
+        }),
+      ].join('\n');
       expect(message).toMatchInlineSnapshot(`
         "chore: release v0.1.1
 
@@ -62,7 +67,9 @@ describe('defaultConfig', () => {
         },
       };
       const destinationBranch = 'release/stable';
-      expect(
+      const message = [
+        formatPullRequestTitle({ version: nextVersion }),
+        '',
         formatPullRequestMessage({
           repoURL,
           baseBranch,
@@ -71,8 +78,9 @@ describe('defaultConfig', () => {
           mergeStrategy,
           currentVersion,
           nextVersion,
-        })
-      ).toMatchInlineSnapshot(`
+        }),
+      ].join('\n');
+      expect(message).toMatchInlineSnapshot(`
         "chore: release v0.1.1
 
         ## Release Summary
@@ -111,11 +119,11 @@ describe('defaultConfig', () => {
         currentVersion,
         currentBranch,
         mergeStrategy,
-        formatCommitMessage,
+        formatPullRequestTitle,
       });
       expect(result).toMatchInlineSnapshot(`
                 "The commit message should have started with the following:
-                chore: release v0.1.2"
+                ${commitMessage}"
             `);
     });
 
@@ -130,7 +138,7 @@ describe('defaultConfig', () => {
         currentVersion,
         currentBranch,
         mergeStrategy,
-        formatCommitMessage,
+        formatPullRequestTitle,
       });
       expect(result).toBe(true);
     });
@@ -148,7 +156,7 @@ describe('defaultConfig', () => {
         currentVersion,
         currentBranch,
         mergeStrategy,
-        formatCommitMessage,
+        formatPullRequestTitle,
       });
       expect(result).toBe(true);
     });
@@ -166,7 +174,7 @@ describe('defaultConfig', () => {
         currentVersion,
         currentBranch,
         mergeStrategy,
-        formatCommitMessage,
+        formatPullRequestTitle,
       });
       expect(result).toMatchInlineSnapshot(
         `"The current branch needs to be one of [master, release/legacy]"`

diff --git a/packages/shipjs-lib/src/lib/config/defaultConfig.js b/packages/shipjs-lib/src/lib/config/defaultConfig.js
@@ -12,7 +12,8 @@ export default {
   versionUpdated: ({ version, dir, exec }) => {},
   beforeCommitChanges: ({ exec }) => {},
   getStagingBranchName: ({ nextVersion }) => `releases/v${nextVersion}`,
-  formatCommitMessage: ({ version }) => `chore: release v${version}`,
+  formatCommitMessage: ({ version }) => `chore: prepare v${version}`,
+  formatPullRequestTitle: ({ version }) => `chore: release v${version}`,
   formatPullRequestMessage: ({
     repoURL,
     baseBranch,
@@ -23,8 +24,6 @@ export default {
     nextVersion,
   }) => {
     const lines = [
-      `chore: release v${nextVersion}`,
-      '',
       '## Release Summary',
       `- Version change: \`v${currentVersion}\` → \`v${nextVersion}\``,
       `- Merge: \`${stagingBranch}\` → \`${destinationBranch}\``,
@@ -51,15 +50,16 @@ export default {
     currentVersion,
     currentBranch,
     mergeStrategy,
-    formatCommitMessage,
+    formatPullRequestTitle,
   }) => {
-    const correctCommitMessage =
-      commitMessage.trim() === formatCommitMessage({ version: currentVersion });
-    if (!correctCommitMessage) {
+    const correctCommitMessage = formatPullRequestTitle({
+      version: currentVersion,
+    });
+    if (commitMessage.trim() !== correctCommitMessage) {
       return (
         'The commit message should have started with the following:' +
         '\n' +
-        `chore: release v${currentVersion}`
+        `${correctCommitMessage}`
       );
     }
     if (

diff --git a/packages/shipjs/src/step/prepare/createPullRequest.js b/packages/shipjs/src/step/prepare/createPullRequest.js
@@ -18,6 +18,7 @@ export default ({
     ({ print, warning, run, exitProcess }) => {
       const {
         mergeStrategy,
+        formatPullRequestTitle,
         formatPullRequestMessage,
         pullRequestReviewer,
         remote,
@@ -47,15 +48,19 @@ export default ({
         exitProcess(0);
       }
       const repoURL = getRepoURL(remote, dir);
-      const message = formatPullRequestMessage({
-        repoURL,
-        baseBranch,
-        stagingBranch,
-        destinationBranch,
-        mergeStrategy,
-        currentVersion,
-        nextVersion,
-      });
+      const message = [
+        formatPullRequestTitle({ version: nextVersion }),
+        '',
+        formatPullRequestMessage({
+          repoURL,
+          baseBranch,
+          stagingBranch,
+          destinationBranch,
+          mergeStrategy,
+          currentVersion,
+          nextVersion,
+        }),
+      ].join('\n');
       const filePath = tempWrite.sync(message);
       run(`git remote prune ${remote}`, dir, dryRun);
       const createPullRequestCommand = [

diff --git a/packages/shipjs/src/step/release/validate.js b/packages/shipjs/src/step/release/validate.js
@@ -11,7 +11,7 @@ export default ({ config, dir }) =>
     ({ print, info, warning, exitProcess }) => {
       const {
         mergeStrategy,
-        formatCommitMessage,
+        formatPullRequestTitle,
         shouldRelease,
         monorepo,
       } = config;
@@ -26,7 +26,7 @@ export default ({ config, dir }) =>
         currentVersion,
         currentBranch,
         mergeStrategy,
-        formatCommitMessage,
+        formatPullRequestTitle,
       });
       if (validationResult !== true) {
         print(warning('Skipping a release due to the following reason:'));