From 53d6d6d82ee627a48eb96ba456c2f6732a43981b Mon Sep 17 00:00:00 2001 From: Robert Panzer Date: Sun, 29 Oct 2023 09:40:21 +0100 Subject: [PATCH] Group Changelog into breaking and compatible changes --- CHANGELOG.adoc | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index 7a8ab781..7f9cb76f 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -13,10 +13,28 @@ For a detailed view of what has changed, refer to the {url-repo}/commits/main[co == Unreleased +=== Breaking changes + +Improvement:: + +* Fix Macro APIs to take StructuralNodes and return Phrase- or StructuralNodes. (#1084) +* Allow Preprocessor extensions to create new Readers and replace the original Reader. (#1081) +* Set Java 11 as the minimal version (#1151) (@abelsromero) +* Remove deprecated methods in Options, OptionsBuilder, Attributes & AttributesBuilder (#1199) (@abelsromero) +* Remove deprecated methods from Asciidoctor interface (#1201) (@abelsromero) +* Remove deprecated methods from Document interface (#1202) (@abelsromero) +* Remove deprecated methods and constants from extension package (#1203) (@abelsromero) +* Remove deprecated methods from ast package (#1204) (@abelsromero) + +Bug Fixes:: + +* Fix CLI target file location for source files relative to source dir (#1135) (@AlexCzar) +* -s CLI option should be changed to -e to align with Asciidoctor (#1237) (@mojavelinux) + +=== Compatible changes + Improvement:: -* BREAKING: Fix Macro APIs to take StructuralNodes and return Phrase- or StructuralNodes. (#1084) -* BREAKING: Allow Preprocessor extensions to create new Readers and replace the original Reader. (#1081) * Add command line option --failure-level to force non-zero exit code from AsciidoctorJ CLI if specified logging level is reached. (#1114) * Upgrade to asciidoctorj 2.0.20 (#1208) * Upgrade to asciidoctorj-pdf 2.3.7 (#1182) @@ -28,7 +46,6 @@ Improvement:: * Replace use of deprecated 'numbered' attribute by 'sectnums' (#1123) (@abelsromero) * Expose `source` and `source_lines` use of deprecated 'numbered' in Document interface (#1145) (@abelsromero) * Accept 'null' as valid input (same as empty string) for load and convert String methods (#1148) (@abelsromero) -* Set Java 11 as the minimal version (#1151) (@abelsromero) * Create `asciidoctorj-cli` module to prevent unnecessary dependencies to asciidoctorj jar consumers (#1149) * Add required `--add-opens` to cli launch script to remove Jdk warnings (#1155) (@abelsromero) * Rename deprecated `headerFooter` option to the new `standalone` with same functionality (#1155) (@abelsromero) @@ -36,21 +53,14 @@ Improvement:: * Expose ImageReferences in the catalog (#1166) (@abelsromero) * Return Document AST when using convert or convertFile with appropriate options (#1171) (@abelsromero) * Expose Links in the catalog (#1183) (@abelsromero) -* BREAKING: Remove deprecated methods in Options, OptionsBuilder, Attributes & AttributesBuilder (#1199) (@abelsromero) -* BREAKING: Remove deprecated methods from Asciidoctor interface (#1201) (@abelsromero) -* BREAKING: Remove deprecated methods from Document interface (#1202) (@abelsromero) -* BREAKING: Remove deprecated methods and constants from extension package (#1203) (@abelsromero) -* BREAKING: Remove deprecated methods from ast package (#1204) (@abelsromero) Bug Fixes:: -* BREAKING: Fix CLI target file location for source files relative to source dir (#1135) (@AlexCzar) * Cell nodes do not inherit from StructuralNode (#1086) (@rahmanusta) * Avoid throwing an exception when using AsciidoctorJ CLI and reading input from stdin (#1105) (@AlexCzar) * Remove destinationDir Option from API (use toDir instead) (#853, #941) (@abelsromero) * Fix ConcurrentModificationException when converting to stream concurrently (#1158) (@rocketraman) * 'UnsupportedOperationException' when passing immutable Map as options to 'createPhraseNode' (#1221) (@abelsromero) -* -s CLI option should be changed to -e to align with Asciidoctor (#1237) (@mojavelinux) Build Improvement::