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

Add packaging example for Picocli documentation #25116

Merged
merged 2 commits into from
Oct 23, 2024

Conversation

newur
Copy link
Contributor

@newur newur commented Apr 23, 2022

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.

Copy link
Member

@gsmet gsmet left a 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 Show resolved Hide resolved
docs/src/main/asciidoc/picocli.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/picocli.adoc Outdated Show resolved Hide resolved
docs/src/main/asciidoc/picocli.adoc Outdated Show resolved Hide resolved
}
----

== Command line application with multiple Commands
=== Packaging
Copy link
Member

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.

Copy link
Contributor Author

@newur newur Apr 25, 2022

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.

@newur newur requested a review from gsmet April 26, 2022 11:05
@newur
Copy link
Contributor Author

newur commented May 20, 2022

What do we need to do, to get some progress here?

@gsmet gsmet added the triage/needs-rebase This PR needs to be rebased first because it has merge conflicts label Feb 4, 2023
@gsmet gsmet force-pushed the picocli-documentation-packaging-example branch 2 times, most recently from 4b98229 to c685d50 Compare October 22, 2024 15:40
Copy link
Member

@gsmet gsmet left a 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.

@gsmet gsmet added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Oct 22, 2024

This comment has been minimized.

@gsmet gsmet force-pushed the picocli-documentation-packaging-example branch from c685d50 to 07f3026 Compare October 22, 2024 16:37
@gsmet
Copy link
Member

gsmet commented Oct 22, 2024

Rebased to get a CI fix.

Copy link

github-actions bot commented Oct 22, 2024

🙈 The PR is closed and the preview is expired.

Copy link

quarkus-bot bot commented Oct 22, 2024

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 07f3026.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

@gsmet gsmet merged commit e7b7be3 into quarkusio:main Oct 23, 2024
5 checks passed
@quarkus-bot quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Oct 23, 2024
@quarkus-bot quarkus-bot bot added this to the 3.17 - main milestone Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation triage/needs-rebase This PR needs to be rebased first because it has merge conflicts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants