Releases: asciidoctor/asciidoctorj
v1.6.0
AsciidoctorJ 1.6.0
AsciidoctorJ 1.6.0 is a final, transitional release in preparation for the switch to Semantic Versioning (SemVer). Despite its version number, this is a major release and, as such, not binary compatible with the 1.5.x releases.
Improvements
There are loads of changes that made it into this release, so it's difficult to enumerate them all. In fact, since the development of 1.6.0 ran in parallel with 1.5.x for so long, many changes from 1.6.0 may already be familiar to you as they got backported into the 1.5.x release line.
The most prominent changes in 1.6.0 are as follows:
- Rework Extension API. Please check the Integrator Guide for a documentation about how it looks now.
- Add ExtensionGroup API and fix registration of multiple extensions (#568)
- Reworked AST API, including renaming of classes.
- Split org.asciidoctor package into api and impl modules. (#603, @jmini)
- Added converter API
- Add support for capturing and routing log messages from Asciidoctor (#657)
- Add documentation for the AsciidoctorJ logger (#674, @abelsromero)
- Added annotation-based processor configuration (#341)
- Add support for creating tables structures to Extension API (#335)
- Add support for Lists and Definition Lists to AST (#408)
- Loads of cleanups and improvements across the API (#715, #717, @Mogztter)
- Added method to get and remove substitutions (#504)
- Rename isAttr(), setAttr() and getAttr() to more Java like names, isAttribute(), setAttribute() and getAttribute(). (#554)
- Allow for method chaining when registering extensions (#491)
- Upgrade to Gradle 4.4.1 (#611, @tisoft)
- Remove ContentPart and StructuredDocument API (#699)
Bug fixes
There are a lot of bugs that were fixed regarding the extension API. Some of these may have already made it into 1.5.x as long as they did not require architectural changes. To list a few:
- Support for source_location (#351, @ysb33r)
- Numerous fixes for the build process (#474, #482, #469, @ancho)
- Numerous fixes around errors in extensions, as an example (@459 , @ahus1)
You can find more details about this release and its future at asciidoctor.org
Migration notes
Migrating extensions from 1.5.x to 1.6.0 requires some changes, that should in general not be too hard. As examples you might compare extensions from the test cases:
Thanks
This release wouldn't have been possible without the help of all our awesome contributors:
- @abelsromero
- @ahus1
- @lordofthejars
- @mojavelinux
- @ancho
- gerald@wireshark.org
- @Mogztter
- @htmfilho
- @innovimax
- @jmini
- @kduske-n4
- @tisoft
- @ysb33r
- @msgilligan
- @sschuberth
- @t-h-a-l-i-s
- @twasyl
- @lefou
- @mmews-n4
If I left anyone off this list, I sincerely apologize. We're certainly thankful for each and every contribution!
Release Meta
Released on: 2019-01-01
Released by: @robertpanzer
Release beer: TBD
v1.6.0-RC.2
This release is the second release candidate of AsciidoctorJ 1.6.0 and brings some refactoring that are important to pave the way for a JS based implementation.
Also some deprecated members were removed.
Other methods were marked as deprecated and will be removed with 2.0.0.
Huge thanks to @Mogztter for driving the changes that led this RC!
Improvements
- Mark render* methods as deprecated (and replace usage) (#731 @Mogztter)
- Bump JRuby to 9.2.4.0 (#727)
- Update documentation for using AsciidoctorJ in an OSGi environment (#721 @twasyl)
- Use diamond, remove unnecessary public keyword on interfaces (#720 @Mogztter)
- Move extension annotations and enums to the API module (#719, @Mogztter)
- Build: Use imagesdir and outdir otherwise the image is written in the subproject root (#718, @Mogztter)
- Replace deprecated constants and methods in the extension package (#717, @Mogztter)
Release Meta
Released on: 2018-11-22
Released by: @robertpanzer
Release beer: TBD
v1.6.0-RC.1
This release is the first release candidate of AsciidoctorJ 1.6.0 and brings the latest versions of asciidoctor and asciidoctor-diagram to AsciidoctorJ
Improvements
- Upgrade asciidoctor to 1.5.8
- Upgrade asciidoctor-diagram to 1.5.10
- #699 Remove ContentPart and StructuredDocument API.
- #700 Refactored JavaConverterRegistry, JavaExtensionRegistry and RubyExtensionRegistry into interfaces
- #670 Add docs for LogHandler (@abelsromero)
Bug fixes
- #508 Allow to set sourcemap option from Preprocessor (@kduske-n4)
- #698 Fix timings option
-t - #689 Made warnings for invalid refs only available under verbose mode
-v. - #686 Add sources of asciidoctorj-api to javadocs of asciidoctorj (@mojavelinux)
Release Meta
Released on: 2018-10-31
Released by: @robertpanzer
Release beer: Stock is empty :(
v1.5.8.1
This release brings an important bug fix when running AsciidoctorJ in a multithreaded environment when using custom converters like the PDF backend
Bug fixes
- #707 Add concurrent-ruby gem to asciidoctorj.jar
Release Meta
Released on: 2018-10-30
Released by: @robertpanzer
v1.5.8
This release brings the latest versions of asciidoctor and asciidoctor-diagram to AsciidoctorJ
Improvements
- Upgrade asciidoctor to 1.5.8
- Upgrade asciidoctor-diagram to 1.5.10
- Upgrade JRuby to 9.1.17.0
- #695 Fix timings option
-t - #689 Made warnings for invalid refs only available under verbose mode
-v. - #670 Add docs for LogHandler (@abelsromero)
Bug fixes
- #682 added test to reproduce issue with jRuby 9.1.16.0 (@abelsromero)
- #662 Don't cd into asciidoctorj directory when rendering documents (@apjanke)
- #673 Fix Java7 builds on Travis (@abelsromero)
Release Meta
Released on: 2018-10-29
Released by: @robertpanzer
Release beer: Brewdog Punk IPA
v1.5.7
This release brings the latest versions of asciidoctor and asciidoctor-diagram to AsciidoctorJ
Improvements
- Upgrade asciidoctor to 1.5.7.1
- Upgrade asciidoctor-diagram to 1.5.9 (Thanks to @pepijnve for preparing this dedicated release that's compatible with AsciidoctorJ 1.5.6).
- Upgrade JRuby to 9.1.16.0
- #582 Add chocolatey packaging
- #614 Upgrade build to Gradle 4.4 (@tisoft)
- #656 Upgrade tilt to 2.0.8 (@msgilligan)
- #643 Forward Asciidoctor output to java.util.logging
- #644 Fix start error for asciidoctorj tool on OpenJDK 10
- #627 Adding instruction on How to install to local m2 repository (@agoncal)
Bug fixes
- #576 Forces TravisCI to use precise image to fix oraclejdk7 issues with trusty (@abelsromero)
- #595 Avoid endless recursion in Cell.getRowspan() (@ham1)
- #616 AttributesBuilder: showTitle(boolean) method (@jmini)
- #624 Illegal access exception with macros (JRuby 9.1.15.0 & Java 9) (@jmini)
- #632: Set proxy system properties for unit tests (@t-h-a-l-i-s)
- #634: Unit test fails due to line ending issue (@t-h-a-l-i-s)
Important note
AsciidoctorJ now requires Java 7.
Release Meta
Released on: 2018-06-27
Released by: @robertpanzer
Release beer: La Trappe Oak Aged Batch 27
v1.6.0-alpha.7
A new alpha release of the 1.6.0 branch
- This version bumps the version of the embedded Asciidoctor to 1.5.7.1
- The version of Asciidoctor-Diagram in the distribution was bumped to 1.5.9
- The version of JRuby was bumped to 9.2.0.0
- This version requires at least Java 8!
Improvements/Fixes
- (RuntimeError) can't modify frozen NilClass on getParent() (#593 @jmini)
- Move "org.asciidoctor.ast" package to "asciidoctorj-api" project (#590, #606 @jmini)
- AttributesBuilder: showTitle(boolean) method (#616 @jmini)
- Inconsistency with numeric keys in attributes map (#604 @jmini)
- Add plugin mechanism for Loggers and log to java.util.logging (#657)
- Fix start script for OpenJDK 10
Release Meta
Released on: 2018-06-21
Released by: @robertpanzer
Thanks to all contributors, in particular @jmini !
v.1.6.0-alpha.6
A new alpha release of the 1.6.0 branch
- Only contains a bugfix for #579 that affects extension writers
Improvements/Fixes
- #579 Unable to convert multiple files with the same engine with include processor (@SevereOverfl0w)
Release Meta
Released on: 2017-10-17
Released by: @robertpanzer
Thanks to all contributors!
v1.6.0-alpha.5
A new alpha release of the 1.6.0 branch
- This version bumps the version of the embedded Asciidoctor to 1.5.6.1
- The version of Asciidoctor-Diagram in the distribution was bumped to 1.5.4.1
- The version of Asciidoctor-PDF in the distribution was bumped to 1.5.0-alpha.16
Improvements/Fixes
- Remove leading CONTEXT prefix from all constants in
@Contexts(#569 @mojavelinux) - Add ExtensionGroup API and allow deregistration of dedicated extensions (#359 @lefou)
- Rename isAttr(), setAttr() and getAttr() to more Java like names, isAttribute(), setAttribute() and getAttribute() (#554 @mojavelinux)
Release Meta
Released on: 2017-08-20
Released by: @robertpanzer
Thanks to all contributors!
v1.5.6
This release brings the latest versions of asciidoctor, asciidoctor-epub3 and asciidoctor-diagram to AsciidoctorJ
Improvements
- Upgrade asciidoctor to 1.5.6.1
- Upgrade asciidoctor-diagram to 1.5.4.1 (Thanks to @pepijnve for preparing this dedicated release that's compatible with AsciidoctorJ 1.5.6).
- Upgrade asciidoctor-epub3 to 1.5.0-alpha.7
- Upgrade JRuby to 1.7.26 and 9.1.12.0 (The distribution still uses 9.1.8.0 though for Windows compatibility)
- Add an API to unregister dedicated extensions (#359/#564)
Bug fixes
- #558 typo at TerminalCommandTreeprocessor example (@jagedn)
- #551 enable full exception format running tests with stacktrace enabled (@ancho)
Important note
Asciidoctor-pdf 1.5.0-alpha.15 requires Ruby >=2.
Therefore asciidoctorj-pdf and the asciidoctor distribution only run with JRuby 9.1.8.0.
That means that asciidoctorj-pdf no longer supports Java 6 but requires at least Java 7.
Also the AsciidoctorJ distribution by default requires Java 7
Release Meta
Released on: 2017-08-01
Released by: @robertpanzer
Release beer: Firestone Walker Union Jack IPA