Merge pull request #271 from altheaden/reorganize-templates #101
This file contains hidden or 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: [main] | |
| release: | |
| types: [published] | |
| env: | |
| PYTHON_VERSION: "3.13" | |
| 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 | |
| - if: ${{ steps.skip_check.outputs.should_skip != 'true' }} | |
| name: Set up Conda Environment | |
| uses: mamba-org/setup-micromamba@v2 | |
| with: | |
| environment-name: mache_dev | |
| init-shell: bash | |
| condarc: | | |
| channel_priority: strict | |
| channels: | |
| - conda-forge | |
| create-args: >- | |
| python=${{ env.PYTHON_VERSION }} | |
| - if: ${{ steps.skip_check.outputs.should_skip != 'true' }} | |
| name: Install mache | |
| run: | | |
| git config --global url."https://github.com/".insteadOf "[email protected]:" | |
| conda install -y --file spec-file.txt \ | |
| python=${{ env.PYTHON_VERSION }} | |
| python -m pip install -vv --no-deps --no-build-isolation -e . | |
| - name: Build Sphinx Docs | |
| run: | | |
| set -e | |
| cd docs | |
| DOCS_VERSION=${{ github.ref_name }} make versioned-html | |
| - name: Copy Docs and Commit | |
| run: | | |
| set -e | |
| cd docs | |
| # gh-pages branch must already exist | |
| git clone https://github.com/E3SM-Project/mache.git --branch gh-pages --single-branch gh-pages | |
| # Only replace docs in a directory with the destination branch name with latest changes. Docs for | |
| # releases should be untouched. | |
| rm -rf gh-pages/${{ github.ref_name }} | |
| # don't clobber existing release versions (in case we retroactively fixed them) | |
| cp -r _build/html/${{ github.ref_name }} gh-pages/ | |
| mkdir -p gh-pages/shared | |
| cp shared/version-switcher.js gh-pages/shared/version-switcher.js | |
| # Update the list of versions with all versions in the gh-pages directory. | |
| python generate_versions_json.py | |
| # 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 `main` branch automatically. | |
| printf '<meta http-equiv="refresh" content="0; url=./main/index.html" />' > index.html | |
| # Only replace `main` docs with latest changes. Docs for releases should be untouched. | |
| rm -rf main | |
| # 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: docs/gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| force: true | |