Doc patch #561
Workflow file for this run
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: | |
| # manual trigger | |
| workflow_dispatch: | |
| # trigger from an other action | |
| repository_dispatch: | |
| types: [trigger-docu] | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'docs/**' | |
| - 'README.md' | |
| - '.github/workflows/Documentation.yml' | |
| tags: | |
| - '*' | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "Check out repository" | |
| uses: actions/checkout@v4 | |
| - name: "Set up Julia" | |
| uses: julia-actions/setup-julia@v2 | |
| with: | |
| version: '1' | |
| arch: x64 | |
| - name: "Copy examples, readme" | |
| env: | |
| WORK_TREE: './docs/src/examples' | |
| SRC_BRANCH: 'origin/examples' | |
| SRC_FOLDER_PATH: 'examples/src' | |
| # copy the examples from the examples branch (.md, .svg) and copy the readme in the docs folder | |
| run: | | |
| git fetch | |
| git --work-tree=$WORK_TREE/.. checkout $SRC_BRANCH -- $SRC_FOLDER_PATH/*.md $SRC_FOLDER_PATH/*.svg | |
| mv $WORK_TREE/src/* $WORK_TREE | |
| rm -r $WORK_TREE/src | |
| cp ./README.md ./docs/src/index.md | |
| - 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 }} # For authentication with GitHub Actions token | |
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key | |
| run: julia --project=docs/ docs/make.jl |