# Simple workflow for deploying static content to GitHub Pages
name: Deploy GitHub Pages

on:
    # Runs on pushes targeting the default branch
    push:
        branches:
            - main

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

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
    contents: read
    pages: write
    id-token: write

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

jobs:
    # Single deploy job since we're just deploying
    deploy:
        environment:
            name: github-pages
            url: ${{ steps.deployment.outputs.page_url }}
        runs-on: ubuntu-latest
        steps:
            - name: Install apt updates
              run: sudo apt -y update; sudo apt -y upgrade;
            - name: Install prerequisites
              uses: actions/setup-node@v3
              with:
                  node-version: 18
            - name: Checkout
              uses: actions/checkout@v3
            - name: Install dependencies
              run: sudo npm install -g jsdoc
            - name: Run js-doc
              run: sudo npm run js-doc
            - name: Setup Pages
              uses: actions/configure-pages@v2
            - name: Upload artifact
              uses: actions/upload-pages-artifact@v1
              with:
                  # Upload only the src repository
                  path: "./source/"
            - name: Deploy to GitHub Pages
              id: deployment
              uses: actions/deploy-pages@v1