Merge pull request #590 from cbegeman/add-bsf-function #5
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: CI/CD Release Workflow | |
| on: | |
| push: | |
| branches: | |
| - master | |
| release: | |
| types: [published] | |
| jobs: | |
| publish-docs: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| timeout-minutes: 20 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| fetch-depth: 0 | |
| - name: Cache Conda | |
| uses: actions/cache@v4 | |
| env: | |
| # Increase this value to reset cache if dev-spec and setup.py have not changed in the workflow | |
| CACHE_NUMBER: 0 | |
| with: | |
| path: ~/conda_pkgs_dir | |
| key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{ | |
| hashFiles('conda_package/dev-spec.txt,conda_package/setup.py') }} | |
| - if: ${{ steps.skip_check.outputs.should_skip != 'true' }} | |
| name: Set up Conda Environment | |
| uses: conda-incubator/setup-miniconda@v3 | |
| with: | |
| activate-environment: "mpas_tools_ci" | |
| miniforge-version: latest | |
| channels: conda-forge | |
| channel-priority: strict | |
| auto-update-conda: true | |
| python-version: ${{ matrix.python-version }} | |
| - if: ${{ steps.skip_check.outputs.should_skip != 'true' }} | |
| name: Install mpas_tools | |
| run: | | |
| git config --global url."https://github.com/".insteadOf "[email protected]:" | |
| conda create -n mpas_tools_dev --file conda_package/dev-spec.txt | |
| conda activate mpas_tools_dev | |
| python -m pip install -vv --no-deps --no-build-isolation -e conda_package | |
| - name: Build Sphinx Docs | |
| run: | | |
| set -e | |
| cd conda_package/docs | |
| conda activate mpas_tools_dev | |
| sphinx-multiversion . _build/html | |
| - name: Copy Docs and Commit | |
| run: | | |
| set -e | |
| cd conda_package/docs | |
| conda activate mpas_tools_dev | |
| # gh-pages branch must already exist | |
| git clone https://github.com/MPAS-Dev/MPAS-Tools.git --branch gh-pages --single-branch gh-pages | |
| # Make sure we're in the gh-pages directory. | |
| cd gh-pages | |
| # Create `.nojekyll` (if it doesn't already exist) for proper GH Pages configuration. | |
| touch .nojekyll | |
| # Add `index.html` to point to the `master` branch automatically. | |
| printf '<meta http-equiv="refresh" content="0; url=./master/index.html" />' > index.html | |
| # Only replace docs in a directory with the destination branch name with latest changes. Docs for | |
| # releases should be untouched. | |
| rm -rf ${{ github.head_ref || github.ref_name }} | |
| # don't clobber existing release versions (in case we retroactively fixed them) | |
| cp -r -n ../_build/html/* . | |
| # Configure git using GitHub Actions credentials. | |
| git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| git config --local user.name "github-actions[bot]" | |
| # The second command will fail if no changes were present, so we ignore it | |
| git add . | |
| git commit -m "Update documentation" -a || true | |
| - name: Push Changes | |
| uses: ad-m/github-push-action@master | |
| with: | |
| branch: gh-pages | |
| directory: conda_package/docs/gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| force: true | |