bld-jreleaser/README.md
Erik C. Thauvin dd39ff1509
Some checks are pending
bld-ci / build-bld-project (17) (push) Waiting to run
bld-ci / build-bld-project (21) (push) Waiting to run
bld-ci / build-bld-project (23) (push) Waiting to run
javadocs-pages / deploy (push) Waiting to run
docs: Add generic installation instruction
2025-03-18 13:10:46 -07:00

2.4 KiB
Executable file

JReleaser Extension for bld

License Java bld Release Snapshot GitHub CI

To install the latest version, add the following to the lib/bld/bld-wrapper.properties file:

bld.extension-jreleaser=com.uwyn.rife2:bld-jreleaser

For more information, please refer to the extensions documentation.

Generate JReleaser Config File

To generate a JReleaser config file, add the following to your build file:

@BuildCommand(value = "jreleaser-init", summary = "Create a JReleaser config file.")
public void jreleaserInit() throws Exception {
    new JReleaserInitOperation()
            .fromProject(this)
            .overwrite().debug()
            .format(JReleaserInitOperation.Format.JSON)
            .execute();
}

Then run the following command:

./bld jreleaser-init

Please check the documentation for all available configuration options.

JReleaser Dependency

Don't forget to add the JReleaser dependency to your build file, as they are not provided by the extension. For example:

repositories = List.of(MAVEN_CENTRAL);
scope(provided)
     .include(dependency("org.jreleaser", "jreleaser", version(1, 17, 0)));