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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Feb 26, 2025
+7 −1
Merged

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a021799
Specified that Maven must run with Java 8 in docs.
Annaseli Feb 24, 2025
b3086b9
Updated the README in clients/hadoopfs regarding building and testing
Annaseli Feb 24, 2025
21016a3
Updated the README in clients/hadoopfs regarding building and testing
Annaseli Feb 24, 2025
910d579
Fixed the maven description in the dicumentation
Annaseli Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions clients/hadoopfs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,11 @@ It uses the lakeFS server for metadata operations only.
## Publishing

Follow the [HadoopFS release checklist](https://github.com/treeverse/dev/blob/main/pages/lakefs-clients-release.md#lakefs-hadoop-filesystem)

## 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.

3 changes: 2 additions & 1 deletion docs/project/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,10 @@ Our [Go release workflow](https://github.com/treeverse/lakeFS/blob/master/.githu
1. [Docker](https://docs.docker.com/get-docker/)
1. [Go](https://golang.org/doc/install)
1. [Node.js & npm](https://www.npmjs.com/get-npm)
1. [Maven](https://maven.apache.org/) to build and test Spark client codes.
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 •
edited
Loading

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.
    "

Copy link
Contributor

Choose a reason for hiding this comment

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

yes, just add the fact that hadoopfs project to the list that uses it.

* Java 8 is required for building and testing the hadoopfs client.
1. *Optional* - [PostgreSQL 11](https://www.postgresql.org/docs/11/tutorial-install.html) (useful for running and debugging locally)
1. *Optional* - [Rust & Cargo](https://www.rust-lang.org/tools/install) (useful for building the Rust SDK)
1. *Optional* - [Buf CLI](https://buf.build/docs/installation) (only needed if you like to update Protocol Buffer files)
Expand Down
Loading