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

Specified that Maven must run with Java 8 in docs #8706

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Annaseli
Copy link
Contributor

Closes #8581

Change Description

Background

When running make test with Maven using Java version greater than 8, the following error occurs:

[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.770 s
[INFO] Finished at: 2025-01-28T17:43:16+02:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.1:testCompile (default-testCompile) on project hadoop-lakefs: Compilation failure: Compilation failure: 
[ERROR] /Users/annaseliverstov/work/lakeFS/clients/hadoopfs/src/test/java/io/lakefs/FSTestBase.java:[320,57] cannot find symbol
[ERROR]   symbol:   class ImmutablePagination
[ERROR]   location: class io.lakefs.FSTestBase
[ERROR] /Users/annaseliverstov/work/lakeFS/clients/hadoopfs/src/test/java/io/lakefs/FSTestBase.java:[324,68] cannot find symbol
[ERROR]   symbol:   class ImmutablePagination
[ERROR]   location: class io.lakefs.FSTestBase

Fix And Updating Documentation

The failure happens in the hadoopfs client tests. However, when using Java 8, the tests pass successfully.

I updated the Contributing to lakeFS documentation and the clients/hadoopfs README by adding a building and testing section, specifying that Maven should be used with Java 8.

Testing Details

I tested the appearance of the new document using Jekyll in Docker.

@Annaseli Annaseli added docs Improvements or additions to documentation include-changelog PR description should be included in next release changelog labels Feb 24, 2025
@Annaseli Annaseli requested a review from nopcoder February 24, 2025 09:29
Copy link

github-actions bot commented Feb 24, 2025

🎊 PR Preview 21016a3 has been successfully built and deployed to https://treeverse-lakeFS-preview-pr-8706.surge.sh

🕐 Build time: 0.01s

🤖 By surge-preview

Copy link

E2E Test Results - Quickstart

11 passed

Copy link

E2E Test Results - DynamoDB Local - Local Block Adapter

14 passed

Comment on lines 10 to 16
## Building

Maven must be run with Java 8.

## Testing

Maven tests must be run with Java 8.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest to merge the two and write that the project using Maven, with a prerequisite of having Java 8 installed.

1. Java 8
* Apple M1 users can install this from [Azul Zulu Builds for Java JDK](https://www.azul.com/downloads/?package=jdk). Builds for Intel-based Macs are available from [java.com](https://www.java.com/en/download/help/mac_install.html).
1. [Maven](https://maven.apache.org/) with Java 8
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Java 8 is already required at line 42.
Also Maven was specified - but just limited to the spark client - which we need to update.

Copy link
Contributor Author

@Annaseli Annaseli Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nopcoder
So, do you mean I should write:

"Maven - required for building and testing Spark client code, as well as the hadoopfs client."

instead of my original version:

"Maven with Java 8

  • Java 8 is required for building and testing the hadoopfs client.
    "

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation include-changelog PR description should be included in next release changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Documentation to Specify Java 8 for Maven Builds
2 participants