Class PackageDocMojo

java.lang.Object
network.ike.docs.plugin.PackageDocMojo
All Implemented Interfaces:
org.apache.maven.api.plugin.Mojo
@Mojo(name="package-doc", defaultPhase="package", projectRequired=true) public class PackageDocMojo extends Object implements org.apache.maven.api.plugin.Mojo
Package AsciiDoc sources as the primary artifact for ike-doc packaging.

Zips the contents of src/docs/asciidoc/ into a .zip file and sets it as the project's primary artifact. This makes the AsciiDoc source the canonical artifact — rendered outputs (HTML, PDF) are attached as classifier artifacts by the rendering pipeline.

This goal is bound to the package phase in the ike-doc lifecycle mapping. It can also be invoked directly: 

mvn ike:package-doc

  • Constructor Details

    • PackageDocMojo

      public PackageDocMojo()
      Creates this goal instance.

  • Method Details

    • getLog

      protected org.apache.maven.api.plugin.Log getLog()
      Access the Maven logger.
      Returns:
      the logger

    • execute

      public void execute() throws org.apache.maven.api.plugin.MojoException
      Specified by:
      execute in interface org.apache.maven.api.plugin.Mojo
      Throws:
      org.apache.maven.api.plugin.MojoException