name: Deploy help

on:
  # Runs on every push to a tag not containing a /
  push:
    tags:
      - "*"
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

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

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  deploy-help:
    name: Deploy help
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-24.04
    steps:
      # 1. Checkout the repo
      - name: Checkout
        uses: actions/checkout@v6.0.2

      # 2. Install Python and MkDocs
      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.x"

      - name: Install dependencies
        run: |
          pip install mkdocs mkdocs-material

      # 3. Generate plugin properties HTML
      - name: Generate plugin properties HTML
        run: python util/generate_command_docs.py

      # 4. Build MkDocs site
      - name: Build MkDocs site
        run: mkdocs build

      # 5. Setup GitHub Pages
      - name: Setup Pages
        uses: actions/configure-pages@v6.0.0

      # 6. Upload the generated site (site_dir)
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v5.0.0
        with:
          path: src/contents/site

      # 7. Deploy to GitHub Pages
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5.0.0
