Add --no-git-commit option to changelog command

packages/cli/src/parse-args.ts

@@ -149,6 +149,13 @@ const dryRun: AutoOption = {
   group: "main",
 };
 
+const noGitCommit: AutoOption = {
+  name: "no-git-commit",
+  type: Boolean,
+  description: "Do not commit changes",
+  group: "main",
+};
+
 const url: AutoOption = {
   name: "url",
   type: String,
@@ -460,6 +467,7 @@ export const commands: AutoCommand[] = [
       changelogCommitMessage,
       baseBranch,
       quiet,
+      noGitCommit,
     ],
     examples: [
       {

packages/core/src/__tests__/auto.test.ts

@@ -862,6 +862,23 @@ describe("Auto", () => {
       expect(addToChangelog).not.toHaveBeenCalled();
     });
 
+    test("should not commit on noGitCommit", async () => {
+      const auto = new Auto(defaults);
+
+      auto.logger = dummyLog();
+      await auto.loadConfig();
+
+      const addToChangelog = jest.fn();
+      auto.release!.addToChangelog = addToChangelog;
+      const beforeCommitChangelog = jest.fn();
+      auto.hooks.beforeCommitChangelog.tap("test", beforeCommitChangelog);
+      jest.spyOn(auto.release!, "generateReleaseNotes").mockImplementation();
+
+      await auto.changelog({ from: "v1.0.0", noGitCommit: true });
+      expect(addToChangelog).toHaveBeenCalled();
+      expect(beforeCommitChangelog).not.toHaveBeenCalled();
+    });
+
     test("should be able to override title", async () => {
       const auto = new Auto(defaults);
 
@@ -1512,13 +1529,17 @@ describe("Auto", () => {
         } as any);
       jest.spyOn(auto.release!, "getCommitsInRelease").mockImplementation();
       jest.spyOn(auto.release!, "generateReleaseNotes").mockImplementation();
-      jest.spyOn(auto.release!, "addToChangelog").mockImplementation();
+      const addToChangelog = jest
+        .spyOn(auto.release!, "addToChangelog")
+        .mockImplementation();
       const beforeCommitChangelog = jest.fn();
       auto.hooks.beforeCommitChangelog.tap("test", beforeCommitChangelog);
       const afterChangelog = jest.fn();
       auto.hooks.afterChangelog.tap("test", afterChangelog);
 
       await auto.shipit({ noChangelog: true });
+
+      expect(addToChangelog).not.toHaveBeenCalled();
       expect(beforeCommitChangelog).not.toHaveBeenCalled();
       expect(afterChangelog).toHaveBeenCalled();
     });

packages/core/src/auto-args.ts

@@ -57,6 +57,11 @@ export interface DryRunOption {
   dryRun?: boolean;
 }
 
+export interface NoGitCommit {
+  /** Do not commit the changes */
+  noGitCommit?: boolean;
+}
+
 interface ChangelogTitle {
   /** Override the title use in the addition to the CHANGELOG.md. */
   title?: string;
@@ -70,13 +75,14 @@ export type IChangelogOptions = BaseBranch &
   QuietOption &
   DryRunOption &
   NoVersionPrefix &
+  NoGitCommit &
   Partial<AuthorInformation> & {
     /** Commit to start calculating the changelog from */
     from?: string;
     /** Commit to start calculating the changelog to */
     to?: string;
-    /** Don't commit the changelog */
-    noCommit?: boolean;
+    /** Do not make any changes to changelog file */
+    noChanges?: boolean;
   };
 
 export type IReleaseOptions = BaseBranch &

packages/core/src/auto.ts

@@ -1732,7 +1732,7 @@ export default class Auto {
     await this.makeChangelog({
       ...options,
       quiet: undefined,
-      noCommit: options.noChangelog,
+      noChanges: options.noChangelog,
     });
 
     if (!options.dryRun) {
@@ -1862,7 +1862,8 @@ export default class Auto {
       to,
       title,
       message = "Update CHANGELOG.md [skip ci]",
-      noCommit,
+      noGitCommit,
+      noChanges,
     } = options;
 
     if (!this.release || !this.git) {
@@ -1908,16 +1909,23 @@ export default class Auto {
       currentVersion,
     };
 
-    if (!noCommit) {
+    if (!noChanges) {
       await this.release.addToChangelog(
         releaseNotes,
         lastRelease,
         currentVersion
       );
 
-      await this.hooks.beforeCommitChangelog.promise(context);
-      await execPromise("git", ["commit", "-m", `"${message}"`, "--no-verify"]);
-      this.logger.verbose.info("Committed new changelog.");
+      if (!noGitCommit) {
+        await this.hooks.beforeCommitChangelog.promise(context);
+        await execPromise("git", [
+          "commit",
+          "-m",
+          `"${message}"`,
+          "--no-verify",
+        ]);
+        this.logger.verbose.info("Committed new changelog.");
+      }
     }
 
     await this.hooks.afterChangelog.promise(context);

packages/core/src/release.ts

@@ -263,10 +263,12 @@ export default class Release {
         : `v${version}`;
     });
 
-    this.logger.verbose.info("Adding new changes to changelog.");
+    const fileName = "CHANGELOG.md";
+
+    this.logger.verbose.info(`Adding new changes to ${fileName}.`);
     const title = await this.hooks.createChangelogTitle.promise();
 
-    await this.updateChangelogFile(title || "", releaseNotes, "CHANGELOG.md");
+    await this.updateChangelogFile(title || "", releaseNotes, fileName);
   }
 
   /**