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

Update User Guide Java Version #1635

Closed
zhoukerrr opened this issue Jan 29, 2022 · 6 comments
Closed

Update User Guide Java Version #1635

zhoukerrr opened this issue Jan 29, 2022 · 6 comments
Assignees
Labels

Comments

@zhoukerrr
Copy link
Contributor

What problem(s) did you run into that caused you to request additional documentation? What, if any, existing documentation relates to this proposal?

The User Guide states Java 8 or later. However, I was unable to run RepoSense on Java 17.

What would you like added or modified in the documentation?

Update the User Guide to show the compatible Java versions accurately.

@zhoukerrr zhoukerrr self-assigned this Jan 29, 2022
@dcshzj
Copy link
Member

dcshzj commented Feb 7, 2022

Are we able to make RepoSense work on Java 17?

@zhoukerrr
Copy link
Contributor Author

@dcshzj I believe the reason why it did not work on Java 17 now is because we are currently using Gradle 5.2.1. According to the Gradle User Manual, the first Gradle version that supports Java 17 is 7.3. I think we will have to upgrade our Gradle version first. Maybe we can consider opening an issue regarding this?

@gerhean
Copy link
Contributor

gerhean commented Feb 7, 2022

Does the new Gradle work with our currently supported Java versions?

@zhoukerrr
Copy link
Contributor Author

@gerhean I think it does. You can find the list of Java versions Enum JavaVersion and support since which Gradle version.

@yhtMinceraft1010X
Copy link
Contributor

yhtMinceraft1010X commented Mar 1, 2022

I think this issue concerns the developer guide rather than the user guide. I tested the RepoSense.jar for both the release version and the master branch (compiled using Java 8) with Java 17 runtime. The RepoSense.jar still works.

Screenshot (132)
Above is the command prompt showing that both versions of RepoSense.jar still work on Java 17 runtime (The master branch version was built using gradlew shadowJar on Java 8).

Screenshot (130)
Above is a report for one of the versions of RepoSense.jar. The other version also works fine.

So the User Guide is still correct in saying that Java 8 or later works since the user is downloading a pre-compiled Java 8 jar file, which can still run on Java 17 runtime (provided that deprecated methods/variables etc are not used in the source code).

It is true that Gradle 5.2.1 does not work with Java 17. In this case, the developer guide's Setting up page should be changed instead.

@yhtMinceraft1010X
Copy link
Contributor

Closing this issue for the following reasons:

  • The User Guide assumes that the user downloads RepoSense.jar (which is created in Gradle 6.9.2 with Java 8). This jar file can still run on Java 17.
  • The Developer Guide has been updated to exclude Java 17 from settingUp.md in Upgrade Gradle to 6.9.2 #1664 since Gradle 6.9.2 is not compatible with Java 17.

If we can upgrade to Gradle 7.4.1 (released 9 March 2022), we can revert the DG update since Java 17 would be compatible with it.

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

No branches or pull requests

4 participants