Repository navigation
docs: align contributor toolchain versions and URL image default in migration guide - #1337
Merged
GOODBOY008 merged 2 commits intoNov 12, 2026
Merged
Conversation
…igration guide The English and zh-cn contribution guides disagreed on the Maven and JDK requirements and neither matched the build. State the real requirements: JDK 8+ (CI matrix 8/11/17/21/25), JDK 17+ recommended and needed for Spotless, and the Maven Wrapper pinned to 3.6.3. The FastExcel migration guide still said URL images allow any public http/https address by default. Since 2.1.0-incubating, remote fetching is disabled until an exact-host allowlist is configured; update the English and zh-cn guides to match UrlImageConverter.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of the pull request
Fix two documentation inconsistencies on the website so the guides match the build and the code.
What's changed?
Contribution guide (en + zh-cn): toolchain versions
The English guide required Maven 3.9+ / JDK 17+, while the zh-cn guide required Maven 3.8.1+ / JDK 17+ and recommended Maven 3.9.0+ / JDK 21+. Neither matched the project:
pom.xmlhas no enforcer rule for Maven or Java versions..mvn/wrapper/maven-wrapper.propertiespins Maven 3.6.3.spotless:checkruns on JDK 25 (spotless-maven-plugin 3.x needs JDK 17+).Both languages now say: JDK 8+ to build and test, JDK 17+ recommended locally and required for Spotless, use
./mvnw(Maven 3.6.3), or a local Maven 3.6.3+. Java 1.8 language level is still required.FastExcel migration guide (en + zh-cn): URL image default
The guide said only
http/httpsand public addresses are allowed by default. Since 2.1.0-incubating,UrlImageFetchPolicydefaults to an emptyallowedHosts, andUrlImageConverterthen throwsIOException("Remote URL image fetching is disabled"). The guide now states that remote fetching is disabled by default and needs an explicit exact-host allowlist viaUrlImageConverter.setFetchPolicy(...), that FastExcel code writingURLimage fields will fail until it is configured, and links to the image docs' "URL Sources" section and the Security Model. This matchescommunity/security-model.md.Verified with
npx docusaurus build(en and zh-cn); the new anchor links resolve.Checklist