update workflows to automate deployment

Author: Woozl

.github/workflows/build-and-push-image.yml

@@ -1,26 +1,41 @@
-name: "Build and push image to Github Container Registry"
+name: Build and push image to Github Container Registry
 
 on:
-  release:
-    types: [published]
+  workflow_run:
+    workflows: ["Update docs data"] # This must exactly match the name: in update-docs-data.yml
+    types:
+      - completed
 
 jobs:
-  publish:
+  docker-build-push:
     name: Push Automat API docs to GHCR
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    if: ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'release' }}
+
     steps:
       - name: Check out the repo
-        uses: actions/checkout@v2
-      - name: Get the version
-        id: get_version
-        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
-      - name: Push api docs
-        uses: docker/build-push-action@v1
+        uses: actions/checkout@v4
+
+      - name: Log in to GHCR
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-          path: .
-          dockerfile: ./Dockerfile
-          repository: robokopu24/api-docs
-          tags: latest,${{ steps.get_version.outputs.VERSION }}
+
+      - name: Extract release tag
+        id: vars
+        run: echo "TAG=${GITHUB_REF_NAME}" >> $GITHUB_ENV
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: |
+            ghcr.io/${{ github.repository }}:${{ env.TAG }}
+            ghcr.io/${{ github.repository }}:latest

.github/workflows/generate-docs.yml

@@ -0,0 +1,80 @@
+name: Update docs data
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  update-docs-data:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the current code
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: "npm"
+
+      - name: Cache npm dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-npm-
+
+      - name: Write current date to environment variable
+        run: echo "DATE=$(date +'%Y-%m-%d-%I.%M.%S%p')" >> $GITHUB_ENV
+
+      - name: Add git user configuration
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+
+      - name: Install dependencies
+        run: npm ci --legacy-peer-deps
+
+      - name: Fetch newest Automat OpenAPI document and metadata
+        run: npm run preprocess
+
+      - name: Remove the old markdown pages and regen with new OpenAPI data
+        run: |
+          npm run clean-api-docs automat
+          npm run gen-api-docs automat
+
+      - name: Reorder sidebar listing to put TRAPI endpoints first
+        run: npm run rearrange-sidebar
+
+      - name: Group endpoints into query + metadata sections
+        run: npm run rewrite-mdx
+
+      - name: Remove "Introduction" page
+        run: rm ./docs/automat/automat.info.mdx || echo "Introduction docs page is already deleted"
+
+      - name: Check for untracked files
+        run: |
+          git add -A
+          if git diff --cached --quiet; then
+            echo "Docs have not been updated, nothing has changed." > $GITHUB_STEP_SUMMARY
+          else
+            echo "UPDATED=true" >> $GITHUB_ENV
+          fi
+
+      # Only run the next two steps if there were changes detected by `git status` in the previous step
+      - name: Commit changes
+        if: ${{ env.UPDATED == 'true' }}
+        run: |
+          git commit -m "Update documentation - ${{ env.DATE }} [skip-ci]"
+          git push
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}