Skip to content

#11577 Doc build fixed for node 22. Build strategy #11611

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

Merged
merged 13 commits into from
Oct 31, 2025
Merged

#11577 Doc build fixed for node 22. Build strategy #11611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
03aab47
#11577 Doc build fixed for node 22. Build strategy
offtherailz Oct 20, 2025
40e903a
Updated java versions
offtherailz Oct 20, 2025
e4b50ba
Apply suggestion from @offtherailz
offtherailz Oct 20, 2025
219c07d
Apply suggestion from @offtherailz
offtherailz Oct 20, 2025
1cc8bcb
Fix requirements table
offtherailz Oct 20, 2025
f1decf2
Merge branch 'node_22' of github.com:offtherailz/MapStore2 into node_22
offtherailz Oct 20, 2025
bff3541
Apply suggestion from @offtherailz
offtherailz Oct 31, 2025
3f92cca
Apply suggestion from @offtherailz
offtherailz Oct 31, 2025
1b98b96
Apply suggestion from @offtherailz
offtherailz Oct 31, 2025
c05b5fc
Apply suggestion from @offtherailz
offtherailz Oct 31, 2025
117fe30
Apply suggestion from @offtherailz
offtherailz Oct 31, 2025
440369b
Apply suggestion from @offtherailz
offtherailz Oct 31, 2025
1b2ac44
Apply suggestion from @offtherailz
offtherailz Oct 31, 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
23 changes: 10 additions & 13 deletions docs/developer-guide/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,27 @@ You can download a java web container like *Apache Tomcat* from and *Java JRE*

| Tool | Link | Minimum | Recommended | Maximum |
|--------|----------------------------------------------------|---------|-------------|---------------|
| Java | [link](https://www.java.com/it/download/) | 8<sup>1</sup> | 11 | 11<sup>2</sup> |
| Java | [link](https://www.java.com/it/download/) | 8<sup>1</sup> | 11 | 17<sup>2</sup> |
| Tomcat | [link](https://tomcat.apache.org/download-80.cgi) | 8.5 | 9 | 9<sup>2</sup> |

## Debug / Build

These tools needs to be installed (other than **Java** in versions above above):

| Tool | Link | Minimum | Recommended | Maximum |
|-----------------------|------------------------------------------------------------|---------|-------------|---------------------|
| npm | [link](https://www.npmjs.com/get-npm) | 8 | 10 | |
| NodeJS | [link](https://nodejs.org/en/) | 20 | 20 | 20<sup>3</sup> |
| Java (JDK) | [link](https://www.java.com/en/download/help/develop.html) | 8 | 9 | 11<sup>2</sup> |
| Maven | [link](https://maven.apache.org/download.cgi) | 3.1.0 | 3.6 | |
| python<sup>4</sup> | [link](https://www.python.org/downloads/) | 2.7.9 | 3.7 | |
| Tool | Link | Minimum | Recommended | Maximum |
|-----------------------|------------------------------------------------------------|---------|-------------|-----------------|
| npm | [link](https://www.npmjs.com/get-npm) | 8 | 10 | |
| NodeJS | [link](https://nodejs.org/en/) | 20 | 20 | 25<sup>3</sup> |
| Java (JDK) | [link](https://www.java.com/en/download/help/develop.html) | 8 | 11 | 17 |
| Maven | [link](https://maven.apache.org/download.cgi) | 3.1.0 | 3.6 | |
| python<sup>4</sup> | [link](https://www.python.org/downloads/) | 2.7.9 | 3.7 | |

!!! notes
Here some notes about some requirements and reasons for max version indicated, for future improvements and maintenance :

- <sup>1</sup> Java 8 is the minimum version required for running MapStore, but it is not compatible in case you want to use the print module. In this case, you need to use Java 11.
- <sup>2</sup> About Java and Tomcat maximum versions:
- For execution, MapStore is well tested on Java v11.
- Build with success with v11, only smoke tests passing on v13, errors with v16.(Details on issue [#6935](https://github.com/geosolutions-it/MapStore2/issues/6935))
- Running with Tomcat 10 causes this issue [#7524](https://github.com/geosolutions-it/MapStore2/issues/7524).
- <sup>3</sup> See issue [#11577](https://github.com/geosolutions-it/MapStore2/issues/11577) for details about this limit (for now only for documentation build).
- <sup>2</sup> Running with Tomcat 10 causes this issue [#7524](https://github.com/geosolutions-it/MapStore2/issues/7524).
- <sup>3</sup> Latest version tested.
- <sup>4</sup> Python is only needed for building documentation.

## Running in Production
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,9 +284,9 @@
"doc": "npm run jsdoc:build",
"cleandoc": "npm run jsdoc:clean",
"doctest": "npm run jsdoc:test",
"jsdoc:build": "npm run jsdoc:check && docma -c build/docma-config.json --dest web/docs",
"jsdoc:build": "NODE_OPTIONS=\"--no-deprecation\" npm run jsdoc:check && docma -c build/docma-config.json --dest web/docs",
"jsdoc:clean": "premove web/docs && premove web/client/mapstore/docs",
"jsdoc:test": "docma -c build/docma-config.json --dest web/client/mapstore/docs && echo documentation is accessible from the mapstore/docs path when running npm start",
"jsdoc:test": "NODE_OPTIONS=\"--no-deprecation\" docma -c build/docma-config.json --dest web/client/mapstore/docs && echo documentation is accessible from the mapstore/docs path when running npm start",
"jsdoc:check": "node ./utility/doc/jsDocConfigCheck.js",
"jsdoc:update": "node ./utility/doc/jsDocConfigUpdate.js",
"doc:build": "mkdocs build",
Expand Down