Improve GitHub action (#13)

Improve GitHub actions using deploy-pages-artifact

Also add tests.

.github/workflows/default.yml

@@ -1,47 +1,69 @@
 name: CI
 
 on:
+
   push:
+
     branches:
       - main
 
 jobs:
+
   build:
+
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+
+    - name: Checkout repository
+      uses: actions/checkout@v4
 
     - name: Install dependencies
-      run: sudo apt-get install -y build-essential python-dev-is-python3 python3-numpy
+      run: |
+        sudo apt-get install -y build-essential python-dev-is-python3 python3-numpy python3-pytest
 
     - name: Build library
-      run: make PYTHON=python && cp -r permanent/ docs/
+      run: make PYTHON=python
+
+    - name: Run library tests
+      run: make test PYTHON=python
+
+    - name: Copy library to docs/ directory
+      run: cp -r permanent/ docs/permanent/
 
-    - uses: ammaraskar/sphinx-action@master
+    - name: Build documentation
+      uses: ammaraskar/sphinx-action@master
       with:
         build-command: "make html"
         docs-folder: "docs/"
 
-    - uses: actions/upload-artifact@v1
+    - name: Fix documentation permissions
+      run: |
+        chmod -c -R +rX "docs/build/html/" | while read line; do
+          echo "::warning title=Invalid file permissions automatically fixed::$line"
+        done
+
+    - name: Upload Pages artifact
+      uses: actions/upload-pages-artifact@v3
       with:
-        name: DocumentationHTML
         path: docs/build/html/
 
-    - name: Commit documentation changes
-      run: |
-        git clone https://github.com/theochem/matrix-permanent.git --branch gh-pages --single-branch gh-pages
-        cp -r docs/build/html/* gh-pages/
-        cd gh-pages/
-        touch .nojekyll
-        git config --local user.email "action@github.com"
-        git config --local user.name "GitHub Action"
-        git add .
-        git commit -m "Update documentation" -a || true
-
-    - name: Push documentation changes
-      uses: ad-m/github-push-action@master
-      with:
-        branch: gh-pages
-        directory: gh-pages
-        github_token: ${{ secrets.GITHUB_TOKEN }}
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    needs: build
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+
+    steps:
+
+      - name: Deploy artifact to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/pull_request.yml

@@ -1,27 +1,44 @@
-name: Pull Request Docs Check
+name: PR CI
 
 on: [pull_request]
 
 jobs:
+
   build:
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+
+    - name: Checkout repository
+      uses: actions/checkout@v4
 
     - name: Install dependencies
-      run: sudo apt-get install -y build-essential python-dev-is-python3 python3-numpy
+      run: |
+        sudo apt-get install -y build-essential python-dev-is-python3 python3-numpy python3-pytest
 
     - name: Build library
-      run: make PYTHON=python && cp -r permanent/ docs/
+      run: make PYTHON=python
+
+    - name: Run library tests
+      run: make test PYTHON=python
 
-    - uses: ammaraskar/sphinx-action@master
+    - name: Copy library to docs/ directory
+      run: cp -r permanent/ docs/permanent/
+
+    - name: Build documentation
+      uses: ammaraskar/sphinx-action@master
       with:
         build-command: "make html"
         docs-folder: "docs/"
 
-    - uses: actions/upload-artifact@v1
+    - name: Fix documentation permissions
+      run: |
+        chmod -c -R +rX "docs/build/html/" | while read line; do
+          echo "::warning title=Invalid file permissions automatically fixed::$line"
+        done
+
+    - name: Upload Pages artifact
+      uses: actions/upload-pages-artifact@v3
       with:
-        name: DocumentationHTML
         path: docs/build/html/