Skip to content

Commit 8b5ee36

Browse files
authored
Update CONTRIBUTING.md with Windows SDKMan note
Added note about potential file path error on Windows during javadoc step. Signed-off-by: Jon Bartels <jonathan.bartels@gmail.com>
1 parent 3944b31 commit 8b5ee36

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The build is driven by Gradle through the included wrapper; no separate Gradle i
3636
./gradlew test # run the unit tests (-Dcoverage=true for JaCoCo)
3737
./gradlew dist # build the distribution extension zips
3838
```
39-
On Windows use `gradlew.bat` instead of `./gradlew`. The assembled distribution lands in `server/setup`, the same location the previous Ant build used. For release artifacts, run a clean build: `./gradlew clean build dist`.
39+
On Windows use `gradlew.bat` instead of `./gradlew`. The assembled distribution lands in `server/setup`, the same location the previous Ant build used. For release artifacts, run a clean build: `./gradlew clean build dist`. Windows with SDKMan may generate an error about the file path being too long in the javadoc step, skip this by adding `-x :server:userApiJavadoc` to your Gradle command.
4040

4141
Dependencies are pinned and checksum-verified. To change a dependency version: edit `gradle/libs.versions.toml`, then refresh the checksum metadata **with a cold dependency cache and CI's flags**:
4242
```bash

0 commit comments

Comments
 (0)