v3.0.0

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)

v2.2.6

Patch release with minor fixes.
No substantial code changes or new features have been introduced.

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

Improvement

• Push Asiidoctor header metadata (author(s), conversion time and title) to maven-site pages meta tag (#769)

Bug Fixes

• Fix breadcrumbs not showing the document title in maven-site pages (#763). Thanks @kriegaex.

Release Meta

Released on: 2024-02-09
Released by: @abelsromero
Soundtrack: Steven Wilson - Impossible Tightrope

v2.2.5

Patch release with minor fixes.
No substantial code changes or new features have been introduced.

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

Fixes

• Remove Java 'requires open access' module warning in modern Java versions with JRuby v9.4.5.0 (#553). Thanks @khmarbaise for notifiying of the fix.
• Check for both destinationDir and toDir to avoid invalid "Duplicated destination found" messages, and improve warning message (#728). Thanks @kriegaex for reporting.

Build / Infrastructure

• Use latest Maven v3.9.6 in CI and wrapper (#659)
• Bump AsciidoctorJ to v2.5.11 and jRuby to v9.4.5.0
• Integrated Dependabot to ease maintenance

Release Meta

Released on: 2024-01-11
Released by: @abelsromero
Soundtrack: Joe Hisaishi - Studio Ghibli Concert (2008)

v2.2.4

V2.2.4 is a fix release for Maven warnings introduced in v3.9.2, see "Plugins validation warnings" in Maven's release notes.
No substantial code changes or new features have been introduced.

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

Build / Infrastructure

• #632 Add Maven matrix testing, and define Maven compatibility policy
• #639 Bump Asciidoctorj to v2.5.8 and jRuby to v9.3.10.0
• #623 Maven 3.9.2 displays warnings with version 2.2.3
• #641 Add maven-site-plugin v3.10.0 integration test
• #644 Fix maven-source-plugin configuration for release (hot-fix during release, not documented in CHANGELONG)

Release Meta

Released on: 2023-05-28
Released by: @abelsromero
Soundtrack: Of The New Day (Porcupine Tree)

v2.2.3

V2.2.3 is fix release for several CVEs related to netty-codec-http. Special thanks to @JanWesterkamp-iJUG for bringing the topic and the support provided.

Is important to note, that netty-codec-http is used ONLY for preview goals auto-refresh and http, and have no impact in normal conversion using process-asciidoc.

This release also includes some fixes ported from main branch listed below.
As always, thanks to all contributors! Specially those taking time providing report issues and feedback 👍

Fixes

• #610 Fixed default value for eruby which caused a failure when using erb templates. Thanks (@mokdeve) for reporting.

Documentation

• #592 Fix absolute path in usage example and AsciiDoc references in docs (@MarkusTiede)

Build / Infrastructure

• #620 Upgrade Asciidoctorj to v2.5.7 and jRuby to v9.3.8.0
• #625 Bump Doxia to v1.12.0 and test with maven-site-plugin v3.12.1
• #620 Bump netty-codec-http to v4.1.90.Final, fixes several CVEs
• #622 Delete unused TravisCI configuration
• #623 Bump Maven build plugins
• #624 Bump GH 'checkout' and 'setup-java' to v3

Release Meta

Released on: 2023-03-18
Released by: @abelsromero
Soundtrack: Dimensions (Devin Townsend)

v2.2.2

V2.2.2 ("Last mile") closes the v2 release train, to start work on breaking changes for next v3.

This release includes fixes and compatibilty with latest version of maven-site-plugin. Please, pay attention to details below if you find issues when upgrading.

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

Fixes

• #550 Exclude dot files and folders from conversion
• #563 Fix StringIndexOutOfBoundsException parsing log records when cursor file is above source directory
• #566 Fix compatibility with maven-site-plugin v3.10.0 (previous versions no longer supported) (https://github.com/michael-o[@michael-o])

Documentation

• #533 Add ID's for all parameters of process-asciidoc, auto-refresh and http mojo, to be able to generate direct urls (https://github.com/uniqueck[@uniqueck])
• #558 Clarify where to put the plugin section in pom.xml (#558)
• #569 Add compatibility matrix

Build / Infrastructure

• #573 Migrate Maven Wrapper to Apache's offical one
• #572 Upgrade Asciidoctorj to v2.5.3 and jRuby to v9.2.20.1
• #557 Support Java 17
• #561 Bump netty-codec-http to v4.1.71.Final

Release Meta

Released on: 2022-01-30
Released by: @abelsromero
Soundtrack: Seventh Wave (Devin Townsend)

v2.2.1

V2.2.1 contains a fix that could impact Jenkins users (#545) when Jenkins creates a working directory in with "_" prefix.

Thanks @liampuk for reporting!

Improvements

• #546 Fix excluding sources when enclosing parent path starts with _

Release Meta

Released on: 2021-07-24
Released by: @abelsromero
Soundtrack: Chrysalis (Opeth)

v2.2.0

V2.2.0 aim has been in maintenance and accessibility.

The highlights...

• Documentation has been migrated to Antora site docs.asciidoctor.org/maven-tools.
• All tests have been migrated to Java & JUnit5.
• Removed usage of AsciidoctorJ internal componentes.
• Upgraded Asciidoctorj to latests v2.5. and jRuby to v9.2.17.0.

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

Improvements

• #542 Allow running a refresh build on included sources (for auto-refresh & http mojos)

Documentation

• #498 Migrate docs (README) to Antora site and publish them in gh-pages
• #507 Remove ambiguity in usage of maven properties docs
• #509 Add ID to 'attributes' description, to be able to generate direct url from other docs
• #523 Fix broken links to extension api documentation (@djarnis73)
• #529 Remove local antora site generator stuff (@uniqueck)

Build / Infrastructure

• #521 Upgrade tests to JUni5
• #524 Rename main branch
• #525 Set maven wrapper to use maven v3.8.1
• #526 Upgrade Asciidoctorj to v2.4.3 and jRuby to v9.2.14.0
• #531 Upgrade Asciidoctorj to v2.5.0 and jRuby to v9.2.17.0
• #534 Upgrade Asciidoctorj to v2.5.1
• #539 Added 'Asciidoctor' organization to pom
• #540 Remove AppVeyor CI build
• #544 Update distributionManagement to deploy directly without Bintray

Maintenance

• #511 Upgrade netty-codec-http to 4.1.29.Final and refactor AsciidoctorHttpServer
• #512 Rewrite AsciidoctorMojoTest to Java to make it more approachable
• #514 Rewrite AsciidoctorMojoLogHandlerTest to Java to make it more approachable
• #515 Rewrite AsciidoctorMojoExtensionsTest to Java to make it more approachable
• #516 Rewrite AsciidoctorHttpMojoTest to Java to make it more approachable
• #518 Rewrite AsciidoctorZipMojoTest to Java to make it more approachable
• #519 Rewrite AsciidoctorDoxiaParserTest to Java + remove Groovy & Spock configurations
• #532 Replace usage of internal Asciidoctorj DirectoryWalker with Java NIO API and fix incorrect sources converted when using sourceDocumentExtension (@stdll)

Release Meta

Released on: 2021-07-19
Released by: @abelsromero
Soundtrack: Higher (Devin Townsend)

v2.1.0

V2.1.0 ("House cleaning") completes the consolidation and clean up work started with v2.0.0.
This version focuses on refactors and public availability of internal features that where not officially supported 🚀.

The highlights...

• Removal of code and configurations not being used.
• Public availability of auto-refresh and http mojos.
  These add life preview features to test and write more confortable. With them, all your configurations, included extensions, will be applied to modified files same way as during a normal build.
  Special thanks to Romain Manni-Bucau (rmannibucau 🐦, rmannibucau ) who put the foundations in previous versions.
• Focus on improved tests, going from 73% coverage to 85%.

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

Improvements

• #459 Inject Maven properties as attributes in process-asciidoc mojo
• #474, #478, #480 Made auto-refresh mojo officially available
  These allows live conversion of documents, see the docs
• #483 Made http mojo officially available
  Extends auto-refresh capabilities making HTML docs available through and embedded HTTP server, see the docs
• #486 Upgraded Asciidoctorj to 2.4.1 ad jRuby to 9.2.13.0

Documentation

• #445 Add reference to v2-migration-guide in README for better findability
• #446 Fix broken link to V2 migration guide (@ge0ffrey)
• #465 Add GitHub’s PR and issue templates
• #482 Add copyright notice to README and remove unnecessary license header from sources

Build / Infrastructure

• #448 Update maven-release-plugin version (3.0.0-M1) and POM scm configuration to simplify release proce
• #452, #453 Add GitHub Actions build for Linux, Windows, MacOS and Java 8, 11
• #460 Simplify TravisCI and AppVeyor to run Java 8 and 11 only
• #479 Upgrade Maven from v3.5.0 to 3.6.3 in AppVeyor and jacoco-maven-plugin version from v0.8.2 to 0.8.5
• #481 Use maven-javadoc-plugin version defined in pluginManagement + update to v3.2.0
• #484 Add Maven Wrapper to project and CI builds

Release Meta

Released on: 2020-09-15
Released by: @abelsromero
Soundtrack: Detonation (Steven Wilson)

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)