Built by Maven

html:deploy-html

Full name:

de.eitco.cicd.html:html-maven-plugin:4.0.2:deploy-html

Description:

This goal deploys the html files to a remote repository. It does use mavens wagon api to upload the generated html (and resource) files to a specified location. This is intended for quick and dirty - but up to date - documentation deployment - to a nexus 'raw' repository for example.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: deploy.

Required Parameters

Name Type Since Description
<url> String - URL to upload to or download from or list. Must exist and point to a directory.
User Property: wagon.url

Optional Parameters

Name Type Since Description
<outputDirectory> File - This parameter specifies where to put the generated html file(s).
Default: ${project.build.directory}/html
User Property: asciidoctor.outputDirectory
<serverId> String - settings.xml's server id for the URL. This is used when wagon needs extra authentication information.
Default: serverId
User Property: wagon.serverId
<skip> boolean 2.0.0 When true, skip the execution.
User Property: wagon.skip
<skipHtmlDeploy> boolean - This parameter specified whether to skip the deployment of the html file(s).
Default: false

Parameter Details

<outputDirectory>

This parameter specifies where to put the generated html file(s).
  • Type: java.io.File
  • Required: No
  • User Property: asciidoctor.outputDirectory
  • Default: ${project.build.directory}/html

<serverId>

settings.xml's server id for the URL. This is used when wagon needs extra authentication information.
  • Type: java.lang.String
  • Required: No
  • User Property: wagon.serverId
  • Default: serverId

<skip>

When true, skip the execution.
  • Type: boolean
  • Since: 2.0.0
  • Required: No
  • User Property: wagon.skip

<skipHtmlDeploy>

This parameter specified whether to skip the deployment of the html file(s).
  • Type: boolean
  • Required: No
  • Default: false

<url>

URL to upload to or download from or list. Must exist and point to a directory.
  • Type: java.lang.String
  • Required: Yes
  • User Property: wagon.url