Fork me on GitHub

checksum:artifacts

Full name:

net.nicoulaj.maven.plugins:checksum-maven-plugin:1.8:artifacts

Description:

Compute project artifacts checksum digests and store them in individual files and/or a summary file.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: verify.
  • Is NOT inherited by default in multi-project builds.

Optional Parameters

Name Type Since Description
<algorithms> List 1.0 The list of checksum algorithms used.

Default value is MD5 and SHA-1.

Allowed values are Cksum, CRC32, BLAKE2B-160, BLAKE2B-256, BLAKE2B-384, BLAKE2B-512, GOST3411, GOST3411-2012-256, GOST3411-2012-512, KECCAK-224, KECCAK-256, KECCAK-288, KECCAK-384, KECCAK-512, MD2, MD4, MD5, RIPEMD128, RIPEMD160, RIPEMD256, RIPEMD320, SHA, SHA-1, SHA-224, SHA-256, SHA3-224, SHA3-256, SHA3-384, SHA3-512, SHA-384, SHA-512, SHA-512/224, SHA-512/256, SKEIN-1024-1024, SKEIN-1024-384, SKEIN-1024-512, SKEIN-256-128, SKEIN-256-160, SKEIN-256-224, SKEIN-256-256, SKEIN-512-128, SKEIN-512-160, SKEIN-512-224, SKEIN-512-256, SKEIN-512-384, SKEIN-512-512, SM3, TIGER and WHIRLPOOL.

Use the following syntax:

<algorithms>
  <algorithm>MD5</algorithm>
  <algorithm>SHA-1</algorithm>
</algorithms>

<appendFilename> boolean 1.4 Append the artifact filename in the generated checksum file. This parameter require the parameter individualFiles be equal to true.
Default value is: false.
<attachChecksums> boolean 1.3 Should the checksums be attached as build artifacts.
Default value is: false.
User property is: attachChecksums.
<csvSummary> boolean 1.0 Indicates whether the build will store checksums to a single CSV summary file.
Default value is: false.
<csvSummaryFile> String 1.0 The name of the summary file created if the option is activated.
Default value is: artifacts-checksums.csv.
<encoding> String 1.0 Encoding to use for generated files.
Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
<failOnError> boolean 1.0 Indicates whether the build will fail if there are errors.
Default value is: true.
<includeRelativePath> boolean 1.3 Indicates whether the build will output relative path information as well.
Default value is: false.
<individualFiles> boolean 1.0 Indicates whether the build will store checksums in separate files (one file per algorithm per artifact).
Default value is: true.
<individualFilesOutputDirectory> String 1.0 The directory where output files will be stored. Leave unset to have each file next to the source file.
<quiet> boolean 1.0 Indicates whether the build will print checksums in the build log.
Default value is: false.
<relativeSubPath> String 1.3 Sub path to use as the root of the relative path when including relative path in xml/csv files
<shasumSummary> boolean 1.3 Indicates whether the build will store checksums to a single shasum summary file.
Default value is: false.
<shasumSummaryFile> String 1.3 The name of the summary file created if the option is activated.
Default value is: artifacts-checksums.sha.
<xmlSummary> boolean 1.0 Indicates whether the build will store checksums to a single XML summary file.
Default value is: false.
<xmlSummaryFile> String 1.0 The name of the summary file created if the option is activated.
Default value is: artifacts-checksums.xml.

Parameter Details

<algorithms>

The list of checksum algorithms used.

Default value is MD5 and SHA-1.

Allowed values are Cksum, CRC32, BLAKE2B-160, BLAKE2B-256, BLAKE2B-384, BLAKE2B-512, GOST3411, GOST3411-2012-256, GOST3411-2012-512, KECCAK-224, KECCAK-256, KECCAK-288, KECCAK-384, KECCAK-512, MD2, MD4, MD5, RIPEMD128, RIPEMD160, RIPEMD256, RIPEMD320, SHA, SHA-1, SHA-224, SHA-256, SHA3-224, SHA3-256, SHA3-384, SHA3-512, SHA-384, SHA-512, SHA-512/224, SHA-512/256, SKEIN-1024-1024, SKEIN-1024-384, SKEIN-1024-512, SKEIN-256-128, SKEIN-256-160, SKEIN-256-224, SKEIN-256-256, SKEIN-512-128, SKEIN-512-160, SKEIN-512-224, SKEIN-512-256, SKEIN-512-384, SKEIN-512-512, SM3, TIGER and WHIRLPOOL.

Use the following syntax:

<algorithms>
  <algorithm>MD5</algorithm>
  <algorithm>SHA-1</algorithm>
</algorithms>
  • Type: java.util.List
  • Since: 1.0
  • Required: No

<appendFilename>

Append the artifact filename in the generated checksum file. This parameter require the parameter individualFiles be equal to true.
  • Type: boolean
  • Since: 1.4
  • Required: No
  • Default: false

<attachChecksums>

Should the checksums be attached as build artifacts.
  • Type: boolean
  • Since: 1.3
  • Required: No
  • User Property: attachChecksums
  • Default: false

<csvSummary>

Indicates whether the build will store checksums to a single CSV summary file.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

<csvSummaryFile>

The name of the summary file created if the option is activated.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: artifacts-checksums.csv

<encoding>

Encoding to use for generated files.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

<failOnError>

Indicates whether the build will fail if there are errors.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

<includeRelativePath>

Indicates whether the build will output relative path information as well.
  • Type: boolean
  • Since: 1.3
  • Required: No
  • Default: false

<individualFiles>

Indicates whether the build will store checksums in separate files (one file per algorithm per artifact).
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

<individualFilesOutputDirectory>

The directory where output files will be stored. Leave unset to have each file next to the source file.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No

<quiet>

Indicates whether the build will print checksums in the build log.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

<relativeSubPath>

Sub path to use as the root of the relative path when including relative path in xml/csv files
  • Type: java.lang.String
  • Since: 1.3
  • Required: No

<shasumSummary>

Indicates whether the build will store checksums to a single shasum summary file.
  • Type: boolean
  • Since: 1.3
  • Required: No
  • Default: false

<shasumSummaryFile>

The name of the summary file created if the option is activated.
  • Type: java.lang.String
  • Since: 1.3
  • Required: No
  • Default: artifacts-checksums.sha

<xmlSummary>

Indicates whether the build will store checksums to a single XML summary file.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

<xmlSummaryFile>

The name of the summary file created if the option is activated.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: artifacts-checksums.xml