jlengrand/jreleaser.github.io
1
0
Fork 0
mirror of https://github.com/jlengrand/jreleaser.github.io.git synced 2026-03-10 08:31:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document changes of https://github.com/jreleaser/jreleaser/issues/105

Browse Source
This commit is contained in:
Andres Almiray
2021-05-05 00:26:40 +02:00
parent 0c6fe62592
commit 836d858005
13 changed files with 43 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/modules/ROOT/assets/images/jreleaser-workflow.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 109 KiB

After

Width:  |  Height:  |  Size: 146 KiB

2
docs/modules/ROOT/pages/artifacts.adoc
View File

@@ -3,7 +3,7 @@
Artifacts are at the heart of a release; they define files that may be:
* added to a Git xref:configuration:release/index.adoc[release].
* prepared, packaged, and uploaded using a xref:configuration:packagers/index.adoc[packager].
* prepared, packaged, and published using a xref:configuration:packagers/index.adoc[packager].
Artifacts refer to a specific file as they have a single `path` property. Globs on the other hand refer to a collection
of files.

6
docs/modules/ROOT/pages/workflow.adoc
View File

@@ -18,7 +18,7 @@ The following sections describe these steps:
== Assemble
Assembles distributions such as Jlink and Native Image. Outputs will automatically configure/update matching named
distributions for xref:_prepare[], xref:_package[], and xref:_upload[].
distributions for xref:_prepare[], xref:_package[], and xref:_publish[].
Given the nature of platform specific distributions this step must be invoked separatedly from the others.
@@ -79,7 +79,7 @@ Packaged files will be placed at `${basedir}/out/jreleaser/${distributionName}/$
Depends on <<_prepare>>.
== Upload
== Publish
Publishes packaged files to their respective destinations. For example, for xref:configuration:packagers/homebrew.adoc[]
this means creating or updating a "hombrew-tap" repository, for xref:configuration:packagers/jbang.adoc[] this means
@@ -108,5 +108,5 @@ Executes all steps in single session in the following order:
* <<_release>>
* <<_prepare>>
* <<_package>>
* <<_upload>>
* <<_publish>>
* <<_announce>>

6
docs/modules/examples/pages/cross-platform-jlink.adoc
View File

@@ -400,9 +400,9 @@ $ jreleaser full-release
[INFO] [docker] packaging app distribution
[INFO] [docker] - duke/app:v1.0.0
[INFO] [docker] sha256:a8eb8c32b795b320a3b52e9c6e62e5c6845def2fee83fd30b2a82b20b7c542a9
[INFO] Uploading distributions
[INFO] - Uploading app distribution
[INFO] [docker] uploading app distribution
[INFO] Publishing distributions
[INFO] - Publishing app distribution
[INFO] [docker] publishing app distribution
[INFO] [docker] - duke/app:v1.0.0
[INFO] [docker] Removing login credentials for https://index.docker.io/v1/
[INFO] Announcing release

2
docs/modules/examples/pages/simple-release.adoc
View File

@@ -2,7 +2,7 @@
The following configuration creates and tags a release at the chosen Git repository, in this case it will be
pass:[https://github.com/duke/app]. The changelog will be automatically computed. No additional files nor
distributions will be checksumed, signed, nor uploaded.
distributions will be checksumed, signed, nor published.
[tabs]
====

4
docs/modules/quick-start/pages/ant.adoc
View File

@@ -89,8 +89,8 @@ Preparing distributions
- Preparing app distribution
Packaging distributions
- Packaging app distribution
Uploading distributions
- Uploading app distribution
Publishing distributions
- Publishing app distribution
Announcing release
Announcing is not enabled. Skipping.
JReleaser succeeded after 0.894s

4
docs/modules/quick-start/pages/cli.adoc
View File

@@ -77,8 +77,8 @@ $ jreleaser full-release
[INFO] - Preparing app distribution
[INFO] Packaging distributions
[INFO] - Packaging app distribution
[INFO] Uploading distributions
[INFO] - Uploading app distribution
[INFO] Publishing distributions
[INFO] - Publishing app distribution
[INFO] Announcing release
[INFO] Announcing is not enabled. Skipping.
[INFO] JReleaser succeeded after 0.894s

4
docs/modules/quick-start/pages/gradle.adoc
View File

@@ -160,8 +160,8 @@ $ gradle jreleaseFullRelease
[INFO] - Preparing app distribution
[INFO] Packaging distributions
[INFO] - Packaging app distribution
[INFO] Uploading distributions
[INFO] - Uploading app distribution
[INFO] Publishing distributions
[INFO] - Publishing app distribution
[INFO] Announcing release
[INFO] Announcing is not enabled. Skipping.
[INFO] JReleaser succeeded after 0.894s

4
docs/modules/quick-start/pages/maven.adoc
View File

@@ -237,8 +237,8 @@ $ mvn jreleaser:full-release
[INFO] - Preparing app distribution
[INFO] Packaging distributions
[INFO] - Packaging app distribution
[INFO] Uploading distributions
[INFO] - Uploading app distribution
[INFO] Publishing distributions
[INFO] - Publishing app distribution
[INFO] Announcing release
[INFO] Announcing is not enabled. Skipping.
[INFO] JReleaser succeeded after 0.894s

10
docs/modules/tools/pages/jreleaser-ant.adoc
View File

@@ -167,7 +167,7 @@ Description:: Skips execution of this task.
=== jreleaser-assemble
Upload all distributions.
Assemble all distributions.
*configFile*
[horizontal]
@@ -399,9 +399,9 @@ Property:: jreleaser.skip
Required:: false
Description:: Skips execution of this task.
=== jreleaser-upload
=== jreleaser-publish
Upload all distributions.
Publish all distributions.
*configFile*
[horizontal]
@@ -419,7 +419,7 @@ Type:: String
Default value:: <none>
Property:: jreleaser.distribution.name
Required:: false
Description:: The name of the distribution to be upload.
Description:: The name of the distribution to be published.
---
@@ -429,7 +429,7 @@ Type:: String
Default value:: <none>
Property:: jreleaser.tool.name
Required:: false
Description:: The name of the tool for uploading distributions.
Description:: The name of the tool for publishing distributions.
---

26
docs/modules/tools/pages/jreleaser-cli.adoc
View File

@@ -20,7 +20,7 @@ Commands:
release Create or update a release..
prepare Prepare all distributions.
package Package all distributions.
upload Upload all distributions.
publish Publish all distributions.
announce Announce a release.
full-release Perform a full release.
----
@@ -481,14 +481,14 @@ $ jreleaser package --distribution-name app --tool-name brew
NOTE: Use `-y` or `--dryrun` during development to verify your configuration settings. No network uploads nor repository
mutations should occur when this mode is activated.
=== upload
=== publish
[source,bash]
----
$ jreleaser upload -h
Usage: jreleaser upload [-dhiqVwy] [-b=<basedir>] [-c=<configFile>]
$ jreleaser publish -h
Usage: jreleaser publish [-dhiqVwy] [-b=<basedir>] [-c=<configFile>]
[-dn=<distributionName>] [-tn=<toolName>]
Upload all distributions.
Publish all distributions.
-b, --basedir=<basedir> Base directory.
-c, --config-file=<configFile>
The config file
@@ -516,28 +516,28 @@ The value of `--tool-name` must match any of the available xref:configuration:pa
You may invoke this command in the following ways:
Upload all distributions:
Publish all distributions:
[source,bash]
----
$ jreleaser upload
$ jreleaser publish
----
Upload a single distribution with all configured tools:
Publish a single distribution with all configured tools:
[source,bash]
----
$ jreleaser upload --distribution-name app
$ jreleaser publish --distribution-name app
----
Upload all distributions with a single tool:
Publish all distributions with a single tool:
[source,bash]
----
$ jreleaser upload --tool-name brew
$ jreleaser publish --tool-name brew
----
Upload a single distribution with a single tool:
Publish a single distribution with a single tool:
[source,bash]
----
$ jreleaser upload --distribution-name app --tool-name brew
$ jreleaser publish --distribution-name app --tool-name brew
----
NOTE: Use `-y` or `--dryrun` during development to verify your configuration settings. No network uploads nor repository

8
docs/modules/tools/pages/jreleaser-gradle.adoc
View File

@@ -182,9 +182,9 @@ Option:: tool-name
Required:: false
Description:: The name of the tool for packaging distributions.
=== jreleaserUpload
=== jreleaserPublish
Upload all distributions.
Publish all distributions.
*distributionName*
[horizontal]
@@ -192,7 +192,7 @@ Type:: String
Default value:: <none>
Option:: distribution-name
Required:: false
Description:: The name of the distribution to be upload.
Description:: The name of the distribution to be published.
---
@@ -202,7 +202,7 @@ Type:: String
Default value:: <none>
Option:: tool-name
Required:: false
Description:: The name of the tool for uploading distributions.
Description:: The name of the tool for publishing distributions.
=== jreleaserAnnounce

10
docs/modules/tools/pages/jreleaser-maven.adoc
View File

@@ -290,9 +290,9 @@ Property:: jreleaser.package.skip
Required:: false
Description:: Skips execution of this MOJO.
=== jreleaser:upload
=== jreleaser:publish
Upload all distributions.
Publish all distributions.
*distributionName*
[horizontal]
@@ -300,7 +300,7 @@ Type:: String
Default value:: <none>
Property:: jreleaser.distribution.name
Required:: false
Description:: The name of the distribution to be upload.
Description:: The name of the distribution to be published.
---
@@ -310,7 +310,7 @@ Type:: String
Default value:: <none>
Property:: jreleaser.tool.name
Required:: false
Description:: The name of the tool for uploading distributions.
Description:: The name of the tool for publishing distributions.
---
@@ -328,7 +328,7 @@ Description: Skips remote operations.
[horizontal]
Type:: boolean
Default value:: false
Property:: jreleaser.upload.skip
Property:: jreleaser.publish.skip
Required:: false
Description:: Skips execution of this MOJO.