Junit5: AsciiDoctor task does not support Rouge on MS Windows

[Andrei94]

Overview

When running the asciidoctor task on Windows, Gradle gives the following error:

(RuntimeError) asciidoctor: FAILED: required gem 'rouge' is not installed. Processing aborted.
:documentation:asciidoctor FAILED

The ruby, jruby and ruby-devkit are installed.
This problem doesn't appear on Linux and Mac systems.

Related Issues

• #652
• #770
• #777
• https://github.com/asciidoctor/asciidoctor/issues/1040

[sbrannen]

There is unfortunately a known issue with using Rouge on Windows.

See https://github.com/asciidoctor/asciidoctor/issues/1040 for details.

In any case, thanks for raising the issue.

In the interim, you might try running the Gradle build in a Bash shell on Windows (e.g., Cygwin, or Windows Subsystem for Linux (WSL)).

[sbrannen]

FYI: Added _Related Issues_ section.

[sbrannen]

Currently slated for 5.0 M5, in case there is any action we can take.

[jbduncan]

@sbrannen When I personally tried asciidoctor on Cygwin, it gave me the same error. So I think the error is so Windows-centric that a UNIX layer does little if anything to resolve the problem.

[Andrei94]

@sbrannen The problem with the gem also appears with the spring repository. I had to make a local hack there as well. 😄
For JUnit, a temporary solution is to leave only

backends 'html5'

from

backends 'html5', 'pdf' // , 'epub3'

in documentation.gradle.

The pdf backend seems to be the culprit.

[Andrei94]

Good touch 😉

[sbrannen]

Good touch 😉

Huh?

[sbrannen]

Glad you figured out the workaround, since I was just about to suggest that as a fallback option.

[Andrei94]

Huh?

I was also thinking of referencing the issue.

[sbrannen]

Ah, OK. I didn't make the connection to the "sbrannen referenced this issue..." link, since my brain ignores those entries. 😉

[sbrannen]

@mojavelinux figured out the cause and reported the underlying bug here: https://github.com/jneen/rouge/issues/661

[sbrannen]

Due to the bug in Rouge that prevents its usage on MS Windows, I am going to revert back to coderay for both the HTML and PDF versions of the User Guide for the time being.

Consequently, I am closing this issue.

[sbrannen]

Superseded by #770 and #777.