Skip to content
CI/CD Build Workflow

Improve tests #510

Sign in to view logs

Improve tests

Improve tests #510

Workflow file for this run

.github/workflows/build_workflow.yml at d5485cd
name: CI/CD Build Workflow
on:
push:
# When a branch is pushed to GitHub, run this workflow.
# This will show up as the checks to pass on a pull request.
branches: [main]
pull_request:
# When a pull request is merged, run this workflow.
branches: [main]
# These are the 3 jobs that show up under "All checks have passed" on GitHub.
jobs:
pre-commit-hooks:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- name: Checkout Code Repository
uses: actions/checkout@v3
- name: Set up Python 3.13
uses: actions/setup-python@v4
with:
python-version: "3.13"
# Run all pre-commit hooks on all the files.
# Getting only staged files can be tricky in case a new PR is opened
# since the action is run on a branch in detached head state.
# This is the equivalent of running "pre-commit run --all-files" locally.
# If you commit with the `--no-verify` flag, this check may fail.
- name: Install and Run Pre-commit
uses: pre-commit/[email protected]
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.11", "3.12", "3.13"]
defaults:
run:
shell: bash -l {0}
timeout-minutes: 20
steps:
- uses: actions/checkout@v3
- name: Cache Conda
uses: actions/cache@v3
env:
CACHE_NUMBER: 1 # Increment this to invalidate cache
with:
path: ~/conda_pkgs_dir
key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{
hashFiles('conda/dev.yml') }}-python${{ matrix.python-version }}
- name: Build Conda Environment
uses: conda-incubator/setup-miniconda@v3
with:
activate-environment: zstash_dev
miniforge-variant: Miniforge3
miniforge-version: latest
environment-file: conda/dev.yml
channel-priority: flexible # Changed from strict to flexible
auto-update-conda: true
python-version: ${{ matrix.python-version }}
channels: conda-forge
use-only-tar-bz2: true
- name: Verify Environment and Fix Dependencies
run: |
conda info
conda list
# Ensure we have the right Python version
python --version
# Fix pip issues for Python 3.12+
if [[ "${{ matrix.python-version }}" == "3.12" ]] || [[ "${{ matrix.python-version }}" == "3.13" ]]; then
python -m ensurepip --upgrade || true
python -m pip install --upgrade --force-reinstall pip setuptools wheel
fi
- name: Install `zstash` Package
run: |
python -m pip install .
- name: Run Tests
run: |
python -m unittest tests/test_*.py
# Build documentation on all PRs and pushes; only publish (commit to gh-pages) on pushes.
build-docs:
needs: [pre-commit-hooks, build]
runs-on: ubuntu-latest
defaults:
run:
shell: bash -l {0}
timeout-minutes: 10 # Increased timeout for docs
steps:
- uses: actions/checkout@v3
with:
persist-credentials: false
fetch-depth: 0
- name: Cache Conda
uses: actions/cache@v3
env:
CACHE_NUMBER: 1 # Match the build job cache number
with:
path: ~/conda_pkgs_dir
key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{
hashFiles('conda/dev.yml') }}-docs
- name: Build Conda Environment
uses: conda-incubator/setup-miniconda@v3
with:
activate-environment: zstash_dev
miniforge-variant: Miniforge3
miniforge-version: latest
environment-file: conda/dev.yml
channel-priority: flexible # Changed from strict to flexible
auto-update-conda: true
python-version: "3.13" # Use stable Python version for docs
# sphinx-multiversion allows for version docs.
- name: Build Sphinx Docs
run: |
cd docs
sphinx-multiversion source _build/html
- name: Copy Docs and Commit
if: github.event_name == 'push'
run: |
# gh-pages branch must already exist
git clone https://github.com/E3SM-Project/zstash.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=./_build/html/main/index.html" />' > index.html
# Only replace `main` docs with latest changes. Docs for tags should be untouched.
rm -rf _build/html/main
mkdir -p _build/html/main
cp -r ../docs/_build/html/main _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 below command will fail if no changes were present, so we ignore it
git add .
git commit -m "Update documentation" -a || true
- name: Push Changes
if: github.event_name == 'push'
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
force: true