You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by dd...@apache.org on 2020/07/19 21:30:35 UTC
[freemarker-docgen] 02/02: POM improvements continues (hoping
release won't fail).
This is an automated email from the ASF dual-hosted git repository.
ddekany pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git
commit 395160a66e34a5212174f3a25b25db7b60ff8df9
Author: ddekany <dd...@apache.org>
AuthorDate: Sun Jul 19 23:29:59 2020 +0200
POM improvements continues (hoping release won't fail).
---
README.md | 15 +++++----------
freemarker-docgen-ant/pom.xml | 3 ++-
freemarker-docgen-cli/pom.xml | 3 ++-
freemarker-docgen-core/pom.xml | 39 +++++++++++++++++++++++++++++++++++++--
pom.xml | 33 +++++++++++++++++----------------
5 files changed, 63 insertions(+), 30 deletions(-)
diff --git a/README.md b/README.md
index f611b42..0a43389 100644
--- a/README.md
+++ b/README.md
@@ -27,21 +27,16 @@ with the `xxe-addon` installed, that you can find in this project.
These tools must be installed:
* JDK 8, tested with Oracle 1.8.0_212
* Apache Maven, tested with 3.6.1
-* [Node.js](https://nodejs.org/), tested with 12.18.2.
+* [Node.js](https://nodejs.org/), tested with 12.18.2, 14.x.x maybe won't work.
(Node.js is only used to generate static content while building Docgen itself.)
-Run these to build:
-
-1. In the `freemarker-docgen-core` directory (*not* in the top directory) issue:
-
- ```npm install```
-
- This is to get our JavaScript dependencies, based on `package.json`.
-
-2. In the project *top* directory (`freemarker-docgen`) issue:
+To build, ensure that `npm` (from Node.js) is in the path, then in the top project directory
+(`freemarker-docgen`) issue this:
```mvn install```
+
+
### Node.js troubleshooting
Possible node.js related problems and solutions:
diff --git a/freemarker-docgen-ant/pom.xml b/freemarker-docgen-ant/pom.xml
index 4c16608..7c8668c 100644
--- a/freemarker-docgen-ant/pom.xml
+++ b/freemarker-docgen-ant/pom.xml
@@ -15,7 +15,8 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
diff --git a/freemarker-docgen-cli/pom.xml b/freemarker-docgen-cli/pom.xml
index f50e433..72e3267 100644
--- a/freemarker-docgen-cli/pom.xml
+++ b/freemarker-docgen-cli/pom.xml
@@ -15,7 +15,8 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
diff --git a/freemarker-docgen-core/pom.xml b/freemarker-docgen-core/pom.xml
index 0af2e7f..76713fe 100644
--- a/freemarker-docgen-core/pom.xml
+++ b/freemarker-docgen-core/pom.xml
@@ -15,7 +15,8 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
@@ -118,7 +119,6 @@
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
- <version>3.0.0</version>
<executions>
<execution>
<id>gulp</id>
@@ -138,4 +138,39 @@
</plugin>
</plugins>
</build>
+
+ <profiles>
+ <profile>
+ <id>npm-install-needed</id>
+ <activation>
+ <file>
+ <missing>node_modules</missing>
+ </file>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>exec-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>npm-install</id>
+ <goals>
+ <goal>exec</goal>
+ </goals>
+ <phase>initialize</phase>
+ <configuration>
+ <executable>npm</executable>
+ <arguments>
+ <argument>install</argument>
+ </arguments>
+ <useMavenLogger>true</useMavenLogger>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ </profiles>
</project>
diff --git a/pom.xml b/pom.xml
index a916324..35b2f4f 100644
--- a/pom.xml
+++ b/pom.xml
@@ -15,7 +15,8 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
@@ -46,30 +47,30 @@
<!-- This is updated by the release plugin. This is for Reproducible Builds. -->
<project.build.outputTimestamp>1970-01-01T00:00:00Z</project.build.outputTimestamp>
</properties>
-
+
<modules>
- <module>freemarker-docgen-core</module>
- <module>freemarker-docgen-ant</module>
- <module>freemarker-docgen-maven</module>
- <module>freemarker-docgen-cli</module>
+ <module>freemarker-docgen-core</module>
+ <module>freemarker-docgen-ant</module>
+ <module>freemarker-docgen-maven</module>
+ <module>freemarker-docgen-cli</module>
</modules>
-
+
<build>
<pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.apache.rat</groupId>
- <artifactId>apache-rat-plugin</artifactId>
- <version>0.13</version>
- </plugin>
- </plugins>
+ <plugins>
+ <!-- Before adding something here, check if it's already in org.apache:apache! -->
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>exec-maven-plugin</artifactId>
+ <version>3.0.0</version>
+ </plugin>
+ </plugins>
</pluginManagement>
-
+
<plugins>
<plugin>
<groupId>org.apache.rat</groupId>
<artifactId>apache-rat-plugin</artifactId>
- <version>0.13</version>
<executions>
<execution>
<phase>verify</phase>