Documenter.yml (1716B)
1 # Sample workflow for building and deploying a VitePress site to GitHub Pages 2 3 name: Documenter 4 5 on: 6 # Runs on pushes targeting the `master` branch. Change this to `main` if you're 7 # using the `main` branch as the default branch. 8 push: 9 branches: 10 - master 11 tags: ['*'] 12 pull_request: 13 14 # Allows you to run this workflow manually from the Actions tab 15 workflow_dispatch: 16 17 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages 18 permissions: 19 contents: write 20 pages: write 21 id-token: write 22 statuses: write 23 24 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. 25 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. 26 concurrency: 27 group: pages 28 cancel-in-progress: false 29 30 jobs: 31 # Build job 32 build: 33 runs-on: ubuntu-latest 34 steps: 35 - name: Checkout 36 uses: actions/checkout@v4 37 - name: Setup Julia 38 uses: julia-actions/setup-julia@v1 39 - name: Pull Julia cache 40 uses: julia-actions/cache@v1 41 - name: Install documentation dependencies 42 run: julia --project=docs -e 'using Pkg; pkg"dev ."; Pkg.instantiate(); Pkg.precompile(); Pkg.status()' 43 #- name: Creating new mds from src 44 - name: Build and deploy docs 45 uses: julia-actions/julia-docdeploy@v1 46 env: 47 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token 48 DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key 49 GKSwstype: "100" # for Plots.jl plots (if you have them) 50 JULIA_DEBUG: "Documenter" 51 DATADEPS_ALWAYS_ACCEPT: true