jreleaser / jreleaser.github.io Goto Github PK

The documentation says that signing.armored config is true by default but it is the opposite in v0.5.0
See https://jreleaser.org/guide/latest/configuration/signing.html#_mode

New GitHub repositories start with insufficient access rights for jreleaser release to GitHub releases command.

The error message does look like:

[INFO]  Releasing to https://github.com/ORG/REPO
[INFO]  Writing output properties to out/jreleaser/output.properties
Error:  JReleaser failed after 2.541 s
Unexpected error when creating release
jreleaser.shadow.org.kohsuke.github.HttpException: {"message":"Resource not accessible by integration","documentation_url":"https://docs.github.com/rest/releases/releases#create-a-release"}
Error: Process completed with exit code 1.

Or like this:

[INFO]  Releasing to https://github.com/ORG/REPO
[INFO]  Writing output properties to out/jreleaser/output.properties
Error:  JReleaser failed after 2.541 s
Unexpected error when creating release
jreleaser.shadow.org.kohsuke.github.HttpException: {"message":"Resource not accessible by integration","documentation_url":"https://docs.github.com/rest/reference/repos#delete-a-release"}
Error: Process completed with exit code 1.

Switching to "Read and write permissions" in "Settings - Actions - General" helps:

I found there is a jreleaser:auto-config-release maven task but could not find detailed documentation about what the "auto-config" means.

In the JReleaser CLI page release section, it describes:

There are two usage modes:
auto config
with explicit configuration file

Based on this description, I imagine "auto config release" automatically come up with configurations based on the current arrangement without explicit config files.
Just my guess :)

Would be nice to have more callouts about "Auto config release", so that users would not wonder about "auto config release" task in maven and gradle.

In addition, I typed "auto config" on the search box on the documentation, and the "Auto Config Release" search result jumps to this url - https://jreleaser.org/guide/latest/examples/auto-config-release.html - which gives Page Not Found.

While configuring JReleaser, I wanted to get a more detailed log to see what is really happening under the hood when something went wrong.

I found trace.log has the debug level logs almost at the end I configured the JReleaser to the project.

It would be nice to call out in the documentation that trace.log is available for debugging. So that, users would aware of how to debug release failures.

https://jreleaser.org/guide/latest/tools/jreleaser-maven.html#_jreleaserauto_config_release reports the type of tagName to be boolean instead of String.

In JLink examples page, it would be interesting to provide examples about passing args and so documenting (here for Maven) the tag.

This would help to understand that to add a new arg, you need this syntax:

...
</mainJar>
<args>
    <arg>--no-header-files</arg> <!-- default -->
    <arg>--no-man-pages</arg>  <!-- default -->
    <arg>--compress=2</arg>      <!-- default -->
    <arg>--strip-debug</arg>       <!-- default -->
    <arg>--ignore-signing-information</arg>
</args>
<jdk>
...

Thanks

Often times in the documentation, there are values set such as tagName: '{{distributionName}} {{tagName}}', which will result in an invalid git tag as they should not contain spaces.

When deploying to Maven with the instructions on the maven publish page, I got below error. Looks like document is missing one environment variable.

[ERROR] == JReleaser ==
[ERROR] nexus2.username must not be blank. Configure a value using the CLI yaml DSL, or define [JRELEASER_NEXUS2_MAVEN_CENTRAL_USERNAME, JRELEASER_NEXUS2_USERNAME] environment variables, or define a key/value pair in /Users/manik/.jreleaser/config.properties with keys = [JRELEASER_NEXUS2_MAVEN_CENTRAL_USERNAME, JRELEASER_NEXUS2_USERNAME]
JReleaser has not been properly configured.
nexus2.username must not be blank. Configure a value using the CLI yaml DSL, or define [JRELEASER_NEXUS2_MAVEN_CENTRAL_USERNAME, JRELEASER_NEXUS2_USERNAME] environment variables, or define a key/value pair in /Users/manik/.jreleaser/config.properties with keys = [JRELEASER_NEXUS2_MAVEN_CENTRAL_USERNAME, JRELEASER_NEXUS2_USERNAME]

Hi @aalmiray,

the title says it all 😄. Probably some copy-and-paste error. PR incoming.

Description
The given snapshot Sonatype URL is incorrect: https://s01.oss.sonatype.org/content/repositories/snapshot.

Solution
It must be: https://s01.oss.sonatype.org/content/repositories/snapshots/

In a multi module maven project, when JReleaser is configured on the parent pom, the child modules also run the release tasks.
I caught this behavior when the child module release task complained there is already the same version exists.
It may be ideal behavior in some cases, for example, when a project wants to perform release individually on each module, but I think in regular cases it wouldn't.

For my case, I just made the maven run ./mvnw jreleaser:full-release -pl . to limit the maven root only.
Another way I could think of is to create a child module dedicated to performing the release rather than defining it in the parent pom.

In the JReleaser documentation, I find a mention of maven multi module project only here.

The value of project.java.multiProject will be set to true if the current Maven session has more than 1 project.

I think having more documentation about maven multi module project would help understand the behavior, and users could properly configure JReleaser.

maven-central.adoc defines:

:deployer_url:  https://s01.oss.sonatype.org/service/local

However for Sonatype projects created before February 2021 should use https://oss.sonatype.org/service/local. Otherwise, JReleaser fails with following error -

[ERROR] JReleaser failed after 2.703 s
Unexpected error
Could not find a staging profile matching com.github.manikmagar

Root cause isn't very obvious from the error but it is due to the wrong URL being used (if followed the docs). Maybe adding a note there could help.

On the main site, I would expect that the titles would point me to somewhere.

e.g. Publish Packages --> https://jreleaser.org/guide/latest/integrations.html#_package_publish and so on.

From the new user entry perspective, IMO it would make sense to navigate the user to the respective sections in the docs or down to the highlights and relevant pieces somewhere else on the website.

Publishing to Maven Central example seems to use invalid host property instead of a url for all configuration formats except YAML:

As the Nexus2 page uses url consistently, this is most likely a bug.

Adding a github token for an automated release is non trivial:

It would be nice that this guide explains how to do that:
https://jreleaser.org/guide/latest/examples/maven/maven-central.html
to provide opinionated guidance for these dilemma's:

• In which menu in Github?
• Org or repository level?

@aalmiray how have you been, I hope this finds you well.

Could you be interested to have the code blocks with the CLI output in jreleaser-cli.adoc be generated?

My https://docs.enola.dev/use/execmd/ would allow you to do that!

Task List

• Steps to reproduce provided
• Stacktrace (if present) provided
• Example that reproduces the problem (link to git repository is ideal)
• Full description of the issue provided (see below)

Steps to Reproduce

1. Create a Java Maven project with this kind of JReleaser config, similar to the example config provided in the JReleaser reference:

                        <packagers>
                            <brew>
                                <active>ALWAYS</active>
                                <tap>
                                    <name>homebrew-tap</name>
                                </tap>
                                <dependencies>
                                    <dependency>
                                        <key>key2</key>
                                        <value>value2</value>
                                    </dependency>
                                </dependencies>
                            </brew>
                        </packagers>

3. Run jreleaser:package and check the contents of the brew formula .rb in target/jreleaser/package.

Expected Behaviour

Formula should contain

depends_on "key2" => "value2"

as documented in https://jreleaser.org/guide/latest/reference/packagers/homebrew.html#_configuration

Actual Behaviour

Formula contains

  depends_on "dependency"

I haven't had the time to check if this problem is mirrored in other configuration formats and/or packagers.

Environment Information

• Operating System: MacOS Ventura
• JReleaser Version: 1.5.1
• JDK Version: OpenJDK 17.0.6 (Homebrew build)

When searching e.g. for "token" in the "Search docs" input field on https://jreleaser.org/guide/, I'm getting "Page not found" errors.

https://gitlab.com/antora/antora-ui-default/-/issues/44#note_579313948

While reading the jreleaser documentation, I've found two typos / copy-paste errors:

• https://jreleaser.org/guide/latest/artifacts.html

linux-x8w6_64 instead of linux-x86_64

• https://jreleaser.org/guide/latest/configuration/packagers/scoop.html

Only artifacts with .zip, .jar extension may be packaged with Homebrew. instead of Only artifacts with .zip, .jar extension may be packaged with Scoop.

In the Antora website, the Edit this page link is pointing to the main branch whereas you require the PRs to target development.

For instance here: https://jreleaser.org/guide/latest/configuration/release/github.html .

Not sure it's fixable though :).

I was wondering why my changelog for v1.0.1 release didn't get all the change history.

Based on the log, I found it didn't find the tag for the previous version.

[INFO]  Generating changelog
[DEBUG] resolving commits
[WARN]  Generating a changelog from a shallow copy may cause a failure
[DEBUG] looking for tag that matches 'v1.0.1'
[DEBUG] looking for tags that match 'v.*', excluding 'v1.0.1'
[DEBUG] sorting commits null
[INFO]  Storing changelog: target/jreleaser/release/CHANGELOG.md

I found this documentation in "GitHub Actions"

Note the fetch-depth: 0 option on the Checkout workflow step. It is required for JReleaser to work properly. Without that, JReleaser might fail or behave incorrectly.

I remember I read this before but didn't connect the dots since I am not using jreleaser/release-action@v2 but a custom workflow.

I think the same mention about git fetch-depth: 0 in the Changelog and/or FAQ would beneficial for users.

I wanted to send a PR for adding info about the new GH PATs (see https://github.blog/2022-10-18-introducing-fine-grained-personal-access-tokens-for-github/), but I couldn't find the token.adoc file which seems to contain those contents? Happy to send a PR if you can point me into the right direction, @aalmiray.

The line "Requires Java 8" is mentioned everywhere when mentioning Jbang but, although that's technically true, for the user that's practically speaking not an issue because Jbang will automatically download and install any necessary JDKs.

Can provide PR if you agree :-)