Skip to content
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.

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

Fixes #4212 - Refactor docs to use Maven site plugin from root project #4228

Merged
merged 7 commits into from
Nov 19, 2024
29 changes: 29 additions & 0 deletions .github/workflows/branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,35 @@ on:
- 'v*'
workflow_dispatch:
jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Checkout Piranha
uses: actions/checkout@v4
- name: Checkout Piranha Website
uses: actions/checkout@v4
with:
repository: piranhacloud/piranha-website
token: ${{ secrets.GIT_PASSWORD }}
path: piranha-website
ref: 'gh-pages'
- name: Setup Java
uses: actions/setup-java@v4
with:
distribution: 'temurin'
java-version: 21
- name: Build with Maven
run: |
mvn -B -DskipTests -DskipITs -ntp -T 1 install site
rm -rf piranha-website/snapshot || true
mkdir -p piranha-website/snapshot || true
cp -R target/site/* piranha-website/snapshot/
cd piranha-website
git config --global user.email "[email protected]"
git config --global user.name "Automated publish"
git add .
git commit -a -m "Publishing SNAPSHOT documentation" || true
git push
ghcr:
if: github.repository == 'piranhacloud/piranha'
runs-on: ubuntu-latest
Expand Down
3 changes: 1 addition & 2 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ jobs:
java-version: 21
- name: Build with Maven
run: |
cd docs
mvn -B -DskipTests -DskipITs -ntp -P docs site
mvn -B -DskipTests -DskipITs -ntp -T 1 install site
maven-plugin:
needs: docs
runs-on: ubuntu-latest
Expand Down
7 changes: 0 additions & 7 deletions CODE_OF_CONDUCT.md

This file was deleted.

6 changes: 6 additions & 0 deletions arquillian/managed/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,10 @@
<artifactId>arquillian-testenricher-initialcontext</artifactId>
</dependency>
</dependencies>
<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/arquillian/managed/</url>
</site>
</distributionManagement>
</project>
8 changes: 7 additions & 1 deletion arquillian/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<artifactId>project</artifactId>
<packaging>pom</packaging>

<name>Piranha - Arquillian - Project</name>
<name>Piranha - Arquillian</name>
<description>
The Piranha Arquillian Project delivers you with Arquillian support.
</description>
Expand Down Expand Up @@ -52,4 +52,10 @@
</dependency>
</dependencies>
</dependencyManagement>
<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/arquillian/</url>
</site>
</distributionManagement>
</project>
7 changes: 6 additions & 1 deletion arquillian/server/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,12 @@
</plugin>
</plugins>
</build>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/arquillian/server/</url>
</site>
</distributionManagement>
<profiles>
<profile>
<id>release</id>
Expand Down
6 changes: 6 additions & 0 deletions bom/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -226,4 +226,10 @@
</dependency>
</dependencies>
</dependencyManagement>
<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/bom/</url>
</site>
</distributionManagement>
</project>
7 changes: 7 additions & 0 deletions core/api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,11 @@
<scope>compile</scope>
</dependency>
</dependencies>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/core/api/</url>
</site>
</distributionManagement>
</project>
6 changes: 6 additions & 0 deletions core/impl/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,10 @@
<scope>test</scope>
</dependency>
</dependencies>
<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/core/impl/</url>
</site>
</distributionManagement>
</project>
9 changes: 8 additions & 1 deletion core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<artifactId>project</artifactId>
<packaging>pom</packaging>

<name>Piranha - Core - Project</name>
<name>Piranha - Core</name>

<modules>
<module>api</module>
Expand Down Expand Up @@ -49,4 +49,11 @@
<scope>test</scope>
</dependency>
</dependencies>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/core/</url>
</site>
</distributionManagement>
</project>
22 changes: 20 additions & 2 deletions dist/coreprofile/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<artifactId>piranha-dist-coreprofile</artifactId>
<packaging>jar</packaging>

<name>Piranha - Distribution - CoreProfile</name>
<name>Piranha - Distribution - Core Profile</name>

<dependencies>
<!-- compile -->
Expand Down Expand Up @@ -69,7 +69,12 @@
</plugin>
</plugins>
</build>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/dist/coreprofile/</url>
</site>
</distributionManagement>
<profiles>
<profile>
<id>docker</id>
Expand Down Expand Up @@ -132,4 +137,17 @@
</build>
</profile>
</profiles>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<reportSets>
<reportSet>
<reports/>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
</project>
41 changes: 41 additions & 0 deletions dist/coreprofile/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?xml version="1.0" encoding="ISO-8859-1"?>

<project
xmlns="http://maven.apache.org/DECORATION/1.8.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.0 https://maven.apache.org/xsd/decoration-1.8.0.xsd">
<body>
<menu name="Core Profile">
<item name="Introduction" href="index.html"/>
<item name="Create a REST service" href="create_a_rest_service.html"/>
<item name="Create a JSON REST service" href="create_a_json_rest_service.html"/>
<item name="Debugging a REST service with NetBeans" href="debugging_a_rest_service_with_netbeans.html"/>
<item name="Debugging a REST service with VSCode" href="debugging_a_rest_service_with_vscode.html"/>
<item name="Testing with JUnit 5 and Arquillian" href="testing_with_junit5_and_arquillian.html"/>
<item name="Using Project CRaC" href="using_project_crac.html"/>
</menu>
</body>
<custom>
<fluidoSkin>
<copyrightClass>pull-right</copyrightClass>
<gitHub>
<projectId>piranhacloud/piranha</projectId>
<ribbonOrientation>left-bottom</ribbonOrientation>
<ribbonColor>black</ribbonColor>
</gitHub>
<twitter>
<user>piranha_cloud</user>
</twitter>
</fluidoSkin>
</custom>
<poweredBy>
<logo/>
</poweredBy>
<publishDate position="right"/>
<skin>
<groupId>org.apache.maven.skins</groupId>
<artifactId>maven-fluido-skin</artifactId>
<version>2.0.0</version>
</skin>
<version position="left"/>
</project>
7 changes: 7 additions & 0 deletions dist/isolated/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,13 @@
</plugins>
</build>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/dist/isolated/</url>
</site>
</distributionManagement>

<profiles>
<profile>
<id>docker</id>
Expand Down
7 changes: 7 additions & 0 deletions dist/micro/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,13 @@
</plugin>
</plugins>
</build>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/dist/micro/</url>
</site>
</distributionManagement>

<profiles>
<profile>
Expand Down
7 changes: 7 additions & 0 deletions dist/microprofile/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,13 @@
</plugins>
</build>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/dist/microprofile/</url>
</site>
</distributionManagement>

<profiles>
<profile>
<id>docker</id>
Expand Down
7 changes: 7 additions & 0 deletions dist/platform/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,13 @@
</plugins>
</build>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/dist/platform/</url>
</site>
</distributionManagement>

<profiles>
<profile>
<id>docker</id>
Expand Down
9 changes: 8 additions & 1 deletion dist/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<artifactId>project</artifactId>
<packaging>pom</packaging>

<name>Piranha - Distribution - Project</name>
<name>Piranha - Distribution</name>

<modules>
<module>coreprofile</module>
Expand Down Expand Up @@ -44,4 +44,11 @@
<scope>test</scope>
</dependency>
</dependencies>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/dist/</url>
</site>
</distributionManagement>
</project>
7 changes: 7 additions & 0 deletions dist/server/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,13 @@
</plugins>
</build>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/dist/server/</url>
</site>
</distributionManagement>

<profiles>
<profile>
<id>docker</id>
Expand Down
7 changes: 7 additions & 0 deletions dist/servlet/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,13 @@
</plugins>
</build>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/dist/servlet/</url>
</site>
</distributionManagement>

<profiles>
<profile>
<id>docker</id>
Expand Down
7 changes: 7 additions & 0 deletions dist/webprofile/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,13 @@
</plugins>
</build>

<distributionManagement>
<site>
<id>default</id>
<url>file:///tmp/piranha/dist/webprofile/</url>
</site>
</distributionManagement>

<profiles>
<profile>
<id>docker</id>
Expand Down
Loading
Loading