-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
Add packaging example for Picocli documentation #25116
Add packaging example for Picocli documentation #25116
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your work on this. I added a couple of comments on the form.
docs/src/main/asciidoc/picocli.adoc
Outdated
} | ||
---- | ||
|
||
== Command line application with multiple Commands | ||
=== Packaging |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I would put this section here. It is very specific. I would rather keep the existing structure and add a Packaging hints
paragraph later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to disagree on this one. So far the article has basically not much structure, since all headlines are on the same level. I want to make it more similar to the other guides and provide a structure with a basic example that covers the happy path or 80% case or whatever one might wanna call it. Afterwards, more advanced solutions are outlined.
Having 3 different ways to implement the entry points, is not something a first time reader can/wants to deal with IMHO. On the other hand, how to get this code running from the command line, is something the reader most likely is interested in.
What do we need to do, to get some progress here? |
4b98229
to
c685d50
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I made some further adjustments. Let's wait for CI and merge.
This comment has been minimized.
This comment has been minimized.
c685d50
to
07f3026
Compare
Rebased to get a CI fix. |
🙈 The PR is closed and the preview is expired. |
Status for workflow
|
I was initially a bit lost how to turn the example into something actually runnable on the cmd. The native executable works fine, but might not be suitable in all cases. So I added an example with an uber-jar and combined it with a maven plugin as described in the official Picocli docu.