Files
jreleaser.github.io/docs/modules/configuration/pages/checksum.adoc
2021-05-30 23:26:15 +02:00

115 lines
2.3 KiB
Plaintext

= Checksum
JReleaser calculates checksums for all input files and artifacts. These checksums are grouped into a single file named
`checksums.txt` which in turn may be signed and uploaded to a release.
Use the following options to customize how checksums are handled:
include::partial$legend.adoc[]
[tabs]
====
YAML::
+
[source,yaml]
[subs="+macros"]
----
# icon:dot-circle[]
checksum:
# The name of the grouping checksums file.
# Defaults to `checksums.txt`.
# icon:dot-circle[] icon:file-alt[]
name: '{{projectName}}-{{projectVersion}}_checksums.txt'
# Uploads individual checksum files.
# Defaults to `false`.
# icon:dot-circle[]
individual: true
----
TOML::
+
[source,toml]
[subs="+macros"]
----
# icon:dot-circle[]
[checksum]
# The name of the grouping checksums file.
# Defaults to `checksums.txt`.
# icon:dot-circle[] icon:file-alt[]
name = "{{projectName}}-{{projectVersion}}_checksums.txt"
# Uploads individual checksum files.
# Defaults to `false`.
# icon:dot-circle[]
individual = true
----
JSON::
+
[source,json]
[subs="+macros"]
----
{
// icon:dot-circle[]
"checksum": {
// The name of the grouping checksums file.
// Defaults to `checksums.txt`.
// icon:dot-circle[] icon:file-alt[]
"name": "{{projectName}}-{{projectVersion}}_checksums.txt",
// Uploads individual checksum files.
// Defaults to `false`.
// icon:dot-circle[]
"individual": true
}
}
----
Maven::
+
[source,xml]
[subs="+macros,verbatim"]
----
<jreleaser>
<!--
icon:dot-circle[]
-->
<checksum>
<!--
The name of the grouping checksums file.
Defaults to `checksums.txt`.
icon:dot-circle[] icon:file-alt[]
-->
<name>{{projectName}}-{{projectVersion}}_checksums.txt</name>
<!--
Uploads individual checksum files.
Defaults to `false`.
icon:dot-circle[]
-->
<individual>true</individual>
</checksum>
</jreleaser>
----
Gradle::
+
[source,groovy]
[subs="+macros"]
----
jreleaser {
// icon:dot-circle[]
checksum {
// The name of the grouping checksums file.
// Defaults to `checksums.txt`.
// icon:dot-circle[] icon:file-alt[]
name = '{{projectName}}-{{projectVersion}}_checksums.txt'
// Uploads individual checksum files.
// Defaults to `false`.
// icon:dot-circle[]
individual = true
}
}
----
====