Merge pull request #54 from Xylambda/test-github-actions

Update GitHub Actions workflow for testing

Author: Xylambda

.github/workflows/gh-pages.yml

@@ -4,53 +4,39 @@ on:
   push:
     branches:
       - master
-      - develop
+  pull_request:
+    branches:
+      - master
 
 jobs:
   build_docs_job:
     runs-on: ubuntu-latest
-    env:
-      GITHUB_PAT: ${{ secrets.PUSH_TOKEN }}
 
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-      - name: Python Set Up
+      - name: Set up Python
         uses: actions/setup-python@v4
         with:
           python-version: 3.8
 
       - name: Upgrade pip
         run: |
-          # install pip=>20.1 to use "pip cache dir"
-          python3 -m pip install --upgrade pip
+          python -m pip install --upgrade pip
 
       - name: Install dependencies
         run: |
-          python3 -m pip install . -r requirements-dev.txt
+          python -m pip install . -r requirements-dev.txt
 
-      - name: Make Sphinx docs
+      - name: Build Sphinx documentation
         run: |
           make -C docs clean
           make -C docs html
 
-      - name: Init new repository in dist folder and commit generated files
-        run: |
-          cd docs/build/html/
-          git init
-          git remote add origin https://${{ secrets.PUSH_TOKEN }}@github.com/Xylambda/kalmankit
-          git config --global --add safe.directory /github/workspace/docs/build/html
-          touch .nojekyll
-          git add -A
-          git config --local user.email "[email protected]"
-          git config --local user.name "GitHub Action"
-          git commit -m 'deploy'
-
-      - name: Force push to destination branch
-        uses: ad-m/[email protected]
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
         with:
-          github_token: ${{ secrets.PUSH_TOKEN }}
-          branch: gh-pages
-          force: true
-          directory: ./docs/build/html
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: docs/build/html