docs.yml

name: Deploy Docs

on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
  pull_request:
    branches:
      - main
    paths:
      - 'docs/**'
      - 'install/**'
      - '.github/workflows/docs.yml'
      - 'mkdocs.yml'
      - 'pixi.*'
  workflow_dispatch:


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

jobs:
  build:
    # Don't run on forks
    if: github.repository == 'prefix-dev/pixi'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - uses: prefix-dev/setup-pixi@v0.5.1
        with:
          pixi-version: v0.13.0
          cache: true

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

      - name: Build pixi Documentation
        run: pixi run build-docs

      #  This adds the following:
      #   - A .nojekyll file to disable Jekyll GitHub Pages builds.
      #   - Adds installation scripts to the pages webserver.
      - name: Finalize documentation
        run: |
          touch site/.nojekyll
          cp install/{install.sh,install.ps1} site

      # https://github.com/actions/upload-pages-artifact#file-permissions
      - run: chmod -c -R +rX site/

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

  deploy:
    runs-on: ubuntu-latest
    needs: build
    if: github.repository == 'prefix-dev/pixi' && github.ref == 'refs/heads/main'
    permissions:
      contents: read
      pages: write
      id-token: write
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4