Skip to content

Merge pull request #714 from xylar/fix-mamba-1.5.1-issue #136

Merge pull request #714 from xylar/fix-mamba-1.5.1-issue

Merge pull request #714 from xylar/fix-mamba-1.5.1-issue #136

Workflow file for this run

name: CI/CD Release Workflow
on:
push:
branches: [main, legacy]
release:
types: [published]
jobs:
publish-docs:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -l {0}
env:
docs_version: "latest"
timeout-minutes: 20
steps:
- uses: actions/checkout@v3
with:
persist-credentials: false
fetch-depth: 0
- name: Cache Conda
uses: actions/cache@v3
env:
# Increase this value to reset cache if deploy/conda-dev-spec.template has not changed in the workflow
CACHE_NUMBER: 0
with:
path: ~/conda_pkgs_dir
key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{
hashFiles('conda/configure_compass_env.py,conda/*,conda/compass_env/*') }}
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
name: Set up Conda Environment
uses: conda-incubator/setup-miniconda@v2
with:
activate-environment: "compass_ci"
miniforge-variant: Mambaforge
miniforge-version: latest
use-mamba: true
mamba-version: "*"
channels: conda-forge,e3sm/label/compass,defaults
channel-priority: strict
auto-update-conda: true
python-version: ${{ matrix.python-version }}
- if: ${{ steps.skip_check.outputs.should_skip != 'true' }}
name: Install compass
run: |
./conda/configure_compass_env.py \
--env_only \
--env_name compass_test \
--python=${{ matrix.python-version }} \
--verbose
source load_compass_test.sh
- name: Build Sphinx Docs
run: |
source load_compass_test.sh
cd docs
if [[ $GITHUB_REF_NAME == "main" ]]; then
export DOCS_VERSION="latest"
else
export DOCS_VERSION=${GITHUB_REF_NAME}
fi
echo "Docs version: $DOCS_VERSION"
echo "docs_version=$DOCS_VERSION" >> $GITHUB_ENV
make html
- name: Copy Docs and Commit
run: |
source load_compass_test.sh
cd docs
# gh-pages branch must already exist
git clone https://github.com/MPAS-Dev/compass.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 `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.
export DOCS_VERSION="${{ env.docs_version }}"
rm -rf ${DOCS_VERSION}
mkdir ${DOCS_VERSION}
cp -r ../_build/html/* ${DOCS_VERSION}
# 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