1+ # Sample workflow for building and deploying a VitePress site to GitHub Pages
2+ #
13name : Documentation
24
35on :
6+ # Runs on pushes targeting the `master` branch. Change this to `main` if you're
7+ # using the `main` branch as the default branch.
48 push :
59 branches :
6- - main # update to match your development branch (master, main, dev, trunk, ...)
7- tags : ' *'
10+ - main
11+ tags : [ '*']
812 pull_request :
913
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+
1030jobs :
31+ # Build job
1132 build :
12- permissions :
13- actions : write
14- contents : write
15- pull-requests : read
16- statuses : write
1733 runs-on : ubuntu-latest
1834 steps :
19- - uses : actions/checkout@v4
20- - uses : julia-actions/setup-julia@v2
21- with :
22- version : ' 1'
23- - uses : julia-actions/cache@v2
24- - name : Install dependencies
25- run : julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
26- - name : Build and deploy
35+ - name : Checkout
36+ uses : actions/checkout@v4
37+ - name : Setup Julia
38+ uses : julia-actions/setup-julia@v2
39+ - name : Pull Julia cache
40+ uses : julia-actions/cache@v2
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
2746 env :
28- GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
29- DOCUMENTER_KEY : ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
30- run : julia --project=docs/ docs/make.jl
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
52+
53+
54+
55+
56+
57+
58+
59+
60+ # ------------------------------------------------------------------------------------------#
61+ # This is a workflow for Documenter.jl CI file #
62+ # ------------------------------------------------------------------------------------------#
63+ # name: Documentation
64+
65+ # on:
66+ # push:
67+ # branches:
68+ # - main # update to match your development branch (master, main, dev, trunk, ...)
69+ # tags: '*'
70+ # pull_request:
71+
72+ # jobs:
73+ # build:
74+ # permissions:
75+ # actions: write
76+ # contents: write
77+ # pull-requests: read
78+ # statuses: write
79+ # runs-on: ubuntu-latest
80+ # steps:
81+ # - uses: actions/checkout@v4
82+ # - uses: julia-actions/setup-julia@v2
83+ # with:
84+ # version: '1'
85+ # - uses: julia-actions/cache@v2
86+ # - name: Install dependencies
87+ # run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
88+ # - name: Build and deploy
89+ # env:
90+ # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
91+ # DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
92+ # run: julia --project=docs/ docs/make.jl
93+ # ------------------------------------------------------------------------------------------#
0 commit comments