MonkeyCanCode opened a new pull request, #2961:
URL: https://github.com/apache/polaris/pull/2961
<!--
Possible security vulnerabilities: STOP here and contact
[email protected] instead!
Please update the title of the PR with a meaningful message - do not
leave it "empty" or "generated"
Please update this summary field:
The summary should cover these topics, if applicable:
* the motivation for the change
* a description of the status quo, for example the current behavior
* the desired behavior
* etc
PR checklist:
- Do a self-review of your code before opening a pull request
- Make sure that there's good test coverage for the changes included in
this PR
- Run tests locally before pushing a PR (./gradlew check)
- Code should have comments where applicable. Particularly
hard-to-understand
areas deserve good in-line documentation.
- Include changes and enhancements to the documentation (in
site/content/in-dev/unreleased)
- For Work In Progress Pull Requests, please use the Draft PR feature.
Make sure to add the information BELOW this comment.
Everything in this comment will NOT be added to the PR description.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section
is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster
reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class
hierarchy will help reviewers.
2. If you fix some IRC features, you can provide some references of other
IRC implementations / IRC spec.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
Polaris admin tool was default to show a brief msg which then ask user to
use argument `help` to get more info (which is a kinds no-ops and force user to
rerun the command with additional arguments in order to learn more) such as
following:
```
$ java -jar runtime/admin/build/quarkus-app/quarkus-run.jar
Polaris administration & maintenance tool.
Use the 'help' command.
```
With the change from this PR, I am purposing we should default to `help`
along with original tool message line such as following:
```
$ java -jar runtime/admin/build/quarkus-app/quarkus-run.jar
Polaris administration & maintenance tool.
Usage: polaris-admin-tool.jar [-hV] [COMMAND]
Polaris Admin Tool
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
Commands:
help Display help information about the specified command.
bootstrap Bootstraps realms and root principal credentials.
purge Purge realms and all associated entities.
```
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as
new features, bug fixes, or other behavior changes. Documentation-only updates
are not considered user-facing changes.
If yes, please clarify the previous behavior and the change this PR proposes
- provide the console output, description and/or an example to show the
behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to
the released Polaris versions or within the unreleased branches such as master.
If no, write 'No'.
-->
IMO, this is provide better user experience and it doesn't make much sense
to ask user to type same command and an extra `help` argument to learn more
about the tool.
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some
test cases that check the changes thoroughly including negative and positive
cases if possible.
If it was tested in a way different from regular unit tests, please clarify
how you tested step by step, ideally copy and paste-able, so that other
reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why
it was difficult to add.
-->
N/A
### CHANGELOG.md
<!--
If the changes need to be included in CHANGELOG.md, please add a line here
and in CHANGELOG.md.
-->
N/A
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
