docsify-gh-pages.yml

---
# kics-scan disable=555ab8f9-2001-455e-a077-f2d0f41e2fb9
# build and deploy Docsify site to GitHub Pages
name: Deploy Docsify

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["master"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

permissions: read-all
jobs:
  # Build job
  build:
    runs-on: ubuntu-22.04
    permissions:
      contents: read
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: docker pull image
        run: docker pull scrasnups/build:bash-tools-ubuntu-5.1

      - name: Install vendors
        run: |
          set -exo pipefail
          ./bin/installRequirements

      - name: Check if doc up to date
        run: |
          ./bin/doc --ci

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: "pages"

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-22.04
    needs: build
    permissions: # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
      pages: write # to deploy to Pages
      # kics-scan disable=CWE-798
      id-token: write # to verify the deployment originates from an appropriate source
      actions: read # actions: read needed by actions/deploy-pages

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4