Skip to content

docs(sdks): document FERN_JAVA_SKIP_FORMATTING for the Java generator - #6622

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1786640954-java-skip-formatting
Open

docs(sdks): document FERN_JAVA_SKIP_FORMATTING for the Java generator#6622
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1786640954-java-skip-formatting

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

The Java SDK generator normally runs a Gradle/Spotless formatting pass after it writes the generated code. That pass needs to reach services.gradle.org and plugins.gradle.org, so Java SDK generation failed outright on locked-down corporate networks even though the generated code is valid without formatting. Java SDK generator 4.18.0 adds FERN_JAVA_SKIP_FORMATTING, an environment variable that skips the pass entirely: generation succeeds on restricted networks and runs faster, with the tradeoff that output is unformatted until ./gradlew spotlessApply is run in the SDK repo.

Implements docs for: feat(java): add FERN_JAVA_SKIP_FORMATTING env var to skip Spotless (fern-api/fern#17367)

Pages changed

  • fern/products/sdks/generators/java/configuration.mdx — new ## Skip code formatting section at the end of the page (deliberately outside the <ParamField> list, since this is an environment variable and not a generators.yml key): why the formatting pass needs network egress, the accepted truthy values (1, true, yes, on, any casing), a FERN_JAVA_SKIP_FORMATTING=true fern generate --group java-sdk example, CLI forwarding into the generator container / docker run -e, the 4.18.0 minimum, and that output is unformatted until ./gradlew spotlessApply runs.
  • fern/products/sdks/deep-dives/self-hosted.mdx — one-line cross-reference where the page claims org verification and the image pull are the only network calls; the Java generator's Gradle hosts are the exception, linked to the new section.

No changelog entry: SDK changelogs are handled separately and the generator entry already exists at fern/products/sdks/generators/java/changelog/2026-08-11.mdx.

Validation: pre-commit run --files <changed> (Vale: 0 errors/warnings, only pre-existing suggestions on untouched lines) and fern check --warnings (0 errors; 6 pre-existing warnings).

Link to Devin session: https://app.devin.ai/sessions/81e55c4457e843e1b83accc97053386f

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants