Built by Maven

lychee:check

Full name:

io.fluxzero:lychee-maven-plugin:0.1.1:check

Description:

Runs lychee against project documentation files selected by configured scan directories.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: verify.

Required Parameters

Name Type Since Description
<installDirectory> File - No description.
Default: ${project.build.directory}/lychee

Optional Parameters

Name Type Since Description
<args> List<String> - No description.
<assetName> String - No description.
User Property: lychee.assetName
<downloadBaseUrl> String - No description.
Default: https://github.com/lycheeverse/lychee/releases/download
User Property: lychee.downloadBaseUrl
<downloadRetries> int - No description.
Default: 3
User Property: lychee.downloadRetries
<downloadServerId> String - No description.
User Property: lychee.downloadServerId
<expectedSha256> String - No description.
User Property: lychee.expectedSha256
<failOnError> boolean - No description.
Default: true
User Property: lychee.failOnError
<linuxVariant> String - No description.
Default: gnu
User Property: lychee.linuxVariant
<retryBackoffMillis> long - No description.
Default: 1000
User Property: lychee.retryBackoffMillis
<scanDirectories> List<FileSet> - No description.
<skip> boolean - No description.
Default: false
User Property: lychee.skip
<verifyChecksum> boolean - No description.
Default: true
User Property: lychee.verifyChecksum
<version> String - No description.
Default: 0.23.0
User Property: lychee.version

Parameter Details

<args>

No description.
  • Type: java.util.List<java.lang.String>
  • Required: No

<assetName>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: lychee.assetName

<downloadBaseUrl>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: lychee.downloadBaseUrl
  • Default: https://github.com/lycheeverse/lychee/releases/download

<downloadRetries>

No description.
  • Type: int
  • Required: No
  • User Property: lychee.downloadRetries
  • Default: 3

<downloadServerId>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: lychee.downloadServerId

<expectedSha256>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: lychee.expectedSha256

<failOnError>

No description.
  • Type: boolean
  • Required: No
  • User Property: lychee.failOnError
  • Default: true

<installDirectory>

No description.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/lychee

<linuxVariant>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: lychee.linuxVariant
  • Default: gnu

<retryBackoffMillis>

No description.
  • Type: long
  • Required: No
  • User Property: lychee.retryBackoffMillis
  • Default: 1000

<scanDirectories>

No description.
  • Type: java.util.List<org.apache.maven.shared.model.fileset.FileSet>
  • Required: No

<skip>

No description.
  • Type: boolean
  • Required: No
  • User Property: lychee.skip
  • Default: false

<verifyChecksum>

No description.
  • Type: boolean
  • Required: No
  • User Property: lychee.verifyChecksum
  • Default: true

<version>

No description.
  • Type: java.lang.String
  • Required: No
  • User Property: lychee.version
  • Default: 0.23.0