Tracking 2.0.0 Development

[ysb33r]

This is a tracking issue for all of the known items that needs to be resolved for a 2.0 release.

• Rename development-1.6 branch to development-2.0
• Instead of every subproject creating it's own off-line repo, create a subproject that will keep one on behalf of all subprojects.
• Run all tests on Appveyor (Exponential slow-down when using Gradle workers on Appveyor gradle/gradle#5828)
• Write a multi-project compatibility test where an extension is created in one subproject and consumed by another asciidoctor subproject.
• Set includedir attribute to be sourceDir or where intermediate is use, to the intermediate work directory.
• Write integration tests for resources:
  • When 'resources' not specified, then copy all images to backend
  • When 'resources' not specified and more than one backend, then copy all images to every backend
  • When 'resources' are specified, then copy according to all patterns
• Write integration tests for gemPath (Write tests for the gemPath and requires options #104)
• Write a compatibility test which include jruby-gradle and requires some external GEMs.
• Logging the classpath in JDK9/10. (The parent is no longer a URLClassLoader, but an internal platform classloader).
• Utilise Redirect Asciidoctor logging to Java Util Logging asciidoctorj#643 and remove the current way of activating verbose mode.
  • LogHandler implementation for IN_PROCESS / OUT_OF_PROCESS modes. (Allow verbose mode to be programmatically changed #233)
  • Investigate whether parsing from the LogHandler can be used to fail builds under certain warning conditions. (Option to fail on warning #154)
• Get rid of The Cobertura XML file [null] is not accessible; skipping this rule message.
• Merge 1.5.8/1.5.8.1 changes to Asciidoctor compatiblity task. Refactor internals of compatibility task to use JAVA_EXEC instead of the old in-memory oroxy cache model.
• All default tasks must have a group and description.
• Make tasks build-cache friendly by setting path sensitivity on inputs that are files.
• The constructor of AbstractAsciidoctorTask still relies on an internal API. This needs to be resolved in another manner: (resourceCopySpec as CopySpecInternal).buildRootResolver().allSource (Requires Grolifant 0.8)
• Settings for specific PDF attributes on the AsciidoctorJPdfTask.
• Using Ability to download Themes for Asciidoctor PDF #186 as inspiration allow better support for local themes and downloadable themes
• Check Jacoco configuration to include gradleTest in coverage.
• Fix Gradle 4.9 issue (Fix issue running plugin under Gradle 4.9 #254, Plugin compiled with Groovy's @CompileStatic breaks with Gradle 4.9 gradle/gradle#6027).
• Fix Gradle 4.10 issue (Fix issue running AsciidoctorJ out of process on Gradle 4.10 #269)
• Fix build to work with JDK11.
• Create a manual test for memory leaks as per Memory leak on multi-project builds #182. The idea is not to run it from CI, but locally.
• RevealJS plugin (https://github.com/asciidoctor/asciidoctor-reveal.js)
• Drop support for AsciidoctorJ 1.5.x (Drop support for AsciidoctorJ 1.5 in the 2.0.x series of the plugin #274)
  • Resolving how the minimum JRuby version is selected in AsciidoctorJExtension.minimumSafeJRubyVersion. There must be a better way of doing this.
  • Remove the need for asciidoctorjHasApiJar in asciidoctorj-versions.gradle.
• Fix annotation warnings in Reveal.js plugin (Fix annotation warnings in Reveal.js plugin #281).
• Code coverage reported by coveralls should be 80%+.
• Depend on localGroovy() instead of groovy-all in gradle-plugin-dependencies.gradle (Depends on Worker classpath should only contain necessary classes gradle/gradle#3698)
• Fix the plugin classpath manifest for tests (Class manifest for integration tests are calculated incorrectly #271)

Items that were fixed:

• Support for multi page documentation #52
• Move plugin documentation to gh-pages #102
• Write tests for the gemPath and requires options #104
• Ability to download Themes for Asciidoctor PDF #186
• Extension block_macro() not supported ? #193
• Version overridden when also referencing asciidoctor-pdf #239
• Allow Java fork options to be specified (#240) #242
• Add support for Asciidoclet processing of JavaDoc files #244
• Fail build on asciidoctor warnings #255
• how to setIncludes when I extends AsciidoctorTask in java custom plugin #256
• Fix issue running AsciidoctorJ out of process on Gradle 4.10 #269
• Class manifest for integration tests are calculated incorrectly #271
• Track GEM issues with JRuby 9.2.0+  #273
• ArrayOutOfBoundsException with multiple backends #282
• org.asciidoctor.jvm.convert stops working with Gradle 5.2-rc-1 #284
• Compile avoidance #285
• Parallel builds #286
• Provide access to the sourceDir value as attribute #292
• Kotlin DSL does not work on Gradle 5.2.1, 5.3 #298

See also:

• Development 2.0 #237
• Support Java 9, 10, and beyond (parent issue) asciidoclet#76
• Redirect Asciidoctor logging to Java Util Logging asciidoctorj#643
• Worker classpath should only contain necessary classes gradle/gradle#3698
• Exponential slow-down when using Gradle workers on Appveyor gradle/gradle#5828
• https://gitlab.com/ysb33rOrg/packer-gradle-plugin/merge_requests/3

[ysb33r]

There is big jump in the timings in this test in AsciidoctorTaskFunctionalSpec (as seen on Appveyor)

[mojavelinux]

I'm completely in awe of the work you're doing on the 2.0 version. Great job!

While I can't help much with the code, I intend to get involved with the docs part. I still have some work to do to get the docs foundation set up, but once that's in place, it should be easy to incorporate the docs from this project. In the meantime, we can get started by setting up the structure of an Antora component under the docs folder.