Skip to content

README needs clarifications #481

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

Open
mernst opened this issue Apr 7, 2023 · 3 comments
Open

README needs clarifications #481

mernst opened this issue Apr 7, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mernst
Copy link

mernst commented Apr 7, 2023

In the README file, https://github.com/actions/setup-java#v2-vs-v1 discusses V1 vs V2. It would be good to also mention v3, which is used later in the README. It also might be good to move that section later in the README.

The section on Supported version syntax suggests that only 8, 11, 16, and 17 are permitted. If those are examples rather than an exhaustive list, please state that explicitly.

Thanks.

@mernst mernst added bug Something isn't working needs triage labels Apr 7, 2023
@dmitry-shibanov
Copy link
Contributor

Hello @mernst. Thank you for your report. I'm not sure that it is necessary because the only breaking change from v2 to v3 was switching node12 to node16.

@mernst
Copy link
Author

mernst commented Apr 10, 2023

I think the current wording is fine for someone who is already familiar with the setup-java action (like you! and like me, now). However, the README is especially useful for someone who doesn't already know the details: someone who needs to be taught how setup-java works rather than merely reminded of it.

Regarding my first suggestion: The beginning of the README suggests that the only two versions that exist are V1 and V2. I found this confusing (I went to use V2, which immediately failed because I needed V3). I think it would be helpful (and not overly verbose or distracting) to mention that V3 also exists.

Similarly for my second suggestion, about supported version syntax.

@dmitry-shibanov
Copy link
Contributor

Thank you for your suggestion @mernst. We'll take a look on it.

@dmitry-shibanov dmitry-shibanov self-assigned this Apr 11, 2023
@IvanZosimov IvanZosimov added feature request New feature or request to improve the current logic documentation Improvements or additions to documentation and removed bug Something isn't working feature request New feature or request to improve the current logic labels Jul 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants