v0.7.1 (#18)

Author: f3ath

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 This project follows [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.1] - 2023-06-11
+### Added
+- The `printChanges() function to print changes only and skip the header part
+
 ## [0.7.0] - 2023-06-11
 ### Added
 - Keep freetext directly under release headings
@@ -118,6 +122,7 @@ This project follows [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.
 - Parsing from markdown
 - Writing to markdown
 
+[0.7.1]: https://github.com/f3ath/change/compare/0.7.0...0.7.1
 [0.7.0]: https://github.com/f3ath/change/compare/0.6.0...0.7.0
 [0.6.0]: https://github.com/f3ath/change/compare/0.5.0...0.6.0
 [0.5.0]: https://github.com/f3ath/change/compare/0.4.0...0.5.0

lib/src/printer.dart

@@ -25,6 +25,14 @@ String printUnreleased(Section unreleased) => render(
       flavor: flavors.changelog,
     );
 
+/// Converts the Unreleased/Release [section] to a markdown string.
+/// This is the same as [printRelease] and [printUnreleased] but skips
+/// the header line and the bottom (non-inline) links section.
+String printChanges(Section section) => render(
+      _changes(section),
+      flavor: flavors.changelog,
+    );
+
 final _iso8601 = DateFormat('yyyy-MM-dd').format;
 
 Iterable<Node> _changelog(Changelog log,
@@ -46,7 +54,6 @@ Iterable<Element> _unreleased(Section section) sync* {
     header.add(_link(sectionLink, [text]));
   }
   yield Element('h2', header);
-  yield* section.preamble;
   yield* _changes(section);
 }
 
@@ -64,11 +71,11 @@ Iterable<Element> _release(Release release) sync* {
     header.add(Text(' [YANKED]'));
   }
   yield Element('h2', header);
-  yield* release.preamble;
   yield* _changes(release);
 }
 
 Iterable<Element> _changes(Section section) sync* {
+  yield* section.preamble;
   final types = Set.of(section.changes().map((e) => e.type)).toList();
   types.sort();
   for (final type in types) {

pubspec.yaml

@@ -1,5 +1,5 @@
 name: change
-version: 0.7.0
+version: 0.7.1
 description: A Changelog manipulation library. Read/modify/write your CHANGELOG.md. Inspired by keepachangelog.com.
 homepage: "https://github.com/f3ath/change"
 

test/changelog_test.dart

@@ -154,6 +154,44 @@ void main() {
             '[0.0.1]: https://example.com',
           ].join('\n'));
     });
+
+    test('Can print changes from a release', () {
+      final release =
+          Release(Version.parse('0.0.1'), DateTime.parse('2020-02-02'));
+      release.add(Change('Added', [Text('Some change')]));
+      release.add(Change('Fixed', [Text('A nasty bug')]));
+      release.preamble.add(Element('p', [Text('This is the preamble.')]));
+      release.link = 'https://example.com';
+      expect(
+          printChanges(release),
+          [
+            'This is the preamble.',
+            '',
+            '### Added',
+            '- Some change',
+            '',
+            '### Fixed',
+            '- A nasty bug',
+          ].join('\n'));
+    });
+
+    test('Can print unreleased changes', () {
+      final unreleased = Section();
+      unreleased.add(Change('Added', [Text('Some change')]));
+      unreleased.add(Change('Fixed', [Text('A nasty bug')]));
+      unreleased.preamble.add(Element('p', [Text('This is the preamble.')]));
+      expect(
+          printChanges(unreleased),
+          [
+            'This is the preamble.',
+            '',
+            '### Added',
+            '- Some change',
+            '',
+            '### Fixed',
+            '- A nasty bug',
+          ].join('\n'));
+    });
   });
 
   group('Non-standard', () {