Skip to content

Latest commit

 

History

History
424 lines (280 loc) · 13.9 KB

CHANGELOG.adoc

File metadata and controls

424 lines (280 loc) · 13.9 KB
Raw

Asciidoctor Changelog

This document provides a high-level view of the changes introduced in AsciidoctorJ by release. For a detailed view of what has changed, refer to the commit history on GitHub.

Unreleased

3.0.0 (2024-08-25)

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)

  • Add Automatic-Module-Name manifest entry to core, api, and cli for reserving stable JPMS module names (#1240) (@leadpony)

  • Remove Java 'requires open access' module warning in modern Java versions (#1246)

  • Add Reader.getSource() and Reader.getSourceLines() (#1262)

Bug Fixes

  • -s CLI option should be changed to -e to align with Asciidoctor (#1237) (@mojavelinux)

  • Column#setWidth is ignored (#1265) (@Vampire)

  • Fix unresolvable dependency of JRuby Gradle plugin. (#1275)

Compatible changes

Improvement

  • Add setContext function to StructuralNode.

  • 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.23 (#1280)

  • Upgrade to asciidoctorj-pdf 2.3.18 (#1280)

  • Upgrade to asciidoctorj-revealjs 5.1.0 (#1256)

  • Upgrade to asciidoctorj-diagram 2.3.1 (#1280)

  • Upgrade to asciidoctorj-diagram-jsyntrax 1.38.2 (#1282)

  • Upgrade to JRuby 9.4.8.0 (#1280)

  • Upgrade to tilt 2.0.11 (#1109)

  • Upgrade to asciimath 2.0.4 (#1109)

  • Expose sectnum property in Section interface (#1121)

  • 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)

  • 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)

  • Remove class AsciidoctorUtils to remove complexity and unused logging (#1169) (@abelsromero)

  • 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)

Bug Fixes

  • 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 CLI target file location for source files relative to source dir (#1135) (@AlexCzar)

  • Fix ConcurrentModificationException when converting to stream concurrently (#1158) (@rocketraman)

  • 'UnsupportedOperationException' when passing immutable Map as options to 'createPhraseNode' (#1221) (@abelsromero)

Build Improvement

  • Upgrade build to Gradle 8.5 (#1256)

  • Upgrade Spring Boot test to 3.0.0 (#1134)

  • Fix upstream tests forcing SNAPSHOT on Asciidoctor gem installation (#1123) (@abelsromero)

  • Fix upstream build removing the explicit plugin repository (#1131)

  • Set JUnit5 as default test engine (#1186) (@abelsromero)

  • Removed pollutedTest Gradle task using junit-pioneer (#1193) (@abelsromero)

  • Ignore 'docs/**' changes in CI (#1225) (@abelsromero)

  • Add test for ensuring that asciidoctor version is available in CLI (#1230) (@abelsromero)

  • Run tests on Java 21 (#1236) (@abelsromero)

Documentation

2.5.4 (2022-06-30)

Improvement

  • Upgrade to asciidoctorj-diagram 2.2.3 (#1091)

  • Upgrade to jcommander 1.81 (#1079)

  • Upgrade to JRuby 9.3.4.0 (#1085)

  • Upgrade to Rouge 3.28.0 (#1085)

Bug Fixes

  • Make DescriptionList.getBlocks() return null instead of a List of DescriptionListItems resulting in a ClassCastException (#1082) (@someth2say)

Build Improvement

  • Upgrade to gradle 7.4.2 (#1086)

  • Upgrade to Wildfly 26.0.1 for integration test (#1085)

  • Upgrade to Spring Boot 2.6.5 for integration test (#1085)

  • Fix gem version check task (#1087)

  • Release from Github Actions (#1090)

Documentation

== 2.5.3 (2022-01-12)

Improvement

  • Upgrade to asciidoctorj 2.0.17 (#1074)

  • Upgrade to asciidoctorj-pdf 1.6.2 (#1073)

  • Upgrade to asciidoctorj-diagram 2.2.1 (#1066) (@abelsromero) (#1065)

  • Upgrade to jruby 9.2.20.1 (#1074)

  • Upgrade to rouge 3.27.0 (#1073)

  • Upgrade CLI to use JCommander 1.81 (@abelsromero) (#1067)

Build Improvement

  • Add Java17 to CI pipelines (@abelsromero) (#1055)

  • Improve pipelines to better display Asciidoctor test upstream (@abelsromero) (#1057)

Documentation

  • Clarify execution order for extensions (@rockyallen) (#1068)

  • Added docs for attributes and positional attributes in extensions (#1072)

  • Added docs for how to log from extensions (#1071)

2.5.2 (2021-08-08)

Improvement

  • Upgrade to asciidoctorj 2.0.16 (#1052)

  • Upgrade to asciidoctorj-pdf 1.6.0 (#1040)

Bug Fixes

  • Avoid using of deprecated attributes toc2 and toc-placement. Deprecated Attributes.setTableOfContents2(). Added new constants Placement.PREAMBLE and Placement.MACRO as parameters for Attributes.setTableOfConstants(). (@abelsromero) (#1037)

Build Improvement

  • Use JavaCompile options.release instead of sourceCompatibility and targetCompatibility to target Java 8 (#1042)

  • Upgrade nexus publishing and staging to new gradle-nexus.publish-plugin (#1043)

  • Upgrade remaining dependency on junit 4.12 to 4.13.2 (#1044)

2.5.1 (2021-05-04)

Improvement

  • Upgrade to asciidoctor 2.0.15 (#1026)

  • Upgrade to asciidoctor-epub 1.5.1 (#1030)

Bug Fixes

  • Fix performance regression in v2.5.0 with asciidoctorj-pdf and concurrent-ruby (@kedar-joshi) (#1032)

Build Improvement

  • Upgrade to sdkman vendor plugin 2.0.0

  • Remove builds on appveyor (#1027)

Build / Infrastructure

  • Upgrade test dependencies on Arquillian and Spock (#1031)

2.5.0 (2021-04-27)

Improvement

  • Allow defining @Name as a meta annotation on Block and Inline Macros (@uniqueck) (#898)

  • Upgrade to jruby 9.2.17.0 (#1004)

  • Upgrade to asciidoctorj-diagram 2.1.2 (#1004)

  • Add getRevisionInfo method to Document. Make DocumentHeader class and readDocumentHeader methods as deprecated (@abelsromero) (#1008)

  • Add getAuthors method to Document (@abelsromero) (#1007)

  • Upgrade to asciidoctor 2.0.14 (#1016)

  • Deprecated methods Asciidoctor, Options and Attributes API scheduled for future removal (@abelsromero)(#1015)

  • Add pushInclude to PreprocessorReaderImpl and deprecate push_include (@abelsromero) (#1020)

Build Improvement

  • Fix wildfly integration test on Java 16 (@abelsromero) (#1002)

  • Upgrade Gradle to 7.0.0 (#1001)

  • Fix URL for distribution in sdkman (#990)

  • Update gradle plugin biz.aQute.bnd to 5.3.0 (#1001)

  • Run Github actions for main branch (#1017)

Documentation

  • Add Spring Boot integration test and usage guide (@abelsromero) (#994, #995)

2.4.3 (2021-02-12)

Improvement

  • Upgrade to asciidoctorj-pdf 1.5.4 (#986)

  • Upgrade to asciidoctorj-revealjs 4.1.0 (#986)

  • Upgrade to asciidoctorj-diagram 2.1.0 (#986)

  • Upgrade to jruby 9.2.14.0 (#986)

  • Upgrade to rouge 3.26.0 (#986)

  • Add constant for attribute toclevel (@l0wlik34G6) (#984)

Build Improvement

  • Publish directly to Maven Central (#988)

  • Upgrade Gradle to 6.8.2 (#988)

2.4.2 (2020-11-10)

Improvement

  • AST now provides access to document catalog footnotes and refs (@lread) (#968)

  • Upgrade to Asciidoctor 2.0.12 (#972)

  • Upgrade to Asciidoctor EPUB3 1.5.0-alpha.19 (#972)

  • Upgrade to rouge 3.24.0 (#972)

  • Upgrade to coderay 1.1.3 (#972)

2.4.1 (2020-09-10)

Build

  • Make SyntaxHighlighter test independent of highlight.js version (@abelsromero) (#955)

Bug Fixes

  • Fix NullPointerException when a document contains an empty table with PDF backend (@anthonyroussel) (#944)

Improvement

  • Upgrade to JRuby 9.2.13.0 (#948)

2.4.0 (2020-07-19)

Improvement

  • Add method StructuralNode.setLevel() (@Mogztter) (#931)

  • Upgrade to JRuby 9.2.12.0 removing the last illegal access warnings (#935)

  • Upgrade to Asciidoctor EPUB3 1.5.0-alpha.16 (#939)

  • Upgrade to Rouge 3.21.0

Build

  • Fix upstream build to adapt to changes in Ruby Highlightjs syntax highlighter (#940)

2.3.1 (2020-06-17)

Bug Fixes

  • Inline macro attribute parsing changes after first document conversion (@wilkinsona) (#926)

  • Upgrade to Rouge 3.20.0, fixing error uninitialized constant Rouge::Lexers problem (@ahus1) (#925)

2.3.0 (2020-05-02)

Improvement

  • Add asciidoctor-revealjs to distribution (#910)

  • Upgrade to Asciidoctor PDF 1.5.3

  • Upgrade to Asciidoctor EPUB3 1.5.0-alpha.16

  • Upgrade to Asciidoctor Diagram 2.0.2

  • Upgrade to JRuby 9.2.11.1

Bug Fixes

  • Add missing factory methods to create Lists. (@glisicivan) (#916) The API Processor.createList() is experimental and may change with any release until declared to be stable.

Documentation

  • Update documentation to show how to create an Asciidoctor instance with GEM_PATH (#890)

  • Adds GitHub icons to admonitions sections in README (#893)

  • Updates CI note in README to replace TravisCI by GH Actions (@abelsromero) (#938)

Build

  • Upgrade to jruby-gradle-plugin 2.0.0

  • Remove CI build on TravisCI (#918)

Known Limitations:

  • The createList() and createListItem() API is not able to create DescriptionLists.

2.2.0 (2019-12-17)

Improvement

  • Upgrade to JCommander 1.72 (@Fiouz) (#782)

  • Set logger name on logged log records (@lread) (#834)

  • Upgrade to JRuby 9.2.8.0 (@ahus1) (#850)

  • Upgrade to JRuby 9.2.9.0

  • Upgrade to Asciidoctor PDF 1.5.0-beta.8

  • Upgrade to Asciidoctor Diagram 2.0.0

  • Upgrade to Rouge 3.12.0

  • Use headless jdk on all platforms (@nicerloop) (#863)

Bug Fixes

  • Remove exception protection from LogHandler in JRubyAsciidoctor to align behaviour with AbstractConverter (@abelsromero) (#844)

  • Make Asciidoctor API AutoClosable (@rmannibucau) (#849)

  • Fix reading input from stdin and writing to stdout (@nicerloop) (#865)

  • Assign distinct Osgi Bundle-SymbolicNames to asciidoctorj-api.jar and asciidoctorj.jar (@rmannibucau) (#878)

Build

  • Upgrade to Gradle 5.6.3 (@Fiouz) (#747 #856)

  • Support build from paths with whitespace (@Fiouz) (#836)

  • OSGi: switch to biz.aQute.bnd plugin (@Fiouz) (#855)

  • Fix publishing to Bintray with Gradle 5.6.3 (@Fiouz) (#862)

Documentation

  • Update README about running on WildFly (@anthonyvdotbe) (#848)

  • link to tarball; add Quick Win section (@il-pazzo) (#854)

2.1.0 (2019-06-22)

Improvements

  • Add the command line option -R to specify the source root directory (@4lber10 & @ysb33r) (#822)

  • Add sourcemap, catalog_assets and parse to OptionBuilder (@jmini) (#825)

  • Upgrade to Asciidoctor 2.0.10

  • Upgrade to Asciidoctor Diagram 1.5.0-alpha.18

  • Upgrade to Asciidoctor PDF 1.5.0-alpha.18

  • Added an experimental API to write Syntax Highlighters in Java (#826)

Documentation

  • Clarify that an InlineMacroProcessor should return a PhraseNode and that Strings are deprecated. (@jmini) (#823)

2.0.0 (2019-04-24)

Enhancements
Improvements

  • Upgrade to Asciidoctor 2.0.8

  • Upgrade to asciidoctor-pdf 1.5.0-alpha.17 (#809)

  • Add Rouge source highlighter to asciidoctor.jar (#806)

Bug Fixes

 

2.0.0-RC.3 (2019-04-18)

Enhancements

  • Extended version info printed by asciidoctorj --version to show versions of Asciidoctor and AsciidoctorJ separately (@abelsromero) (#791)

  • Allow custom converters to log (#801)

Improvements

  • Upgrade to JRuby 9.2.7.0 (#796)

Bug Fixes

  • Fix logger registration when creating AsciidoctorJ instance with Asciidoctor.Factory.create (@ahus1) (#790)

2.0.0-RC.2 (2019-04-09)

Enhancements

  • Add section numeral API (@vmj) (#785)

Improvements

  • Upgrade to Asciidoctor 2.0.6

  • Upgrade to Asciidoctor ePub3 1.5.9

Bug Fixes

  • Fix logger implementation (#786)

2.0.0-RC.1 (2019-03-27)

Enhancements

  • Move the Asciidoctor interface into the asciidoctorj-module (@Mogztter) (#760)

  • Remove deprecated render() methods from Asciidoctor interface (@Mogztter) (#760)

Improvements

  • Upgrade to JRuby 9.2.6.0. This version of AsciidoctorJ is incompatible with any version of JRuby ⇐ 9.2.5.0

  • Upgrade to Asciidoctor 2.0.2

  • Upgrade to Asciidoctor Diagram 1.5.16

Bug Fixes

  • Fix extension initialization in OSGi environments (#754)

  • Remove reference to RubyExtensionRegistryImpl from RubyExtensionRegistry (#759)

  • Don’t return null from List.blocks() and DefinitionList.blocks() (@jensnerche) (#761)

  • Move org.asciidoctor.spi.ProcessorFactory to org.asciidoctor.extension (@jensnerche) (#762)

Documentation

  • Update documentation for running AsciidoctorJ in OSGi (@twasyl) (#765)

Build / Infrastructure

  • Fix jruby-maven-plugin and upstream build (@mkristian) (#777)

1.6.1 (2018-10-28)

Enhancements

  • Upgrade asciidoctorj-diagram to 1.5.12

Bug Fixes

  • Fix registration of extension as instances (#754)

Documentation

  • Add extension migration guide