Add jreleaser guide for native executables #22284

aalmiray · 2021-12-16T12:57:24Z

This guide shows how JReleaser may be used to create releases for Quarkus CLI applications built as native executables with GraalVM Native Image.

gsmet

Nice work, thanks a lot for taking the time to write this! I spotted a couple of minor things, see inline.

gsmet · 2021-12-16T14:17:11Z

docs/src/main/asciidoc/jreleaser.adoc

+:toc: macro
+:toclevels: 4
+:doctype: book
+:icons: font
+:docinfo1:


Can you remove all this? It's managed automatically in the website and I don't want it to conflict.

Sure. I used getting-started.adoc as a starting point which also defines these attributes btw ;-)

gsmet · 2021-12-16T14:17:41Z

docs/src/main/asciidoc/jreleaser.adoc

+
+== Bootstrapping the project
+
+First, we need a project that defining a CLI application. We recommend using the xref:picocli.adoc[PicoCLI] extension. 


Suggested change

First, we need a project that defining a CLI application. We recommend using the xref:picocli.adoc[PicoCLI] extension.

First, we need a project that defines a CLI application. We recommend using the xref:picocli.adoc[PicoCLI] extension.

gsmet · 2021-12-16T14:17:59Z

docs/src/main/asciidoc/jreleaser.adoc

+cd app
+----
+
+This command initializes the file structure and the minimum set of required files in the project


Suggested change

This command initializes the file structure and the minimum set of required files in the project

This command initializes the file structure and the minimum set of required files in the project:

gsmet · 2021-12-16T14:18:11Z

docs/src/main/asciidoc/jreleaser.adoc

+            └── application.properties
+----
+
+It will also configure the picocli extension in the `pom.xml`


Suggested change

It will also configure the picocli extension in the `pom.xml`

It will also configure the picocli extension in the `pom.xml`:

gsmet · 2021-12-16T14:18:58Z

docs/src/main/asciidoc/jreleaser.adoc

+Store the newly created token at a safe place for future reference. Next, you have the choice of configuring the token
+as an environment variable named `JRELEASER_GITHUB_TOKEN` so that the tool can read it. Alternatively you may store
+the token at a secure location of your choosing, using a `.yml`, `.toml`, `.json`, or `.properties` file. The default
+location is `~/.jreleaser/config[format]`. For example, using the `.yml` format this file could look like


Suggested change

location is `~/.jreleaser/config[format]`. For example, using the `.yml` format this file could look like

location is `~/.jreleaser/config[format]`. For example, using the `.yml` format this file could look like:

gsmet · 2021-12-16T14:26:39Z

docs/src/main/asciidoc/jreleaser.adoc

+
+== Configuring Homebrew as a packager
+
+link:https://brew.sh/[Homebrew] is a popular choice among OSX users to install and manage binaries. Homebrew packages


Suggested change

link:https://brew.sh/[Homebrew] is a popular choice among OSX users to install and manage binaries. Homebrew packages

link:https://brew.sh/[Homebrew] is a popular choice among macOS users to install and manage binaries. Homebrew packages

gsmet · 2021-12-16T14:26:51Z

docs/src/main/asciidoc/jreleaser.adoc

+are at their core a Ruby file (known as a formula) that's executed on the target environment to install or upgrade a
+particular binary. JReleaser can create formulae from binary distributions such as the one we already have configured.
+
+For this to work we simply have to enable Homebrew in the JReleaser plugin configuration like so


Suggested change

For this to work we simply have to enable Homebrew in the JReleaser plugin configuration like so

For this to work we simply have to enable Homebrew in the JReleaser plugin configuration like so:

gsmet · 2021-12-16T14:27:35Z

docs/src/main/asciidoc/jreleaser.adoc

+its first release; subsequent release require less tampering with configuration. We can create a git release and the
+Homebrew formula with the `jreleaser:full-release` goal but if you still have some doubts on how things may play out then
+you can invoke the goal in dry-run mode that is, let JReleaser perform all local operations as needed without affecting 
+remote resources such as git repositories. This is how it would look like:


Suggested change

remote resources such as git repositories. This is how it would look like:

remote resources such as Git repositories. This is how it would look like:

gsmet · 2021-12-16T14:28:29Z

docs/src/main/asciidoc/jreleaser.adoc

+* Create a Homebrew formula, publishing to pass:[https://gitcom.com/aamiray/homebrew-tap].
+
+Of course no remote repository was affected as we can appreciate the `-Djreleaser.dryrun` property was in effect. If you're
+so incline inspect the contents of `target/jreleaser/package/app/brew/Formula/app.rb` which defines the Homebrew formula


Suggested change

so incline inspect the contents of `target/jreleaser/package/app/brew/Formula/app.rb` which defines the Homebrew formula

so inclined, inspect the contents of `target/jreleaser/package/app/brew/Formula/app.rb` which defines the Homebrew formula

gsmet · 2021-12-16T14:29:44Z

docs/src/main/asciidoc/jreleaser.adoc

+    -DclassName="org.acme.cli.GreetingCommand" \
+    -Dextensions="picocli"
+
+cd app


I wonder if we should publish the result of your work as a quickstart project in our quickstart repository. I'm not sure it will fly though as I suppose to really work, you would need this thing in a separate project?

Maybe one option would be to put the whole pom file for reference at the end of this guide?

I briefly discussed the idea of an extension with @gunnarmorling however as you may see in this doc most changes are build specific and require no compile/runtime extensions. If this is something that's doable with Quarkus' tool support then I'd be happy to discuss how we could proceed.

Good suggestion on showing the full pom file at the end of the guide. I'll add it.

aalmiray · 2021-12-16T15:30:14Z

Applied all suggestions. Squashed and force pushed.

gsmet · 2021-12-16T15:39:21Z

docs/src/main/asciidoc/jreleaser.adoc

+you can invoke the goal in dry-run mode that is, let JReleaser perform all local operations as needed without affecting
+remote resources such as Git repositories. This is how it would look like:
+
+[source,subs=attributes+]


This listing was rendered very weirdly, I removed the macro+ part and force pushed.

gsmet

Perfect, thanks!

aalmiray · 2021-12-16T17:00:41Z

@gsmet thank you for the reviews!
@geoand thank you for merging!

Is there anything else I have to do from my side to get the guide published on the site?

geoand · 2021-12-16T17:07:30Z

Thanks for your work on this!

Is there anything else I have to do from my side to get the guide published on the site?

It will become available when 2.6.0.Final is released, which should be soon :)

Follow up from quarkusio#22284

Follow up from quarkusio#22284 (cherry picked from commit 10f5218)

quarkus-bot bot added the area/documentation label Dec 16, 2021

geoand requested a review from maxandersen December 16, 2021 13:05

gsmet requested changes Dec 16, 2021

View reviewed changes

aalmiray force-pushed the guide-jreleaser branch from 7812a90 to ebedf69 Compare December 16, 2021 15:29

aalmiray force-pushed the guide-jreleaser branch from ebedf69 to 50d64f1 Compare December 16, 2021 15:33

Add jreleaser guide for native executables

7dfd03d

gsmet force-pushed the guide-jreleaser branch from 50d64f1 to 7dfd03d Compare December 16, 2021 15:38

gsmet reviewed Dec 16, 2021

View reviewed changes

gsmet approved these changes Dec 16, 2021

View reviewed changes

gsmet added triage/waiting-for-ci Ready to merge when CI successfully finishes triage/backport? labels Dec 16, 2021

geoand merged commit c6b4c59 into quarkusio:main Dec 16, 2021

quarkus-bot bot added this to the 2.7 - main milestone Dec 16, 2021

quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Dec 16, 2021

aalmiray deleted the guide-jreleaser branch December 16, 2021 16:57

gastaldi added a commit to gastaldi/quarkus that referenced this pull request Dec 16, 2021

Fix minor typo in jreleaser guide

10f5218

Follow up from quarkusio#22284

gastaldi mentioned this pull request Dec 16, 2021

Fix minor typo in jreleaser guide #22300

Merged

gsmet modified the milestones: 2.7 - main, 2.6.1.Final Dec 22, 2021

gsmet removed the triage/backport? label Dec 22, 2021

gsmet pushed a commit to gsmet/quarkus that referenced this pull request Dec 22, 2021

Fix minor typo in jreleaser guide

8f72cd3

Follow up from quarkusio#22284 (cherry picked from commit 10f5218)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add jreleaser guide for native executables #22284

Add jreleaser guide for native executables #22284

aalmiray commented Dec 16, 2021 •

edited

Loading

gsmet left a comment

gsmet Dec 16, 2021

aalmiray Dec 16, 2021

gsmet Dec 16, 2021

aalmiray Dec 16, 2021

gsmet Dec 16, 2021

aalmiray Dec 16, 2021

gsmet Dec 16, 2021

aalmiray Dec 16, 2021

gsmet Dec 16, 2021

aalmiray Dec 16, 2021

gsmet Dec 16, 2021

aalmiray Dec 16, 2021

gsmet Dec 16, 2021

aalmiray Dec 16, 2021

gsmet Dec 16, 2021

aalmiray Dec 16, 2021

gsmet Dec 16, 2021

aalmiray Dec 16, 2021

gsmet Dec 16, 2021

aalmiray Dec 16, 2021 •

edited

Loading

aalmiray commented Dec 16, 2021 •

edited

Loading

gsmet Dec 16, 2021

gsmet left a comment

aalmiray commented Dec 16, 2021

geoand commented Dec 16, 2021


		== Bootstrapping the project

		First, we need a project that defining a CLI application. We recommend using the xref:picocli.adoc[PicoCLI] extension.

	First, we need a project that defining a CLI application. We recommend using the xref:picocli.adoc[PicoCLI] extension.
	First, we need a project that defines a CLI application. We recommend using the xref:picocli.adoc[PicoCLI] extension.

	This command initializes the file structure and the minimum set of required files in the project
	This command initializes the file structure and the minimum set of required files in the project:

	It will also configure the picocli extension in the `pom.xml`
	It will also configure the picocli extension in the `pom.xml`:

	location is `~/.jreleaser/config[format]`. For example, using the `.yml` format this file could look like
	location is `~/.jreleaser/config[format]`. For example, using the `.yml` format this file could look like:


		== Configuring Homebrew as a packager

		link:https://brew.sh/[Homebrew] is a popular choice among OSX users to install and manage binaries. Homebrew packages

	For this to work we simply have to enable Homebrew in the JReleaser plugin configuration like so
	For this to work we simply have to enable Homebrew in the JReleaser plugin configuration like so:

	remote resources such as git repositories. This is how it would look like:
	remote resources such as Git repositories. This is how it would look like:

	so incline inspect the contents of `target/jreleaser/package/app/brew/Formula/app.rb` which defines the Homebrew formula
	so inclined, inspect the contents of `target/jreleaser/package/app/brew/Formula/app.rb` which defines the Homebrew formula

Add jreleaser guide for native executables #22284

Add jreleaser guide for native executables #22284

Conversation

aalmiray commented Dec 16, 2021 • edited Loading

gsmet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aalmiray Dec 16, 2021 • edited Loading

Choose a reason for hiding this comment

aalmiray commented Dec 16, 2021 • edited Loading

Choose a reason for hiding this comment

gsmet left a comment

Choose a reason for hiding this comment

aalmiray commented Dec 16, 2021

geoand commented Dec 16, 2021

aalmiray commented Dec 16, 2021 •

edited

Loading

aalmiray Dec 16, 2021 •

edited

Loading

aalmiray commented Dec 16, 2021 •

edited

Loading