Clean up repository for release. (#142) #44
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
| # ------------------------------------------------------------------------------ | |
| # (c) Crown copyright 2023 Met Office. All rights reserved. | |
| # The file LICENCE, distributed with this code, contains details of the terms | |
| # under which the code may be used. | |
| # ------------------------------------------------------------------------------ | |
| name: Deploy Docs | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: [ main ] | |
| paths: | |
| - 'src/**.h' | |
| - 'src/**.cpp' | |
| - 'documentation/**' | |
| - '.github/workflows/documentation.yml' | |
| env: | |
| # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.) | |
| BUILD_TYPE: Release | |
| CXX_COMPILER: /usr/bin/g++-11 | |
| C_COMPILER: /usr/bin/gcc-11 | |
| Fortran_COMPILER: /usr/bin/gfortran-11 | |
| defaults: | |
| run: | |
| shell: bash | |
| jobs: | |
| build: | |
| # The CMake configure and build commands are platform agnostic and should work equally well on Windows or Mac. | |
| # You can convert this to a matrix build if you need cross-platform coverage. | |
| # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix | |
| runs-on: ubuntu-22.04 | |
| environment: | |
| name: github-pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| - name: Install required tools | |
| # Install doxygen, sphinx, rtd theme | |
| run: | | |
| conda create --name vernier-env --file ${{ github.workspace }}/etc/conda/vernier-env.lock | |
| sudo apt update | |
| sudo apt -y install doxygen graphviz | |
| sudo apt -y install mpich | |
| - name: Configure CMake | |
| # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make. | |
| # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type | |
| run: | | |
| eval "$(conda shell.bash hook)" | |
| conda activate vernier-env | |
| cmake -B ${{ github.workspace }}/build \ | |
| -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \ | |
| -DCMAKE_CXX_COMPILER=${{ env.CXX_COMPILER }} \ | |
| -DCMAKE_C_COMPILER=${{ env.C_COMPILER }} \ | |
| -DCMAKE_Fortran_COMPILER=${{ env.Fortran_COMPILER }} \ | |
| -DBUILD_TESTS=OFF | |
| - name: Build docs | |
| # Build your program with the given configuration | |
| run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} --target sphinxdocs 2>/dev/null | |
| # Update the permissions and upload and deploy page | |
| - name: Update permissions | |
| run: | | |
| chmod -c -R +rX "${{github.workspace}}/build/sphinx/" | |
| - name: Upload artifact | |
| id: upload | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| name: github-pages | |
| path: ${{github.workspace}}/build/sphinx | |
| retention-days: 1 | |
| - name: Setup Pages | |
| id: configure | |
| uses: actions/configure-pages@v4 | |
| - name: Deploy | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |