feat: add option that allows to include commit bodies in changelog (#606

)
invertase · Dec 1, 2023 · 524e58a · 524e58a
1 parent 69dda57
commit 524e58a
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 0 deletions.
diff --git a/packages/melos/lib/src/common/changelog.dart b/packages/melos/lib/src/common/changelog.dart
@@ -194,6 +194,23 @@ extension ChangelogStringBufferExtension on StringBuffer {
         }
 
         writeln();
+
+        final version = update.workspace.config.commands.version;
+
+        if (!version.includeCommitBody) continue;
+        if (parsedMessage.body == null) continue;
+
+        final shouldWriteBody =
+            !version.commitBodyOnlyBreaking || parsedMessage.isBreakingChange;
+
+        if (shouldWriteBody) {
+          writeln();
+          for (final line in parsedMessage.body!.split('\n')) {
+            write(' ' * 4);
+            writeln(line);
+          }
+          writeln();
+        }
       }
       writeln();
     }

diff --git a/packages/melos/lib/src/workspace_configs.dart b/packages/melos/lib/src/workspace_configs.dart
@@ -606,6 +606,8 @@ class VersionCommandConfigs {
     this.includeScopes = true,
     this.linkToCommits = false,
     this.includeCommitId = false,
+    this.includeCommitBody = false,
+    this.commitBodyOnlyBreaking = true,
     this.updateGitTagRefs = false,
     this.releaseUrl = false,
     List<AggregateChangelogConfig>? aggregateChangelogs,
@@ -726,11 +728,32 @@ class VersionCommandConfigs {
           )
         : VersionLifecycleHooks.empty;
 
+    final changelogCommitBodiesEntry = assertKeyIsA<Map<Object?, Object?>?>(
+          key: 'changelogCommitBodies',
+          map: yaml,
+          path: 'command/version',
+        ) ??
+        const {};
+
+    final includeCommitBodies = assertKeyIsA<bool?>(
+      key: 'include',
+      map: changelogCommitBodiesEntry,
+      path: 'command/version/changelogCommitBodies',
+    );
+
+    final bodiesOnlyBreaking = assertKeyIsA<bool?>(
+      key: 'onlyBreaking',
+      map: changelogCommitBodiesEntry,
+      path: 'command/version/changelogCommitBodies',
+    );
+
     return VersionCommandConfigs(
       branch: branch,
       message: message,
       includeScopes: includeScopes ?? true,
       includeCommitId: includeCommitId ?? false,
+      includeCommitBody: includeCommitBodies ?? false,
+      commitBodyOnlyBreaking: bodiesOnlyBreaking ?? true,
       linkToCommits: linkToCommits ?? repositoryIsConfigured,
       updateGitTagRefs: updateGitTagRefs ?? false,
       releaseUrl: releaseUrl ?? false,
@@ -756,6 +779,12 @@ class VersionCommandConfigs {
   /// Whether to add commits ids in the generated CHANGELOG.md.
   final bool includeCommitId;
 
+  /// Wheter to include commit bodies in the generated CHANGELOG.md.
+  final bool includeCommitBody;
+
+  /// Whether to only include commit bodies for breaking changes.
+  final bool commitBodyOnlyBreaking;
+
   /// Whether to add links to commits in the generated CHANGELOG.md.
   final bool linkToCommits;