add documentation workflow #758
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| tags: '*' | ||
| pull_request: | ||
| jobs: | ||
| build: | ||
| permissions: | ||
| contents: write | ||
| runs-on: ubuntu-latest | ||
| - uses: actions/checkout@v4 | ||
| - uses: julia-actions/setup-julia@v1 | ||
| with: | ||
| version: '1.10' | ||
| - uses: actions/cache@v1 | ||
| env: | ||
| cache-name: cache-artifacts | ||
| with: | ||
| path: ~/.julia/artifacts | ||
| key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-test-${{ env.cache-name }}- | ||
| ${{ runner.os }}-test- | ||
| ${{ runner.os }}- | ||
| - uses: julia-actions/julia-buildpkg@v1 | ||
| - name: Install dependencies | ||
| run: | | ||
| current_path=${{ github.workspace }} | ||
| export JULIA_CONDAPKG_ENV="$current_path/rms_env" | ||
| julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.build("ReactionMechanismSimulator");' | ||
| - name: Build and deploy | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token | ||
| DOCUMENTER_DEBUG: true | ||
| run: | | ||
| current_path=${{ github.workspace }} | ||
| export JULIA_CONDAPKG_ENV="$current_path/rms_env" | ||
| julia --color=yes --project=docs docs/make.jl | ||
