Interactive sessions on BluePebble for users from Maths #91
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 deploy HTML documentation | |
| on: | |
| push: | |
| pull_request: | |
| types: | |
| - opened | |
| - synchronize | |
| - reopened | |
| permissions: {} | |
| jobs: | |
| build: | |
| name: Build HTML documentation | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: bash | |
| env: | |
| # Use conda run to run commands in an environment. Each job step runs in a | |
| # separate process, so cannot use conda activate to work in an environment | |
| CONDA_RUN: conda run --name HPC-community-docs-env | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| # Miniconda is pre-installed in GitHub-hosted Ubuntu 20.04 runner | |
| # https://github.com/actions/virtual-environments/blob/ubuntu20/20220330.0/images/linux/Ubuntu2004-Readme.md | |
| - name: Create Conda environment | |
| run: conda env create --file environment.yml | |
| # The -W --keep-going flags cause sphinx-build warnings to become errors, | |
| # but allow the build to run to completion. Builds with warnings exit with | |
| # exit status 1. | |
| - name: Build documentation | |
| run: ${{ env.CONDA_RUN }} sphinx-build -M html source build -W --keep-going | |
| # Uploaded artifacts are dynamically zipped when accessed through GitHub UI | |
| # so we do not need to zip them beforehand (this would "double zip" the result) | |
| # https://github.com/marketplace/actions/upload-a-build-artifact#zipped-artifact-downloads | |
| - name: Upload built HTML documentation artifact | |
| if: always() | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: built-html-docs | |
| path: build/html/ | |
| if-no-files-found: error | |
| deploy: | |
| name: Deploy HTML documentation to publishing source | |
| needs: [build] | |
| permissions: | |
| contents: write | |
| # Deployment should only happen on main branch of official repository | |
| if: > | |
| github.repository == 'ACRC/HPC-community-docs' && | |
| github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Download built HTML documentation artifact | |
| id: download | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: built-html-docs | |
| path: _built-html-docs | |
| # A .nojekyll file is required in the root of the publishing source to | |
| # prevent GitHub adding an automatic Jekyll build step to deployment | |
| # https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#static-site-generators | |
| - name: Create .nojekyll | |
| run: touch ${{ steps.download.outputs.download-path }}/.nojekyll | |
| # Copy humans.txt directly into the directory to deploy, since this is | |
| # linked to as an external URL in the documentation | |
| - name: Copy current humans.txt | |
| run: cp -v -n humans.txt ${{ steps.download.outputs.download-path }}/ | |
| - name: Deploy to publishing-source branch | |
| uses: JamesIves/[email protected] | |
| with: | |
| branch: publishing-source | |
| folder: ${{ steps.download.outputs.download-path }} | |
| token: ${{ secrets.GITHUB_TOKEN }} |