v2.0.0

V2.0.0 ("New beginning") is the first release to make official the use semantic versioning.
Until now, the plugin, Asciidoctorj and Asciidoctor itself shared major versioning.
From now one each one will have it's own versioning and release cycles.

This has been an opportunity to do some necessary cleaning and under-the-hood work after years of patching and small incremental work.
As a downside, v2.0.0 is the first version to introduce breaking changes.
Don't panic, check the v2.x.x migration guide for details on breaking changes and how to update your configuration.

As always, thanks to all contributors! Specially those taking time providing report issues and feedback 👍

Improvements

• #426 Bump Asciidoctorj version to 2.3.0
• #427 Bump JRuby version to 9.2.11.1
• #400 Support logHandler configuration for site generation (@ptahchiev)
• #254 Implement fallback search for sourceDir. Now defaults to 'src/docs/asciidoc', 'src/asciidoc' and 'src/main/asciidoc' in that order
• #188 Set html5 as default backend
• #265 Replace templateDir option by templateDirs
• #296 Remove imagesdir configuration option and align default value with Asciidoctor (@sjoerdtalsma)
• #437 Remove title configuration option
• #432 Remove sourceHighlighter configuration option
• #417 Remove attributeMissing configuration option (@wilkinsona)
• #441 Remove attributeUndefined configuration option

Documentation

• #414 Make sample resource config valid xml (@luvarqpp)
• #376 Replace all references to render by convert
• #442 Add v2.x.x migration guide
• Several minor updates and corrections in README

Release Meta

Released on: 2020-06-20
Released by: @abelsromero
Soundtrack: Why? (Devin Townsend)

v1.6.0

This release is done to provide easy access to AsciidoctorJ v1.6.2 by third party tools like Spring REST docs.
This does not include any additional feature and includes only required modification for v1.6.2 compatibility.

Thanks to all contributors! Specially those taking time providing report issues and feedback 👍

Changes

• Upgrade default version of Asciidoctorj to v1.6.2 alongside jruby-complete to v9.2.6.0
• Removed compatibility with Java 7, minimum version is 8

Notes

Due to issues found with PDF conversion #398 and aligned with the goal of this release, jruby-complete artifact is still used as jRuby dependency. Instead of jruby which is provided by AsciidoctorJ.

Release Meta

Released on: 2018-04-05
Released by: @abelsromero
Soundtrack: The Watchmaker (Steven Wilson)

v2.0.0-RC.1

This release is a preview for the upcoming v2.0.0.
This aligns the maven plugin version to the version of AsciidoctorJ v2.0.0-RC.1.

Note the new 2.0.0 has some non-backward compatible changes.
However, this release does not include any of those and is aimed to test compatibility with new Asciidoctor 2.0.x features.

Discussion about changes is still open, please feel free to provide feedback.

• See Road to Asciidoctor 2.0.0 #391 discussion for an outline of the release plan and to comment on it.
• Check the proposed migration guide for full detail of what changes you may need to apply to your project.

Thanks to all contributors!

Improvements

• #389 Upgrade to AsciidoctorJ 2.0.0-RC.1 (@robertpanzer)
• #394 #395 Added Java 10 and 11 tests
• #396 Added templateDirs configuration option

Known issues

• Invalid references messages are not captured by the logHandler, even when verbose is enabled

Release Meta

Released on: 2019-03-31
Released by: @abelsromero
Soundtrack: Youth (Daughter)

v1.5.8 "Farewell"

This release aligns the maven plugin version to the version of AsciidoctorJ v1.5.8.1.

This is a "farewell" version before starting work on 2.0.0 version which will introduce non-backward compatible changes.
Changes are meant to align with improvements done in Asciidoctor and remove some "quirks" added in the maven plugin over time.
Most notably are:

• Removal of imagesDir and sourceHighlighter options in favour of defining it in the <attributes> section.
• Replacement of templateDir (now deprecated in Asciidoctor) by templateDirs (List) (#265)
• Removing support for Java 7

Special thanks to all contributors during all the 1.5.x releases!

Improvements

• #370 Added openjdk9 and Java 10 to TravisCI
• #375 Use asciidoctor.convertFile() instead of asciidoctor.renderFile() (@robertpanzer)

Bug fixes

• #372 Fix setting logHandler.outputToConsole to be true by default
• #386 Be able to use LAN IP (for http server preview) (@andersonb)

Documentation

• #382 Add tip on how to show the asciidoctor version

Release Meta

Released on: 2019-03-30
Released by: @abelsromero
Soundtrack: Closure (Opeth)

v.1.5.7.1

This release is a hot fix to correct an issue with the new message processing feature.
Everything should be fine now ^^

Thanks to all contributors!

Bug fixes

• 367 Fix NPE on certain messages when enabling message processing (many thanks to @lpetit-yseop and @eiswind for reporting)
• 369 Set jRuby v9.1.17.0 as default to prevent errors when multiple documents are rendered.
  See asciidoctorj#680 for details.

Release Meta

Released on: 2018-10-03
Released by: @abelsromero
Soundtrack: Who Bit the Moon (David Maxim Micic)

v1.5.7

This release aligns the maven plugin version to the latest version of AsciidoctorJ v1.5.7, and in turn Asciidoctor v1.5.7.1.

Thanks to all contributors!

Improvements

• Upgraded AsciidoctorJ version to 1.5.7, see AsciidoctorJ and Asciidoctor respective release notes for more details
• #364 Marked AsciidoctorMojo as thread safe (@timkrueger)
• #363 Added new feature to fail a build based on different conditions (see logHandler configuration for details)
• #356 Added note about how to use of hidden files and resources with an _ prefix in README
• #341 Removed dependency to oss-parent (@slachiewicz
• #336 Improved site mojo documentation in README to explain how to customize sources directory
• #347 Added Java9 builds to TravisCI anb AppVeyor
• #325 README cleanup and improvements (@mojavelinux)
• #322 Improved explanations on Maven Plugin vs Maven Site Integration/Doxia (@hboutemy)

Bug fixes

• #352 Ensure outputFile is now relative to outputDirectory
• #342 Set default encoding to UTF-8 for resource copy plugin on tests (@slachiewicz)
• #331 Added treatment to allow iuse of relative baseDir on the site

Release Meta

Released on: 2018-09-24
Released by: @abelsromero
Soundtrack: Luminol (Steven Wilson)

v1.5.6

This release aligns the maven plugin version to the latest version of AsciidoctorJ v1.5.6, and in turn Asciidoctor v1.5.6.

Thanks to all contributors!

Improvements

• Upgraded AsciidoctorJ version to 1.5.6, see AsciidoctorJ and Asciidoctor respective release notes for more details
• #307 Upgrade asciidoctorj to 1.5.6 (@tisoft)
• #301 Added outputFile option to override the generated filename (@tisoft)
• #303 Show warning when outputFile is enabled and more than one file is processed
• #304 Replaces '_' by '-' as maven properties separator for site mojo
• #297 Improved message on non-existing source directory.
  Now will show the invalid path in the output (@obfischer)
• #280 Upgraded Doxia for compatibility with maven-site-plugin 3.4+.
  People using maven-site-plugin 3.3. or below will need to upgrade.
• Some documentation improvements (#209, #291)

Bug fixes

• #305 Use project.build.sourceEncoding to copy resources and remove excessive INFO from console output
• #295 Allow imagesdir attribute override from documents (@sjoerdtalsma)

Release Meta

Released on: 2017-09-23
Released by: @abelsromero
Soundtrack: Stardust (David Maxim Micic)

v1.5.5

This release aligns the maven plugin version to the latest version of AsciidoctorJ v1.5.5, and in turn Asciidoctor v1.5.5.

Thanks to all contributors!

Improvements

• Upgraded AsciidoctorJ version to 1.5.5, see AsciidoctorJ and Asciidoctor respective release notes for more details
• Upgraded JRuby to 1.7.26, note that using AsciidoctorJ-pdf v1.5.0-alpha.14 requires JRuby 9.1.8.0
• #270 docinfo files are now excluded by default (@ge0ffrey)
• #267 Enabled configuration of sourcemap, catalog_assets and template_cache options
• #255 Added compatibility for AsciidoctorJ 1.6.0 extensions (@robertpanzer)
• #253 #251 #247 #245 #243 #241 Many improvements and fixes in the maven plugin configuration, dependencies and build process (special thanks to @khmarbaise for his patience)
• #227 Upgraded Netty and other project dependencies for Java9 compatibility (@Sanne)
• #226 Added resource filtering option (choosing which resources to copy to target), see new 'resources' configuration option for details
• #218 Improved how AsciidoctorJ is created for v1.6.0 compatibility (@mattadamson)
• #223 Added Chinese version of the README (@diguage)
• #209 Added support for command line options, see command-line-configuration for details
• Many, many documentation improvements (@ge0ffrey, @leif81, @dashorst)
• #198 Improved behaviour when source directory is not found for multi-module configurations, instead of failing, plugin with now finish and show an informatime message (@Stummi)

Bug fixes

• #252 Fixed an issue that disabled source-highlighting
• #216 Fixed property name in 'zip' mojo (@ghusta)
• #153 Fixed an issue that prevented GitHub urls from being included

Release Meta

Released on: 2017-03-17
Released by: @abelsromero
Soundtrack: Warszawa (Porcupine Tree)

asciidoctor-maven-plugin-1.5.3

This release includes amongst others, important improvements in the site plugin integration.
Now it is possible to pass several options to the site plugin with the following syntax:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-site-plugin</artifactId>
    <version>3.3</version>
    <configuration>
        <asciidoc>
            <templateDirs>
                <dir>src/site/asciidoc/templates</dir>
                </templateDirs>
                <!-- or...
                <templateDir>src/site/asciidoc/templates</templateDir>
                -->
                <requires>
                    <require>base64</require>
                    <require>time</require>
                 </requires>
                 <attributes>
                     <source-highlighter>coderay</source-highlighter>
                     <coderay-css>style</coderay-css>
                     <toclevels>2</toclevels>
                 </attributes>
             </asciidoc>
             <moduleExcludes>
                 <asciidoc>**/_*.adoc</asciidoc>
             </moduleExcludes>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.asciidoctor</groupId>
         </dependency>
    </dependencies>
</plugin>

See this for more details: #182