Install
There are multiple choices depending on your preference.
CLI
The CLI can be installed in the following ways:
Early Access
JBang
// Download, cache, and run
jbang jreleaser-snapshot@jreleaser <command> [<args>]
manually
Download the pre-compiled binary from the releases page, uncompress and copy to the desired location.
Be mindful that jreleaser-early-access.zip requires Java 8 to be installed while
jreleaser-standalone-early-access-windows-*.zip can be used without a previous installation of Java as
it includes its own Java Runtime.
|
JBang
// Download, cache, and run
jbang jreleaser-snapshot@jreleaser <command> [<args>]
Curl
Requires Java 11
// Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
// Download JReleaser with version = early-access
java get_jreleaser.java early-access
// Execute JReleaser
java -jar jreleaser-cli.jar <command> [<args>]
manually
Download the pre-compiled binary from the releases page, uncompress and copy to the desired location.
Be mindful that jreleaser-early-access.zip requires Java 8 to be installed while
jreleaser-standalone-early-access-linux-*.zip can be used without a previous installation of Java as
it includes its own Java Runtime.
|
JBang
// Download, cache, and run
jbang jreleaser-snapshot@jreleaser <command> [<args>]
Curl
Requires Java 11
// Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
// Download JReleaser with version = early-access
java get_jreleaser.java early-access
// Execute JReleaser
java -jar jreleaser-cli.jar <command> [<args>]
Dagger
Head to the documentation page of the universe.dagger.io/alpha/jreleaser package to find out how to configure JReleaser in your Dagger powered CI/CD pipeline.
manually
Download the pre-compiled binary from the releases page, uncompress and copy to the desired location.
Be mindful that jreleaser-early-access.zip requires Java 8 to be installed while
jreleaser-standalone-early-access-osx-*.zip can be used without a previous installation of Java as
it includes its own Java Runtime.
|
Stable
Sdkman
Requires Java 8
sdk install jreleaser
Scoop:
Requires Java 8
scoop bucket add jreleaser https://github.com/jreleaser/scoop-jreleaser.git
scoop install jreleaser
JBang
// Download, cache, and run
jbang jreleaser@jreleaser <command> [<args>]
Chocolatey
Requires Java 8
choco install jreleaser
manually
Download the pre-compiled binary from the releases page, uncompress and copy to the desired location.
Be mindful that jreleaser-1.15.0-SNAPSHOT.zip requires Java 8 to be installed while
jreleaser-standalone-1.15.0-SNAPSHOT-windows-*.zip can be used without a previous installation of Java as
it includes its own Java Runtime.
|
Sdkman
Requires Java 8
sdk install jreleaser
Homebrew core
brew install jreleaser
Formula available from v1.4.0 and upwards
|
Homebrew tap
brew install jreleaser/tap/jreleaser
All versions available from tap. |
JBang
// Download, cache, and run
jbang jreleaser@jreleaser <command> [<args>]
Fedora COPR
dnf install dnf-plugins-core
dnf copr enable aalmiray/jreleaser
dnf install jreleaser
Flatpak
flatpak install --user flathub org.jreleaser.cli
flatpak run org.jreleaser.cli
Snap
snap install jreleaser
AppImage
curl https://github.com/jreleaser/jreleaser-appimage/releases/download/v{project-version}/jreleaser-{project-version}-x86_64.AppImage --output jreleaser
chmod +x jreleaser
Apk
apk add jreleaser --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing/
Curl
Requires Java 11
// Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
// Download JReleaser with version = <version>
// Change <version> to a tagged JReleaser release
// or leave it out to pull `latest`.
java get_jreleaser.java <version>
// Execute JReleaser
java -jar jreleaser-cli.jar <command> [<args>]
Dagger
Head to the documentation page of the universe.dagger.io/alpha/jreleaser package to find out how to configure JReleaser in your Dagger powered CI/CD pipeline.
manually
Download the pre-compiled binary from the releases page, uncompress and copy to the desired location.
Be mindful that jreleaser-1.15.0-SNAPSHOT.zip requires Java 8 to be installed while
jreleaser-standalone-1.15.0-SNAPSHOT-linux-*.zip can be used without a previous installation of Java as
it includes its own Java Runtime.
|
Sdkman
Requires Java 8
sdk install jreleaser
Homebrew core
brew install jreleaser
Formula available from v1.4.0 and upwards
|
Homebrew tap
brew install jreleaser/tap/jreleaser
All versions available from tap. |
JBang
// Download, cache, and run
jbang jreleaser@jreleaser <command> [<args>]
Macports
Requires Java 8
port install jreleaser
Curl
Requires Java 11
// Get the jreleaser downloader
curl -sL https://git.io/get-jreleaser > get_jreleaser.java
// Download JReleaser with version = <version>
// Change <version> to a tagged JReleaser release
// or leave it out to pull `latest`.
java get_jreleaser.java <version>
// Execute JReleaser
java -jar jreleaser-cli.jar <command> [<args>]
manually
Download the pre-compiled binary from the releases page, uncompress and copy to the desired location.
Be mindful that jreleaser-1.15.0-SNAPSHOT.zip requires Java 8 to be installed while
jreleaser-standalone-1.15.0-SNAPSHOT-osx-*.zip can be used without a previous installation of Java as
it includes its own Java Runtime.
|
Docker
You can run JReleaser as a docker image, skipping the need to have a pre-installed Java runtime. You must mount the
working directory at the /workspace
volume, for example assuming the current directory is the starting point:
docker run -it --rm -v `(pwd)`:/workspace \
jreleaser/<image>:<tag> <command> [<args>]
Where image may be jreleaser-slim
, jreleaser-alpine
.
The jreleaser command will be automatically executed inside /workspace .
|
You may also need to map environment variables to the container, such as JRELEASER_PROJECT_VERSION
,
JRELEASER_GITHUB_TOKEN
, or others depending on your setup. Refer to the Reference pages.
You can find the tag listing here.
Apache Maven
Configure the jreleaser-maven-plugin in your POM file
<plugin>
<groupId>org.jreleaser</groupId>
<artifactId>jreleaser-maven-plugin</artifactId>
<version>1.15.0-SNAPSHOT</version>
</plugin>
Gradle
Configure the jreleaser-gradle-plugin in your build.gradle
file
plugins {
id 'org.jreleaser' version '1.15.0-SNAPSHOT'
}
Apache Ant
Download the jreleaser-ant-tasks ZIP bundle from the
releases page and unzip it in your project. Place all JARs inside
the lib
folder. Create this folder if there is none. Add the following elements to your build.xml
file
<path id="jreleaser.classpath">
<fileset dir="lib">
<include name="jreleaser-ant-tasks-1.15.0-SNAPSHOT/*.jar"/>
</fileset>
</path>
<import>
<javaresource name="org/jreleaser/ant/targets.xml"
classpathref="jreleaser.classpath"/>
</import>