This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch MPOM-483
in repository https://gitbox.apache.org/repos/asf/maven-apache-parent.git
commit 5e8a8d21e0215b7a9ba3cb2c23b63e8063e9b7be
Author: Slawomir Jaranowski <s.jaranow...@gmail.com>
AuthorDate: Fri Apr 12 20:41:37 2024 +0200
[MPOM-483] Make a separate module for documentation
---
.github/workflows/maven-verify.yml | 2 -
README.md | 3 +-
site-pom.xml => docs/pom.xml | 54 ++++++++++++++++++----
{src/site-docs => docs/src/site}/apt/index.apt.vm | 0
.../src/site}/resources/download.cgi | 0
{src/site-docs => docs/src/site}/site.xml | 0
.../src/site}/xdoc/download.xml.vm | 0
pom.xml | 14 ++++++
8 files changed, 60 insertions(+), 13 deletions(-)
diff --git a/.github/workflows/maven-verify.yml
b/.github/workflows/maven-verify.yml
index bc1f5fd..4d67fdc 100644
--- a/.github/workflows/maven-verify.yml
+++ b/.github/workflows/maven-verify.yml
@@ -25,5 +25,3 @@ jobs:
build:
name: Verify
uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v3
- with:
- ff-site-goal: 'site site:stage -f site-pom.xml'
diff --git a/README.md b/README.md
index b646516..c2dc227 100644
--- a/README.md
+++ b/README.md
@@ -62,8 +62,7 @@ There are some guidelines which will make applying PRs easier
for us:
[MPOM-XXX] - Subject of the JIRA Ticket
Optional supplemental description.
```
-+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
-+ Update the [site documentation](https://maven.apache.org/pom/asf/)
accordingly in `src/site-docs` and build it via `mvn site -f site-pom.xml`
(uses a dedicated POM to not be inherited)
++ Update the [site documentation](https://maven.apache.org/pom/asf/)
accordingly in `docs/src/site` and build it via `mvn site -pl docs`
+ Submit a pull request to the repository in the Apache organization.
+ Update your JIRA ticket and include a link to the pull request in the ticket.
diff --git a/site-pom.xml b/docs/pom.xml
similarity index 75%
rename from site-pom.xml
rename to docs/pom.xml
index 35ef318..680a5d0 100644
--- a/site-pom.xml
+++ b/docs/pom.xml
@@ -26,10 +26,9 @@ under the License.
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
<version>32-SNAPSHOT</version>
- <relativePath>./pom.xml</relativePath>
</parent>
- <artifactId>apache.</artifactId>
+ <artifactId>docs</artifactId>
<packaging>pom</packaging>
<name>Apache Software Foundation Parent POM</name>
@@ -46,16 +45,11 @@ under the License.
</mailingList>
</mailingLists>
- <scm>
-
<connection>scm:git:https://gitbox.apache.org/repos/asf/maven-apache-parent.git</connection>
-
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-apache-parent.git</developerConnection>
-
<url>https://github.com/apache/maven-apache-parent/tree/${project.scm.tag}</url>
- <tag>apache-${project.version}</tag>
- </scm>
<issueManagement>
<system>jira</system>
<url>https://issues.apache.org/jira/issues/?jql=project%3DMPOM+AND+component%3Dasf</url>
</issueManagement>
+
<ciManagement>
<system>Jenkins</system>
<url>https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-apache-parent/</url>
@@ -68,6 +62,7 @@ under the License.
</notifier>
</notifiers>
</ciManagement>
+
<distributionManagement>
<site>
<id>apache.website</id>
@@ -82,11 +77,26 @@ under the License.
<build>
<plugins>
+ <!-- module with documentation not need to install and deploy -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-install-plugin</artifactId>
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-deploy-plugin</artifactId>
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ </plugin>
+
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<configuration>
- <siteDirectory>${basedir}/src/site-docs</siteDirectory>
<skipDeploy>true</skipDeploy><!-- don't deploy site with
maven-site-plugin -->
</configuration>
</plugin>
@@ -110,4 +120,30 @@ under the License.
</plugin>
</plugins>
</build>
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <reportSets>
+ <reportSet>
+ <configuration>
+ <webAccessUrl>${project.parent.scm.url}</webAccessUrl>
+ </configuration>
+ <reports>
+ <report>ci-management</report>
+ <report>issue-management</report>
+ <report>mailing-lists</report>
+ <report>plugin-management</report>
+ <report>scm</report>
+ <report>team</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+
+
</project>
diff --git a/src/site-docs/apt/index.apt.vm b/docs/src/site/apt/index.apt.vm
similarity index 100%
rename from src/site-docs/apt/index.apt.vm
rename to docs/src/site/apt/index.apt.vm
diff --git a/src/site-docs/resources/download.cgi
b/docs/src/site/resources/download.cgi
similarity index 100%
rename from src/site-docs/resources/download.cgi
rename to docs/src/site/resources/download.cgi
diff --git a/src/site-docs/site.xml b/docs/src/site/site.xml
similarity index 100%
rename from src/site-docs/site.xml
rename to docs/src/site/site.xml
diff --git a/src/site-docs/xdoc/download.xml.vm
b/docs/src/site/xdoc/download.xml.vm
similarity index 100%
rename from src/site-docs/xdoc/download.xml.vm
rename to docs/src/site/xdoc/download.xml.vm
diff --git a/pom.xml b/pom.xml
index c12552f..e4cfafb 100644
--- a/pom.xml
+++ b/pom.xml
@@ -59,6 +59,10 @@ under the License.
</mailingList>
</mailingLists>
+ <modules>
+ <module>docs</module>
+ </modules>
+
<scm>
<connection>scm:git:https://gitbox.apache.org/repos/asf/maven-apache-parent.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/maven-apache-parent.git</developerConnection>
@@ -404,6 +408,16 @@ under the License.
</execution>
</executions>
</plugin>
+
+ <!-- we have dedicated module for documentation, so skip site plugin at
all -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <inherited>false</inherited>
+ <configuration>
+ <skip>true</skip>
+ </configuration>
+ </plugin>
</plugins>
</build>
