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 :man_technologist: :
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 :hourglass_flowing_sand: .
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 :tada: 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 :wrench: 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 :smile:
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)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps org.asciidoctor:asciidoctor-maven-plugin from 2.2.5 to 3.0.0.
Release notes
Sourced from org.asciidoctor:asciidoctor-maven-plugin's releases.
... (truncated)
Changelog
Sourced from org.asciidoctor:asciidoctor-maven-plugin's changelog.
... (truncated)
Commits
3fd86ff[maven-release-plugin] prepare release asciidoctor-maven-tools-3.0.09cd76a1Update docs for v3.0.0 release (#779)41bb44aUpdate Antora component version to 3.0 (#778)2a3a22bRemove un-necessary dependency from parser-doxia-module (#777)e5a4ebeBump s4u/setup-maven-action from 1.11.0 to 1.12.0 (#775)1fc2014(main) Port fixes for maven-site breadcrumbs from v2.2.x #763 (#774)5432f0cMark Zip mojo as deprecated for removal in next major (#773)c8b543aAdd support for description lists in parser-doxia-module (#772)19ddcdc(main): Bump org.assertj:assertj-core from 3.25.2 to 3.25.3 (#765)19b0f0f(main): Bump org.junit:junit-bom from 5.10.1 to 5.10.2 (#766)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show