Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update asciidoc plugins, config #559

Merged
merged 5 commits into from Nov 18, 2021
Merged

Conversation

starksm64
Copy link
Contributor

Addresses #558

starksm64 and others added 3 commits October 26, 2021 16:12
Update the root readme

Signed-off-by: starksm64 <starksm64@gmail.com>
Signed-off-by: starksm64 <starksm64@gmail.com>
spec/pom.xml Show resolved Hide resolved
@Ladicek
Copy link
Contributor

Ladicek commented Nov 18, 2021

I looked into updating Asciidoctor when prototyping specref and I did it like this.

  1. Latest Asciidoctor Maven plugin doesn't include latest Asciidoctor. I added a new property for it:
...
<properties>
    <asciidoctor-maven.version>2.2.1</asciidoctor-maven.version>
    <asciidoctorj.version>2.5.2</asciidoctorj.version> <!-- <<<<< added line <<<<< -->
    <asciidoctorj-pdf.version>1.6.0</asciidoctorj-pdf.version>
   ...
</properties>
...
  1. and a dependency to the Asciidoctor Maven plugin:
...
<plugin>
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctor-maven-plugin</artifactId>
    <version>${asciidoctor-maven.version}</version>
    <dependencies>
        <!-- >>>>> added dependency >>>>> -->
       <dependency>
           <groupId>org.asciidoctor</groupId>
            <artifactId>asciidoctorj</artifactId>
            <version>${asciidoctorj.version}</version>
        </dependency>
        <!-- <<<<< added dependency <<<<< -->
        <dependency>
            <groupId>org.asciidoctor</groupId>
            <artifactId>asciidoctorj-pdf</artifactId>
            <version>${asciidoctorj-pdf.version}</version>
        </dependency>
    </dependencies>
    ...
</plugin>
  1. Asciidoctor Maven plugin has some breaking changes. These configuration changes were enough for me, though I didn't try rendering a PDF:
<configuration>
    <sourceDirectory>src/main/asciidoc</sourceDirectory> <!-- otherwise warnings are printed -->
    <sourceDocumentName>cdi-spec.asciidoc</sourceDocumentName>
    <attributes>
        <license>${license-file}</license>
        <revremark>${revremark}</revremark>
        <imagesdir>images</imagesdir>
        <source-highlighter>coderay</source-highlighter>
    </attributes>
</configuration>

…ory and imagesdir

Signed-off-by: starksm64 <starksm64@gmail.com>
Signed-off-by: starksm64 <starksm64@gmail.com>
@starksm64
Copy link
Contributor Author

I have updated the plugin configuration to use the explicit asciidoctorj.version setting and added the addition configuration/attribute changes. The test build with this PR shows no errors/warnings:
https://ci.eclipse.org/cdi/job/CDISpec/8/console

@Ladicek
Copy link
Contributor

Ladicek commented Nov 18, 2021

I vaguely recall seeing a 3.0 somewhere else too, but that should be fixed in another PR.

@starksm64 starksm64 merged commit 625cbb4 into jakartaee:master Nov 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants