Add default header (resolves #108)

release-it · Dec 23, 2024 · 6197330 · 6197330
1 parent f86194d
commit 6197330
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -146,6 +146,8 @@ Default value: `undefined`
 
 ### `header`
 
+Default value: `"# Changelog"`
+
 Set the main header for the changelog document:
 
 ```json

diff --git a/index.js b/index.js
@@ -166,7 +166,7 @@ class ConventionalChangelog extends Plugin {
   }
 
   async writeChangelog() {
-    const { infile, header: _header = '' } = this.options;
+    const { infile, header: _header = '# Changelog' } = this.options;
     let { changelog } = this.config.getContext();
     const header = _header.split(/\r\n|\r|\n/g).join(EOL);
-Original file line number
+Diff line change
@@ Expand Up / @@ -146,6 +146,8 @@ Default value: `undefined` @@
     ### `header`
+    Default value: `"# Changelog"`
     Set the main header for the changelog document:
     ```json
@@ Expand Down @@