docs.yaml

name: Generate and Deploy JSDoc

on:
  push:
    branches:
      - release

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  docs:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v3

    - name: Install libpcap on Ubuntu
      run: |
        sudo apt-get update
        sudo apt-get install -y libpcap-dev

    - name: Set up Node.js
      uses: actions/setup-node@v3
      with:
        node-version: '18'

    - name: Submodule update
      run: git submodule update --init --recursive
      shell: bash

    - name: Install dependencies
      run: npm ci

    - name: Generate JSDoc
      run: npm run generate-docs

    - name: Copy assets
      run: cp -r assets docs

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

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3
      with:
        path: './docs'
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4