Document checksum configuration

This commit is contained in:
Andres Almiray
2021-05-17 22:52:38 +02:00
parent 65c43e4c1c
commit 49c216ba9d
6 changed files with 135 additions and 20 deletions

View File

@@ -1,6 +1,7 @@
* xref:index.adoc[]
** xref:environment.adoc[]
** xref:project.adoc[]
** xref:checksum.adoc[]
** xref:signing.adoc[]
** xref:release/index.adoc[]
*** xref:release/github.adoc[]

View File

@@ -0,0 +1,114 @@
= 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
}
}
----
====

View File

@@ -3,6 +3,6 @@
This section describes elements that can be configured in `jrelease.yml` file. This file can be generated by running
`jreleaser init --format yml` or start from scratch.
Other configuration formats besides YAML may be supported as well, such as TOML, JSON,
Other configuration formats besides YAML are supported as well, such as TOML, JSON,
the xref:tools:jreleaser-maven.adoc[Maven] DSL, the xref:tools:jreleaser-gradle.adoc[Gradle] DSL.

View File

@@ -1,11 +1,11 @@
* xref:index.adoc[]
** xref:github-actions.adoc[]
** xref:jenkins.adoc[]
** xref:circle-ci.adoc[]
** xref:codefresh.adoc[]
** xref:gitlab-ci.adoc[]
** xref:cirrus-ci.adoc[]
** xref:drone.adoc[]
** xref:buildkite.adoc[]
** xref:teamcity.adoc[]
** xref:circle-ci.adoc[]
** xref:cirrus-ci.adoc[]
** xref:codefresh.adoc[]
** xref:codeship.adoc[]
** xref:drone.adoc[]
** xref:github-actions.adoc[]
** xref:gitlab-ci.adoc[]
** xref:jenkins.adoc[]
** xref:teamcity.adoc[]

View File

@@ -7,13 +7,13 @@ xref:tools:jreleaser-maven.adoc[] or the xref:tools:jreleaser-gradle.adoc[] inst
Add the following to the Deploy tab as a "custom script"
[source,shell]
[source]
----
# Configure Java 11 if the previous steps used an older version of Java
jdk_switcher home openjdk11
jdk_switcher use openjdk11
#Get the jreleaser downloader
# Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
# Download JReleaser with version = <version>

View File

@@ -3,13 +3,13 @@
JReleaser can be run as part of a CI pipeline. The following options are currently available, with more to come
in the future:
* xref:github-actions.adoc[]
* xref:jenkins.adoc[]
* xref:circle-ci.adoc[]
* xref:codefresh.adoc[]
* xref:gitlab-ci.adoc[]
* xref:cirrus-ci.adoc[]
* xref:drone.adoc[]
* xref:buildkite.adoc[]
* xref:teamcity.adoc[]
* xref:circle-ci.adoc[]
* xref:cirrus-ci.adoc[]
* xref:codefresh.adoc[]
* xref:codeship.adoc[]
* xref:drone.adoc[]
* xref:github-actions.adoc[]
* xref:gitlab-ci.adoc[]
* xref:jenkins.adoc[]
* xref:teamcity.adoc[]