documentation.yml

name: Documentation

permissions:
  actions: write
  contents: read

on:
  push:
    branches:
      - master
    tags: '*'
  pull_request:

jobs:
  build:
    # permissions:
    #   contents: write
    runs-on: ubuntu-latest
    steps:
      # This is from the GLMakie github action
      # - run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev xsettingsd x11-xserver-utils
      - uses: actions/checkout@v3
      - uses: awalsh128/cache-apt-pkgs-action@latest
        with:
          packages: xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev xsettingsd x11-xserver-utils
      - uses: julia-actions/setup-julia@latest
        with:
          version: '1.9'
      - uses: julia-actions/cache@v1
        with:
          # cache-name: master-docs
          # WARNING: cache-registries is actually slower for Windows runners
          cache-registries: "true"
          # WARNING: cache-compiled can break with certain choices of OS and architecture.
          # see https://github.com/julia-actions/cache/issues/11
          cache-compiled: "true"
      # the following line goes below after using Pkg 
      # Pkg.develop([PackageSpec(url="https://github.com/esabo/RamanujanGraphs.jl"), PackageSpec(path=pwd())])
      - name: Install dependencies
        run: |
          DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs/ -e '
            using Pkg
            Pkg.develop([PackageSpec(path=pwd())])
            Pkg.instantiate()'
      - name: Build and deploy
        env:
          GITHUB_TOKEN: ${{ secrets.Docs }}
        run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs/ docs/make.jl
      #   run: julia --project=docs/ --code-coverage=user docs/make.jl
      # - uses: julia-actions/julia-processcoverage@v1
      # - uses: codecov/codecov-action@v1