asciidoctor/asciidoctor-maven-plugin asciidoctor-maven-tools-3.0.0

v3.0.0

on GitHub

This major release ("It's about time") contains new features, fixes and also some breaking changes.
Make sure to read the migration guide to help with the upgrade (it should be available soon after the release).

The most notable changes for users are:

• Refactoring of code base into independent modules 👨‍💻 :
  • The new asciidoctor-maven-plugin contains the well-known maven plugin without maven-site integration dependencies. This will safe some time and bandwidth when using it ⏳ .
  • The maven-site integration Doxia module has been renamed to asciidoctor-converter-doxia-module. Those using the current one may want to use this for minimal impact.
  • A new maven-site integration Doxia module 🎉 has been introduced, asciidoctor-parser-doxia-module. This modules is made to be compatible with the popular Fluido skin and aims to make it easy to write your site docs in AsciiDoc as a drop-in replacement for any other format. No need for custom CSS or other customizations, albeit not all Asciidoctor features are supported yet. Please, report if you want anything added in the following releases.

As a consequence of the refactoring, the parent project is now called asciidoctor-maven-tools this will reflect in this repository tags, but it's of no consequence for users.

Another line of work in this release has been the automation of several maintenance tasks 🔧 to improve the overall shape of the project and facilitate faster and more regular releases 🚀

• Introduction of Dependabot to maintain dependencies.
• Several CI improvements and automation of releases via GH Actions. If you see this, this means it worked 😄

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

Improvement

• Split plugin and site integration in sub-modules: asciidoctor-maven-plugin and asciidoctor-doxia-module #595
• Add 'asciidoc' as a valid file extension in AsciidoctorDoxiaParserModule (#595)
• Fix throwing an exception when registering a non Extension (#596)
• Reimplement resource copy using 'plexus.util.DirectorScanner' instead of 'maven-filtering' to reduce dependencies and build time #597
• Replace deprecated 'headerFooter' by 'standalone' in configuration (#649)
• Remove internal use of 'destinationDir' AsciidoctorJ method (#650)
• Upgrade Asciidoctorj to v2.5.11 (#688) and jRuby to v9.4.5.0 (#665)
• Improve the warning message when the destination file is going to be replaced (#728)
• Added .editorconfig file to facilitate code formatting (#760)

Bug Fixes

• Fix default value for eruby which caused a fail when using erb templates (#610)
• Fix maven properties not being injected as attributes during site conversion (#656)
• Remove Java 'requires open access' module warning in modern Java versions with JRuby v9.4.5.0 (#553)
• Fix breadcrumbs not showing the document title in maven-site pages (#763)

Documentation

• Fix absolute path in usage example and AsciiDoc references in docs (https://github.com/MarkusTiede[@MarkusTiede])(#592)

Release Meta

Released on: 2024-02-14
Released by: @abelsromero
Soundtrack: Devin Townsend - Disco Inferno (Order of Magnitude)