documentation.yml

# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Documentation

on:
  # Runs on pushes targeting the `master` branch. Change this to `main` if you're
  # using the `main` branch as the default branch.
  push:
    branches:
      - main
    tags: ['*']
  pull_request:

  # 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: write
  pages: write
  id-token: write
  statuses: 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:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Julia
        uses: julia-actions/setup-julia@v2
      - name: Pull Julia cache
        uses: julia-actions/cache@v2
      - name: Install documentation dependencies
        run: julia --project=docs -e 'using Pkg; pkg"dev ."; Pkg.instantiate(); Pkg.precompile(); Pkg.status()'
      #- name: Creating new mds from src
      - name: Build and deploy docs
        uses: julia-actions/julia-docdeploy@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
          GKSwstype: "100" # for Plots.jl plots (if you have them)
          JULIA_DEBUG: "Documenter"
          DATADEPS_ALWAYS_ACCEPT: true








#------------------------------------------------------------------------------------------#
# This is a workflow for Documenter.jl CI file                                             #
#------------------------------------------------------------------------------------------#
# name: Documentation

# on:
#   push:
#     branches:
#       - main # update to match your development branch (master, main, dev, trunk, ...)
#     tags: '*'
#   pull_request:

# jobs:
#   build:
#     permissions:
#       actions: write
#       contents: write
#       pull-requests: read
#       statuses: write
#     runs-on: ubuntu-latest
#     steps:
#       - uses: actions/checkout@v4
#       - uses: julia-actions/setup-julia@v2
#         with:
#           version: '1'
#       - uses: julia-actions/cache@v2
#       - name: Install dependencies
#         run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
#       - name: Build and deploy
#         env:
#           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
#           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
#         run: julia --project=docs/ docs/make.jl
#------------------------------------------------------------------------------------------#