feat: support for jbang built extensions #1951

maxandersen · 2025-07-28T20:29:21Z

Fixes #1952

Context

Adds support for using jbang to define extensions.

extensions:
  github-summary:
    jbang: misc/jreleaser-extension/githubjobsummary.java

Checklist

Review Contribution Guidelines.
Make sure all contributed code can be distributed under the terms of the
Apache License 2.0, e.g. the code was written by
you or the original code is licensed under a license compatible to Apache License 2.0.
Update documentation when applicable.

CLAassistant · 2025-07-28T20:29:27Z

All committers have signed the CLA.

aalmiray · 2025-07-28T20:37:10Z

api/jreleaser-model-api/src/main/java/org/jreleaser/model/api/extensions/Extension.java

@@ -34,6 +34,8 @@ public interface Extension extends Domain, EnabledAware {

    String getDirectory();

+    String getJBang();


Gradle DSL requires a similar update

jreleaser/plugins/jreleaser-gradle-plugin/src/main/groovy/org/jreleaser/gradle/plugin/dsl/extensions/Extension.groovy

Line 32 in 522d6f9

interface Extension {

gotcha - i'm wondering if it would make sense to make room for jbang arguments ?

i.e. technically you can affect/modify the build with jbang arguments like jbang -Dkey=value --compile-options etc.

maybe that should be a jbang-args flag ?

jbang: - scriptref: myext.java - args: ...

is an alternative but would be sad to loose the simplicity of jbang: myext.java ...or do you allow maps|string option in jreleaser elsewhere?

Well, there's a map in environment: for extra properties but it may not necessarily be available at the time extensions are loaded.

Also would prefer if the additional args were set closer to where they are needed.

We would have to decide how to do it as changing the type after the next release would constitute a breaking change.

What other elements may be required besides script and args?

similar as https://github.com/jbangdev/jbang-gradle-plugin and maven ones...

the main ones are script, jbang-args and trust (although trust we could consider auto add/remove in calls but feels risky ;)

Ok, so we need 4 properties:

script

args

jbangArgs

trusts

To keep compatibility with names found in other UIs. This means adding a pair of classes in model-api and model-impl following the patterns for other Domain subtypes. The gradle DSL would require similar changes, which I can take care of.

args itself does not make sense here - as jreleaser does its own init and skips any main method calling.

Version should also be specified otherwise the default bundled version will always be chosen.

I can refactor the code later after merge.

but thats the same for maven ?

core/jreleaser-model-impl/src/main/java/org/jreleaser/model/internal/extensions/Extension.java

aalmiray · 2025-07-28T20:39:15Z

core/jreleaser-model-impl/src/main/java/org/jreleaser/model/internal/extensions/Extension.java

@@ -65,6 +66,11 @@ public String getDirectory() {
            return directory;
        }

+        @Override


Please update the serialVersionUID at

jreleaser/core/jreleaser-model-impl/src/main/java/org/jreleaser/model/internal/extensions/Extension.java

Line 39 in 522d6f9

private static final long serialVersionUID = 8235578876272898842L;

jreleaser/core/jreleaser-model-impl/src/main/java/org/jreleaser/model/internal/extensions/Extension.java

Line 49 in 522d6f9

private static final long serialVersionUID = -8554317090414988356L;

i've bumped +1 but also //TODO'ed as i dont have a serial version generator handy

sdks/jreleaser-tool-java-sdk/src/main/java/org/jreleaser/sdk/tool/AbstractTool.java

sdks/jreleaser-tool-java-sdk/src/main/resources/META-INF/jreleaser/tools/jbang.properties

...releaser-engine/src/main/java/org/jreleaser/extensions/internal/DefaultExtensionManager.java

aalmiray · 2025-07-28T20:44:03Z

Build failed due to checkstyle

 Error: eckstyle] [ERROR] /home/runner/work/jreleaser/jreleaser/sdks/jreleaser-tool-java-sdk/src/main/java/org/jreleaser/sdk/tool/AbstractTool.java:23:8: Unused import - org.jreleaser.sdk.command.Command.Result. [UnusedImports]

...er-gradle-plugin/src/main/groovy/org/jreleaser/gradle/plugin/dsl/extensions/Extension.groovy

maxandersen · 2025-07-28T21:43:45Z

I pushed update that adds recursive scanning of .jar in extension directories + use jbang export portable instead of jbang export local.

And it works...BUT you get:

out/jreleaser/extensions/github-summary/
├── github-summary.jar
└── lib
├── autolink-0.10.0.jar
├── bcpg-jdk18on-1.80.jar
├── bcprov-jdk18on-1.80.jar
├── commonmark-0.21.0.jar
├── commonmark-ext-autolink-0.21.0.jar
├── commons-codec-1.18.0.jar
├── commons-compress-1.27.1.jar
├── commons-io-2.16.1.jar
├── commons-lang3-3.16.0.jar
├── compiler-0.9.14.jar
├── jackson-annotations-2.19.0.jar
├── jackson-core-2.19.0.jar
├── jackson-databind-2.19.0.jar
├── jcl-over-slf4j-2.0.17.jar
├── jipsy-annotations-1.2.0.jar
├── jipsy-processor-1.2.0.jar
├── jreleaser-logger-api-1.18.0.jar
├── jreleaser-model-api-1.18.0.jar
├── jreleaser-resource-bundle-1.18.0.jar
├── jreleaser-utils-1.18.0.jar
├── slf4j-api-2.0.17.jar
├── xz-1.10.jar
└── zstd-jni-1.5.7-2.jar

which seems wasteful :)

I see two things:

update jreleaser mechanism to be able to refer to list of jars from the maven repository - jbang can give the list in a json to parse....that avoids copying the same jar around N times and taking up uneccsary space.
but even with that; even though above works where my ext use 1.18 and jreleaser is 1.20; i could imagine there being conflicts where export local would be better?

maxandersen · 2025-07-29T08:37:05Z

I made jreleaser/jreleaser.github.io#91 as suggestion for docs.

feat: support for jbang built extensions

6d51f41

aalmiray assigned maxandersen Jul 28, 2025

aalmiray added the enhancement New feature or request label Jul 28, 2025

aalmiray requested changes Jul 28, 2025

View reviewed changes

chore: fixes from pr review

96fa40c

maxandersen commented Jul 28, 2025

View reviewed changes

...er-gradle-plugin/src/main/groovy/org/jreleaser/gradle/plugin/dsl/extensions/Extension.groovy Show resolved Hide resolved

maxandersen added 2 commits July 28, 2025 23:17

chore: add TODO for serialversionuid

71a8e21

feat: recursive search for .jars + use export portable jbang

f490958

maxandersen marked this pull request as ready for review July 28, 2025 22:16

aalmiray approved these changes Jul 29, 2025

View reviewed changes

chore: use Jbang() over JBang() in api

c02b7e1

aalmiray added this to the v1.20.0 milestone Jul 29, 2025

aalmiray merged commit a3d96cb into jreleaser:main Jul 29, 2025
9 checks passed

maxandersen mentioned this pull request Jul 30, 2025

Scoped and managed dependencies jbangdev/jbang#2126

Open

5 tasks

		@@ -34,6 +34,8 @@ public interface Extension extends Domain, EnabledAware {

		String getDirectory();

		String getJBang();

Uh oh!

feat: support for jbang built extensions #1951

feat: support for jbang built extensions #1951

Uh oh!

Conversation

maxandersen commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Checklist

Uh oh!

CLAassistant commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aalmiray Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aalmiray commented Jul 28, 2025

Uh oh!

Uh oh!

maxandersen commented Jul 28, 2025

Uh oh!

maxandersen commented Jul 29, 2025

Uh oh!

Uh oh!

Uh oh!

maxandersen commented Jul 28, 2025 •

edited

Loading

CLAassistant commented Jul 28, 2025 •

edited

Loading

aalmiray Jul 28, 2025 •

edited

Loading