Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document more about "AutoConfig Release" #45

Open
ttddyy opened this issue Jan 9, 2023 · 2 comments
Open

Document more about "AutoConfig Release" #45

ttddyy opened this issue Jan 9, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@ttddyy
Copy link

ttddyy commented Jan 9, 2023

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.

image

@ttddyy ttddyy added the enhancement New feature or request label Jan 9, 2023
@aalmiray aalmiray transferred this issue from jreleaser/jreleaser Jan 9, 2023
@aalmiray
Copy link
Member

aalmiray commented Jan 9, 2023

FWIW auto-config releases only work with the release step. At the moment deploy targets will be skipped as there's no way to define all required arguments.

@aalmiray
Copy link
Member

aalmiray commented Jan 9, 2023

re: 404. The actual link is https://jreleaser.org/guide/latest/examples/miscellaneous/auto-config-release.html and can be found by navigating to the examples page. It may be the case that the search index needs rebuilding. Will look it up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants