You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[787] Add maven wrapper for consistent builds (#788)
* add a maven wrapper for consistent builds
* update readme and docs to prefer mvnw for consistent builds
* update more mvn usage
* update deploy_staging_jars
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,23 +33,23 @@ future.
33
33
34
34
# Building the project and running tests.
35
35
1. Use Java 11 for building the project. If you are using another Java version, you can use [jenv](https://github.com/jenv/jenv) to use multiple Java versions locally.
36
-
2. Build the project using `mvn clean package`. Use `mvn clean package -DskipTests` to skip tests while building.
37
-
3. Use `mvn clean test` or `mvn test` to run all unit tests. If you need to run only a specific test you can do this
38
-
by something like `mvn test -Dtest=TestDeltaSync -pl xtable-core`.
39
-
4. Similarly, use `mvn clean verify` or `mvn verify` to run integration tests.
36
+
2. Build the project using `./mvnw clean package`. Use `./mvnw clean package -DskipTests` to skip tests while building.
37
+
3. Use `./mvnw clean test` or `./mvnw test` to run all unit tests. If you need to run only a specific test you can do this
38
+
by something like `./mvnw test -Dtest=TestDeltaSync -pl xtable-core`.
39
+
4. Similarly, use `./mvnw clean verify` or `./mvnw verify` to run integration tests.
40
40
41
41
**Note:** When using Maven version 3.9 or above, Maven automatically caches the build. To ignore build caching, you can
42
-
add the `-Dmaven.build.cache.enabled=false` parameter. For example, `mvn clean package -DskipTests -Dmaven.build.cache.enabled=false`
42
+
add the `-Dmaven.build.cache.enabled=false` parameter. For example, `./mvnw clean package -DskipTests -Dmaven.build.cache.enabled=false`
43
43
44
44
45
45
# Style guide
46
46
1. We use [Maven Spotless plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) and
47
47
[Google java format](https://github.com/google/google-java-format) for code style.
48
-
2. Use `mvn spotless:check` to find out code style violations and `mvn spotless:apply` to fix them.
48
+
2. Use `./mvnw spotless:check` to find out code style violations and `./mvnw spotless:apply` to fix them.
49
49
Code style check is tied to compile phase by default, so code style violations will lead to build failures.
50
50
51
51
# Running the bundled jar
52
-
1. Get a pre-built bundled jar or create the jar with `mvn install -DskipTests`
52
+
1. Get a pre-built bundled jar or create the jar with `./mvnw install -DskipTests`
53
53
2. Create a yaml file that follows the format below:
0 commit comments