Skip to content

Commit 19e6787

Browse files
authored
#11577 Doc build fixed for node 22. Build strategy (#11611)
* #11577 Doc build fixed for node 22. Build strategy * Updated java versions * Apply suggestion from @offtherailz * Apply suggestion from @offtherailz * Fix requirements table * Apply suggestion from @offtherailz * Apply suggestion from @offtherailz * Apply suggestion from @offtherailz * Apply suggestion from @offtherailz * Apply suggestion from @offtherailz * Apply suggestion from @offtherailz * Apply suggestion from @offtherailz
1 parent f5928b8 commit 19e6787

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

docs/developer-guide/requirements.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,27 @@ You can download a java web container like *Apache Tomcat* from and *Java JRE*
88

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

1414
## Debug / Build
1515

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

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

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

2929
- <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.
30-
- <sup>2</sup> About Java and Tomcat maximum versions:
31-
- For execution, MapStore is well tested on Java v11.
32-
- 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))
33-
- Running with Tomcat 10 causes this issue [#7524](https://github.com/geosolutions-it/MapStore2/issues/7524).
34-
- <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).
30+
- <sup>2</sup> Running with Tomcat 10 causes this issue [#7524](https://github.com/geosolutions-it/MapStore2/issues/7524).
31+
- <sup>3</sup> Latest version tested.
3532
- <sup>4</sup> Python is only needed for building documentation.
3633

3734
## Running in Production

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -280,9 +280,9 @@
280280
"doc": "npm run jsdoc:build",
281281
"cleandoc": "npm run jsdoc:clean",
282282
"doctest": "npm run jsdoc:test",
283-
"jsdoc:build": "npm run jsdoc:check && docma -c build/docma-config.json --dest web/docs",
283+
"jsdoc:build": "NODE_OPTIONS=\"--no-deprecation\" npm run jsdoc:check && docma -c build/docma-config.json --dest web/docs",
284284
"jsdoc:clean": "premove web/docs && premove web/client/mapstore/docs",
285-
"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",
285+
"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",
286286
"jsdoc:check": "node ./utility/doc/jsDocConfigCheck.js",
287287
"jsdoc:update": "node ./utility/doc/jsDocConfigUpdate.js",
288288
"doc:build": "mkdocs build",

0 commit comments

Comments
 (0)