From 8fac1d6391a39aaa7b60e2b6acb9ec82158c3e5d Mon Sep 17 00:00:00 2001
From: Jiaqi Liu <jack20220723@gmail.com>
Date: Sat, 7 Dec 2024 18:04:35 +0800
Subject: [PATCH] Deploy Javadoc to Github Pages (#1)

---
 .github/workflows/ci-cd.yaml | 57 ++++++++++++++++++++++++++++++++++++
 .gitignore                   |  2 ++
 README.md                    | 16 +---------
 pom.xml                      |  1 +
 tutorial/Tutorial.md         | 29 +++++++++++++-----
 5 files changed, 83 insertions(+), 22 deletions(-)
 create mode 100644 .github/workflows/ci-cd.yaml
 mode change 100644 => 120000 README.md

diff --git a/.github/workflows/ci-cd.yaml b/.github/workflows/ci-cd.yaml
new file mode 100644
index 000000000..5d6d82512
--- /dev/null
+++ b/.github/workflows/ci-cd.yaml
@@ -0,0 +1,57 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+---
+name: CI/CD
+
+"on":
+  pull_request:
+  push:
+    branches:
+      - master
+
+env:
+  JDK_VERSION: 17
+  JDK_DISTRIBUTION: 'adopt'
+  USER: QubitPi
+  EMAIL: jack20220723@gmail.com
+
+jobs:
+  documentation:
+    name: Publish Javadoc to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK ${{ env.JDK_VERSION }}
+        uses: actions/setup-java@v3
+        with:
+          java-version: ${{ env.JDK_VERSION }}
+          distribution: ${{ env.JDK_DISTRIBUTION }}
+      - name: Generate Javadoc
+        run: |
+          cd shaded
+          mvn clean package
+          cd ../
+          mvn package
+          mvn javadoc:aggregate -Pjavadoc
+      - name: Load CNAME
+        run: echo arango-java.qubitpi.org > ./target/reports/apidocs/CNAME
+      - name: Deploy Javadoc to GitHub Pages
+        if: github.ref == 'refs/heads/master'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./target/reports/apidocs
+          enable_jekyll: false
+          user_name: ${{ env.USER }}
+          user_email: ${{ env.EMAIL }}
diff --git a/.gitignore b/.gitignore
index 159df0dc0..b5d63aa4f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,3 +12,5 @@ test-results-native
 
 dependency-reduced-pom.xml
 /bin/
+
+.DS_Store
diff --git a/README.md b/README.md
deleted file mode 100644
index 86ab53472..000000000
--- a/README.md
+++ /dev/null
@@ -1,15 +0,0 @@
-![ArangoDB-Logo](https://user-images.githubusercontent.com/3998723/207981337-79d49127-48fc-4c7c-9411-8a688edca1dd.png)
-
-# ArangoDB Java Driver
-
-[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.arangodb/arangodb-java-driver/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.arangodb/arangodb-java-driver)
-[![CircleCI](https://dl.circleci.com/status-badge/img/gh/arangodb/arangodb-java-driver/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/arangodb/arangodb-java-driver/tree/main)
-
-The official [ArangoDB](https://www.arangodb.com/) Java Driver.
-
-## Learn more
-
-- [ChangeLog](ChangeLog.md)
-- [Examples](test-non-functional/src/test/java/example)
-- [Documentation and Tutorial](https://docs.arangodb.com/stable/develop/drivers/java/)
-- [JavaDoc](https://www.javadoc.io/doc/com.arangodb/arangodb-java-driver/latest/index.html)
diff --git a/README.md b/README.md
new file mode 120000
index 000000000..7976c7a63
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+tutorial/Tutorial.md
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
index a574ba455..c76f2e4cf 100644
--- a/pom.xml
+++ b/pom.xml
@@ -33,6 +33,7 @@
     </licenses>
 
     <properties>
+        <doclint>none</doclint>
         <maven.compiler.target>8</maven.compiler.target>
         <maven.compiler.source>8</maven.compiler.source>
         <maven.compiler.release>8</maven.compiler.release>
diff --git a/tutorial/Tutorial.md b/tutorial/Tutorial.md
index fccf40d45..6edc6d673 100644
--- a/tutorial/Tutorial.md
+++ b/tutorial/Tutorial.md
@@ -1,12 +1,20 @@
+![](https://github.com/QubitPi/QubitPi/blob/master/img/arango-logo-with-text.png?raw=true)
+
 # ArangoDB Java driver
 
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/arangodb/arangodb-java-driver/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/arangodb/arangodb-java-driver/tree/main)
+
+[![Maven Central](https://img.shields.io/maven-central/v/com.arangodb/arangodb-java-driver?style=for-the-badge&logo=apachemaven&logoColor=white&labelColor=4D9FEA&color=brightgreen)](https://maven-badges.herokuapp.com/maven-central/com.arangodb/arangodb-java-driver)
+[![GitHub workflow status badge][GitHub workflow status badge]][GitHub workflow status URL]
+[![Apache License][Apache License Badge]][Apache License, Version 2.0]
+
 The official ArangoDB Java Driver.
 
-- Repository: <https://github.com/arangodb/arangodb-java-driver>
-- [Code examples](https://github.com/arangodb/arangodb-java-driver/tree/main/test-non-functional/src/test/java/example)
+- Repository: <https://github.com/QubitPi/arangodb-java-driver>
+- [Code examples](https://github.com/QubitPi/arangodb-java-driver/tree/main/test-non-functional/src/test/java/example)
 - [Reference](reference-version-7/_index.md) (driver setup, serialization, changes in version 7)
-- [JavaDoc](https://www.javadoc.io/doc/com.arangodb/arangodb-java-driver/latest/index.html) (generated reference documentation)
-- [ChangeLog](https://github.com/arangodb/arangodb-java-driver/blob/main/ChangeLog.md)
+- [JavaDoc] (generated reference documentation)
+- [ChangeLog](https://github.com/QubitPi/arangodb-java-driver/blob/main/ChangeLog.md)
 
 ## Supported versions
 
@@ -339,8 +347,7 @@ Removed document: 6
   query language
 - See [Serialization](reference-version-7/serialization.md) for details about
   user-data serde
-- For the full reference documentation, see
-  [JavaDoc](https://www.javadoc.io/doc/com.arangodb/arangodb-java-driver/latest/index.html)
+- For the full reference documentation, see [JavaDoc]
 
 ## GraalVM Native Image
 
@@ -348,7 +355,7 @@ The driver supports GraalVM Native Image compilation.
 To compile with `--link-at-build-time` when `http-protocol` module is present in
 the classpath, additional substitutions are required for transitive dependencies
 `Netty` and `Vert.x`. See this
-[example](https://github.com/arangodb/arangodb-java-driver/tree/main/test-functional/src/test-default/java/graal)
+[example](https://github.com/QubitPi/arangodb-java-driver/tree/main/test-functional/src/test-default/java/graal)
 for reference. Such substitutions are not required when compiling the shaded driver.
 
 ### Framework compatibility
@@ -472,3 +479,11 @@ and deserialized internally by the driver.
 The behavior to serialize and deserialize these classes is considered an internal
 implementation detail, and as such, it might change without prior notice.
 The API with regard to the public members of these classes is kept compatible.
+
+[Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
+[Apache License Badge]: https://img.shields.io/badge/Apache%202.0-F25910.svg?style=for-the-badge&logo=Apache&logoColor=white
+
+[GitHub workflow status badge]: https://img.shields.io/github/actions/workflow/status/QubitPi/arangodb-java-driver/ci-cd.yaml?branch=master&style=for-the-badge&logo=github&logoColor=white&label=CI/CD
+[GitHub workflow status URL]: https://github.com/QubitPi/arangodb-java-driver/actions/workflows/ci-cd.yaml
+
+[JavaDoc]: https://arango-java.qubitpi.org/

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://clevelandohioweatherforecast.com/php-proxy/index.php?q=https://github.com/arangodb/arangodb-java-driver/compare/arangodb:0da6fce...QubitPi:8fac1d6.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://clevelandohioweatherforecast.com/pFad/index.php?u=https://github.com/arangodb/arangodb-java-driver/compare/arangodb:0da6fce...QubitPi:8fac1d6.patch" target="_blank">pFad Proxy</a></p><p><a href="http://clevelandohioweatherforecast.com/pFad/v3index.php?u=https://github.com/arangodb/arangodb-java-driver/compare/arangodb:0da6fce...QubitPi:8fac1d6.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://clevelandohioweatherforecast.com/pFad/v4index.php?u=https://github.com/arangodb/arangodb-java-driver/compare/arangodb:0da6fce...QubitPi:8fac1d6.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>