Tutorial directives (#195) #1432
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: build_and_publish_docs | |
| on: | |
| push: | |
| branches: | |
| - dev | |
| - test/** | |
| pull_request: | |
| branches: | |
| - dev | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: ${{ github.ref != 'refs/heads/dev' }} | |
| jobs: | |
| publish: | |
| name: build and publish docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: set up python 3.9 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.9 | |
| - name: Build images | |
| run: | | |
| docker-compose up -d | |
| - uses: r-lib/actions/setup-pandoc@v2 | |
| with: | |
| pandoc-version: '3.1.6' | |
| - name: install dependencies | |
| run: | | |
| make venv | |
| - name: build documentation | |
| run: | | |
| make doc | |
| - name: remove jekyll theming | |
| run: touch docs/build/.nojekyll | |
| - name: save branch name without slashes | |
| if: ${{ github.ref != 'refs/heads/dev' }} | |
| env: | |
| BRANCH_NAME: ${{ github.head_ref || github.ref_name }} | |
| run: | | |
| BRANCH_NAME=${{ env.BRANCH_NAME }} | |
| BRANCH_NAME=${BRANCH_NAME////_} | |
| echo BRANCH_NAME=${BRANCH_NAME} >> $GITHUB_ENV | |
| - name: save artifact | |
| if: ${{ github.ref != 'refs/heads/dev' }} | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: ${{ format('github-pages-for-branch-{0}', env.BRANCH_NAME) }} | |
| path: docs/build/ | |
| retention-days: 3 | |
| - name: deploy website | |
| if: ${{ github.ref == 'refs/heads/dev' }} | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: docs/build/ | |
| single-commit: True |