Merge pull request #847 from uyjulian/doxygen_ci_improvements

Build and upload Doxygen artifact for CI

Author: fjtrujy

.github/workflows/gh-pages.yml

@@ -1,26 +1,60 @@
 name: github pages
 
 on:
-  workflow_dispatch:
-  push:
-    branches:
-      - master
+  push: {}
+  pull_request: {}
+  workflow_dispatch: {}
+
+env:
+  DEBIAN_FRONTEND: noninteractive
+  TZ: Japan
 
 jobs:
-  build:
+  build-docs:
     runs-on: ubuntu-latest
+    timeout-minutes: 20
+    container:
+      image: ubuntu:20.04
+      options: "--user 0"
 
     steps:
-    - uses: actions/checkout@v4
+    - name: Set up base environment
+      run: apt-get -y update && apt-get -y -o Dpkg::Options::='--force-confdef' -o Dpkg::Options::='--force-confold' install build-essential git doxygen graphviz p7zip-full
+
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Mark all git directories safe
+      run: git config --global --add safe.directory '*'
 
-    - name: clone custom doxygen CSS
+    - name: Build documentation
       run: |
-         git clone https://github.com/jothepro/doxygen-awesome-css
+        export PS2DEV=$PWD/ps2dev
+        export PS2SDK=$PS2DEV/ps2sdk
+        make -j $(getconf _NPROCESSORS_ONLN) ONLY_HOST_TOOLS=1 docs
+
+    - name: Upload artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ github.event.repository.name }}-docs
+        path: ./*.tgz
 
-    - name: Doxygen documentation generation
-      uses: mattnotmitt/doxygen-action@v1
+  publish-github-pages:
+    needs: [build-docs]
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+
+    steps:
+    - name: Download all artifacts
+      uses: actions/download-artifact@v4
+
+    - name: Extract artifact
+      run: |
+        mkdir -p docs/html
+        tar -xpzf */*.tgz -C docs/html
 
     - name: Deploy
+      if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
       uses: peaceiris/actions-gh-pages@v3
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -21,6 +21,7 @@
 *.swp
 *.tmp
 *.bin
+*.tgz
 
 #
 # files that we don't want to ignore

Doxyfile

@@ -2628,5 +2628,5 @@ DOT_CLEANUP            = YES
 GENERATE_TREEVIEW      = YES # optional. Also works without treeview
 DISABLE_INDEX = NO
 FULL_SIDEBAR = NO
-HTML_EXTRA_STYLESHEET  = doxygen-awesome-css/doxygen-awesome.css
+HTML_EXTRA_STYLESHEET  = docs/doxygen-awesome-css/doxygen-awesome.css
 

Makefile

@@ -124,7 +124,15 @@ clean_dependencies:
 	  $(MAKEREC) $(PS2SDKSRC)/common/external_deps clean ; \
 	fi
 
-docs:
+DOXYGEN_OUTPUT_ARCHIVE = doxygen-output.tgz
+
+docs/doxygen-awesome-css:
+	git clone https://github.com/jothepro/doxygen-awesome-css.git $@
+
+$(DOXYGEN_OUTPUT_ARCHIVE): Doxyfile docs/doxygen-awesome-css
 	doxygen
+	tar -cpzf $@ -C docs/html .
+
+docs: $(DOXYGEN_OUTPUT_ARCHIVE)
 
 include Defs.make