Review the following items before making your first release:
Sources must be inside a Git repository with at least one remote (default name
origin). You can change the default remote name to something else by setting a
The default branch name is
main. If you use a different name then you may set it explicitly in the configuration of the chosen releaser or set a
JRELEASER_BRANCHenvironment variable. This variable may also be set in the Environment configuration file.
JReleaser expects to be configured at the root of the Git project. If you configure it at some other location within the project structure then you may have to instruct JReleaser to search for the Git root:
Maven set the
jreleaser.git.root.searchproperty or use
<gitRootSearch>in the plugin’s configuration.
Gradle set the
gitRootSearchproperty on the
jreleaserextension or use the
Ant set the
The default project versioning scheme is Semantic Versioning.
The default tag format is
JReleaser will tag the release by default. If you do not want this then set the
trueon the chosen releaser.
The default distribution type is
You are encouraged to try your first releases locally (if all configured artifacts/files are available) running in dryrun mode:
JReleaser generates 2 files after most commands are run. These are
trace.log. The first contains a set of calculated values such as the project version, tag, timestamp, and more. The second contains the full execution log plus any stacktraces in case of errors. You’ll find these files inside the corresponding output directory:
[out | target | build]/jreleaser.