Merge pull request #4 from RomualdRousseau/feature/new-doc-system

fix: Add workflow for github pages
RomualdRousseau · Aug 27, 2024 · 21c67d6 · 21c67d6
2 parents 2252258 + 5ba9ec1
commit 21c67d6
Show file tree

Hide file tree

Showing 1,217 changed files with 235 additions and 149,144 deletions.
diff --git a/.github/workflows/any2json-monorepo-release.yml b/.github/workflows/any2json-monorepo-release.yml
@@ -5,10 +5,16 @@ on:
         types: [published]
 
 jobs:
-    deploy-prod:
-        uses: ./.github/workflows/maven-deploy-prod.yml
+    # deploy-prod:
+    #     uses: ./.github/workflows/maven-deploy-prod.yml
+    #     with:
+    #         version: ${{ github.event.release.tag_name }}
+    #     secrets: inherit
+
+    deploy-doc:
+        needs: [deploy-prod]
+        uses: ./.github/workflows/maven-deploy-doc.yml
         with:
             version: ${{ github.event.release.tag_name }}
-        secrets: inherit
 
 
diff --git a/.github/workflows/maven-build.yml b/.github/workflows/maven-build.yml
@@ -9,24 +9,26 @@ jobs:
     maven-build:
         runs-on: [ubuntu-latest]
         steps:
-            - uses: actions/checkout@v4
-            - name: Set up JDK 17
+            - name: Checkout
+              uses: actions/checkout@v4
 
+            - name: Set up JDK 17
               uses: actions/setup-java@v4
               with:
                   java-version: 17
                   distribution: "temurin"
 
-            - uses: actions/cache@v4
+            - name: Cache
+              uses: actions/cache@v4
               with:
                   path: ~/.m2/repository
                   key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
 
             - name: Installing local dependencies
-              run: mvn initialize --projects :${{ inputs.service }} --file pom.xml --also-make --batch-mode
+              run: mvn initialize --projects :${{ inputs.service }} --also-make
 
             - name: Build project
-              run: mvn -U -B package -Dmaven.test.skip=true --projects :${{ inputs.service }} --file pom.xml --also-make --batch-mode
+              run: mvn -U -B package -DskipTests --projects :${{ inputs.service }} --also-make
 
             - name: Archive build artifact
               uses: actions/upload-artifact@v4

diff --git a/.github/workflows/maven-deploy-doc.yml b/.github/workflows/maven-deploy-doc.yml
@@ -0,0 +1,58 @@
+on:
+    workflow_call:
+        inputs:
+            version:
+                required: true
+                type: string
+
+jobs:
+    maven-deploy-doc:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: [ubuntu-latest]
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Set up JDK 17
+              uses: actions/setup-java@v4
+              with:
+                  java-version: 17
+                  distribution: "temurin"
+
+            - name: Set up Python 3.11
+              uses: actions/setup-python@v5
+              with:
+                  python-version: "3.11"
+
+            - name: Set up MkDocs
+              run: pip install mkdocs
+
+            - name: Cache
+              uses: actions/cache@v4
+              with:
+                  path: ~/.m2/repository
+                  key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+
+            - name: Set version
+              run: |
+                  mvn versions:set -DnewVersion=${{ inputs.version }}
+                  mvn versions:commit
+
+            - name: Build documentation
+              run: |
+                  mkdocs build --config-file ./any2json-documents/mkdocs.yml --site-dir ./target/docs
+                  mvn -B -P documentation clean site site:stage
+
+            - name: Setup pages
+              uses: actions/configure-pages@v5
+
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: ./target/docs
+
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4
diff --git a/.github/workflows/maven-deploy-prod.yml b/.github/workflows/maven-deploy-prod.yml
@@ -18,38 +18,40 @@ jobs:
     maven-deploy-prod:
         runs-on: [ubuntu-latest]
         steps:
-            - uses: actions/checkout@v4
+            - name: Checkout
+              uses: actions/checkout@v4
 
             - name: Set up JDK 17
               uses: actions/setup-java@v4
               with:
                   java-version: 17
                   distribution: "temurin"
 
-            - uses: actions/cache@v4
+            - name: Cache
+              uses: actions/cache@v4
               with:
                   path: ~/.m2/repository
                   key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
 
-            - name: Installing local dependencies
-              run: mvn initialize --file pom.xml --also-make --batch-mode
-
-            - name: Set version
-              run: |
-                  mvn versions:set -DnewVersion=${{ inputs.version }} --file pom.xml --also-make --batch-mode
-                  mvn versions:commit --file pom.xml --also-make --batch-mode
-
             - name: Setup GPG
               run: |
                   echo "$GPG_PRIVATE_KEY" > private.asc
                   gpg --import --batch private.asc
               env:
                   GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
 
+            - name: Set version
+              run: |
+                  mvn versions:set -DnewVersion=${{ inputs.version }}
+                  mvn versions:commit
+
+            - name: Installing local dependencies
+              run: mvn -U -B initialize
+
             - name: Deploy project
               run: |
                   export GPG_TTY=$(tty)
-                  mvn -U -B clean deploy -P release --file pom.xml -s .mvn/settings.xml --also-make --batch-mode
+                  mvn -U -B clean deploy -P release -s .mvn/settings.xml
               env:
                   OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
                   OSSRH_TOKEN: ${{ secrets.OSSRH_TOKEN }}

diff --git a/.github/workflows/maven-deploy-snapshot.yml b/.github/workflows/maven-deploy-snapshot.yml
@@ -10,24 +10,26 @@ jobs:
     maven-deploy-snapshot:
         runs-on: [ubuntu-latest]
         steps:
-            - uses: actions/checkout@v4
+            - name: Checkout
+              uses: actions/checkout@v4
 
             - name: Set up JDK 17
               uses: actions/setup-java@v4
               with:
                   java-version: 17
                   distribution: "temurin"
 
-            - uses: actions/cache@v4
+            - name: Cache
+              uses: actions/cache@v4
               with:
                   path: ~/.m2/repository
                   key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
 
             - name: Installing local dependencies
-              run: mvn initialize --file pom.xml --also-make --batch-mode
+              run: mvn -U -B initialize
 
             - name: Deploy project snapshot
-              run: mvn -U -B clean deploy -P snapshot --file pom.xml -s .mvn/settings.xml --also-make --batch-mode
+              run: mvn -U -B clean deploy -P snapshot -s .mvn/settings.xml
               env:
                   OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
                   OSSRH_TOKEN: ${{ secrets.OSSRH_TOKEN }}
diff --git a/.github/workflows/maven-test.yml b/.github/workflows/maven-test.yml
@@ -9,21 +9,23 @@ jobs:
     maven-test:
         runs-on: [ubuntu-latest]
         steps:
-            - uses: actions/checkout@v4
-            - name: Set up JDK 17
+            - name: Checkout
+              uses: actions/checkout@v4
 
+            - name: Set up JDK 17
               uses: actions/setup-java@v4
               with:
                   java-version: 17
                   distribution: "temurin"
 
-            - uses: actions/cache@v4
+            - name: Cache
+              uses: actions/cache@v4
               with:
                   path: ~/.m2/repository
                   key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
 
             - name: Installing local dependencies
-              run: mvn initialize --projects :${{ inputs.service }} --file pom.xml --also-make --batch-mode
+              run: mvn -U -B initialize --projects :${{ inputs.service }} --also-make
 
             - name: Test project
-              run: mvn -B test --projects :${{ inputs.service }} --file pom.xml --also-make --batch-mode
+              run: mvn -U -B test --projects :${{ inputs.service }} --also-make
diff --git a/README.md b/README.md
@@ -78,7 +78,7 @@ Run the following command line:
 mvn -P release clean deploy
 ```
 
-### Build and deploy the javadoc documentation
+### Build the javadoc documentation
 
 Run the following command line:
 

diff --git a/any2json-dbf/pom.xml b/any2json-dbf/pom.xml
@@ -16,10 +16,6 @@
     <description>Convert any text file in Json</description>
     <url>https://github.com/romualdrousseau/any2json-dbf</url>
 
-    <properties>
-        <javadbf.version>1.14.1</javadbf.version>
-    </properties>
-
     <dependencies>
         <!-- Any2Json Framework -->
         <dependency>

diff --git a/any2json-documents/justfile b/any2json-documents/justfile
@@ -1,5 +1,5 @@
 build: copy-pdfs
-    mkdocs build --site-dir ../docs
+    mkdocs build --site-dir ../target/docs
 
 serve: copy-pdfs
     mkdocs serve

diff --git a/any2json-examples/pom.xml b/any2json-examples/pom.xml
@@ -68,7 +68,7 @@
         <plugins>
             <plugin>
                 <artifactId>maven-install-plugin</artifactId>
-                <version>3.1.2</version>
+                <version>3.1.3</version>
                 <executions>
                     <execution>
                         <?m2e ignore?>
@@ -89,7 +89,7 @@
             </plugin>
             <plugin>
                 <artifactId>maven-dependency-plugin</artifactId>
-                <version>3.6.1</version>
+                <version>3.8.0</version>
                 <executions>
                     <execution>
                         <?m2e ignore?>

diff --git a/any2json-excel/pom.xml b/any2json-excel/pom.xml
@@ -16,10 +16,6 @@
     <description>Convert any text file in Json</description>
     <url>https://github.com/romualdrousseau/any2json-excel</url>
 
-    <properties>
-        <poi.version>5.3.0</poi.version>
-    </properties>
-
     <dependencies>
         <!-- Any2Json Framework -->
         <dependency>
@@ -73,7 +69,7 @@
         <plugins>
             <plugin>
                 <artifactId>maven-install-plugin</artifactId>
-                <version>3.1.2</version>
+                <version>3.1.3</version>
                 <executions>
                     <execution>
                         <?m2e ignore?>