docs: release JavaDocs using Maven

lentidas · Oct 16, 2024 · 4cf6dec · 4cf6dec
1 parent 031b29c
commit 4cf6dec
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 10 deletions.
diff --git a/.github/workflows/publish-javadoc.yaml b/.github/workflows/publish-javadoc.yaml
@@ -6,15 +6,35 @@ on:
       - main
 
 jobs:
-  publish-javadoc:
+  build:
     runs-on: ubuntu-latest
     steps:
-    - name: Deploy JavaDoc documentation
-      uses: MathieuSoysal/Javadoc-publisher.yml@main
-      with:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        javadoc-branch: javadoc
-        java-version: 17
-        project: maven
-        javadoc-source-folder: .
-        custom-command: javadoc -d . -private -sourcepath src/main/java/ch/heigvd/dai -subpackages commands -subpackages exceptions -subpackages utilities
+      - name: "Check out the repository"
+        uses: actions/checkout@v4
+
+      - name: "Setup Java and Maven"
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+
+      - name: "Build JavaDoc using Maven"
+        run: mvn javadoc:javadoc
+
+      - name: "Upload JavaDoc as an artifact"
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: target/reports/apidocs
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: "Deploy to GitHub Pages"
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/dependency-reduced-pom.xml b/dependency-reduced-pom.xml
@@ -33,6 +33,14 @@
           </java>
         </configuration>
       </plugin>
+      <plugin>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>3.10.1</version>
+        <configuration>
+          <show>private</show>
+          <nohelp>true</nohelp>
+        </configuration>
+      </plugin>
       <plugin>
         <artifactId>maven-shade-plugin</artifactId>
         <version>3.6.0</version>

diff --git a/pom.xml b/pom.xml
@@ -53,6 +53,17 @@
         </executions>
       </plugin>
 
+      <!-- https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-javadoc-plugin -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>3.10.1</version>
+        <configuration>
+          <show>private</show>
+          <nohelp>true</nohelp>
+        </configuration>
+      </plugin>
+
       <!-- https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-shade-plugin -->
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>