Skip to content
test

Minor fixes to docs #402

Sign in to view logs

Minor fixes to docs

Minor fixes to docs #402

Workflow file for this run

.github/workflows/test.yml at 4de6058
# Run tests and upload to Codecov with GitHub Actions
#
# NOTE: Pin actions to a specific commit to avoid having the authentication
# token stolen if the Action is compromised. See the comments and links here:
# https://github.com/pypa/gh-action-pypi-publish/issues/27
#
name: test
# Only build PRs, the main branch, and releases. Pushes to branches will only
# be built when a PR is opened. This avoids duplicated buids in PRs comming
# from branches in the origin repository (1 for PR and 1 for push).
on:
pull_request:
push:
branches:
- main
release:
types:
- published
# Use bash by default in all jobs
defaults:
run:
# The -l {0} is necessary for conda environments to be activated
# But this breaks on MacOS if using actions/setup-python:
# https://github.com/actions/setup-python/issues/132
shell: bash -l {0}
jobs:
#############################################################################
# Run tests
test:
name: ${{ matrix.os }} python=${{ matrix.python }} dependencies=${{ matrix.dependencies }}
runs-on: ${{ matrix.os }}-latest
strategy:
# Otherwise, the workflow would stop if a single job fails. We want to
# run all of them to catch failures in different combinations.
fail-fast: false
matrix:
os:
- ubuntu
- macos
- windows
dependencies:
- oldest
- latest
- optional
include:
- dependencies: oldest
python: "3.9"
- dependencies: latest
python: "3.12"
- dependencies: optional
python: "3.12"
env:
REQUIREMENTS: env/requirements-build.txt env/requirements-test.txt
# Used to tag codecov submissions
OS: ${{ matrix.os }}
PYTHON: ${{ matrix.python }}
DEPENDENCIES: ${{ matrix.dependencies }}
steps:
# Cancel any previous run of the test job
# We pin the commit hash corresponding to v0.5.0, and not pinning the tag
# because we are giving full access through the github.token.
- name: Cancel Previous Runs
uses: styfle/[email protected]
with:
access_token: ${{ github.token }}
# Checks-out your repository under $GITHUB_WORKSPACE
- name: Checkout
uses: actions/checkout@v4
with:
# Need to fetch more than the last commit so that setuptools-scm can
# create the correct version string. If the number of commits since
# the last release is greater than this, the version still be wrong.
# Increase if necessary.
fetch-depth: 100
# The GitHub token is preserved by default but this job doesn't need
# to be able to push to GitHub.
persist-credentials: false
# Need the tags so that setuptools-scm can form a valid version number
- name: Fetch git tags
run: git fetch origin 'refs/tags/*:refs/tags/*'
- name: Setup Miniconda
uses: conda-incubator/setup-miniconda@v3
with:
python-version: ${{ env.PYTHON }}
channels: conda-forge,defaults
- name: Collect requirements
run: |
echo "Install Dependente to capture dependencies:"
conda install dependente==0.1.0 -c conda-forge
echo ""
echo "Capturing run-time dependencies:"
if [[ "${{ matrix.dependencies }}" == "oldest" ]]; then
dependente --source install --oldest > requirements-full.txt
elif [[ "${{ matrix.dependencies }}" == "optional" ]]; then
dependente --source install,extras > requirements-full.txt
else
dependente --source install > requirements-full.txt
fi
echo "Capturing dependencies from:"
for requirement in $REQUIREMENTS
do
echo " $requirement"
cat $requirement >> requirements-full.txt
done
echo ""
echo "Collected dependencies:"
cat requirements-full.txt
- name: Rename conda-forge packages
run: |
# Choose options to sed based on the OS (macos uses POSIX sed)
if [[ ${{ matrix.os }} == macos ]]; then
opts="-i''"
else
opts='-s --in-place'
fi
echo "OPTS:" $opts
echo "Rename conda-forge packages in requirements-full.txt"
# Replace "build" for "python-build"
sed $opts 's/^build$/python-build/' requirements-full.txt
echo "Renamed dependencies:"
cat requirements-full.txt
- name: Install requirements
run: conda install --quiet --file requirements-full.txt python=$PYTHON
- name: List installed packages
run: conda list
- name: Build source and wheel distributions
run: |
make build
echo ""
echo "Generated files:"
ls -lh dist/
- name: Install the package
run: python -m pip install --no-deps dist/*.whl
- name: Copy test data to the cache
run: |
echo "Copy data to " ${VERDE_DATA_DIR}/main
set -x -e
mkdir -p ${VERDE_DATA_DIR}/main
cp -r data/* ${VERDE_DATA_DIR}/main
env:
# Define directory where sample data will be copied
VERDE_DATA_DIR: ${{ runner.temp }}/cache/verde
- name: Run the tests
run: |
make test
env:
# Define directory where sample data have been copied
VERDE_DATA_DIR: ${{ runner.temp }}/cache/verde
- name: Convert coverage report to XML for codecov
run: coverage xml
- name: Upload coverage report as an artifact
uses: actions/upload-artifact@v4
with:
name: coverage_${{ matrix.os }}_${{ matrix.dependencies }}
path: ./coverage.xml
#############################################################################
# Upload coverage report to codecov
codecov-upload:
runs-on: ubuntu-latest
needs: test
steps:
- name: Download coverage report artifacts
# Download coverage reports from every runner.
# Maximum coverage is achieved by combining reports from every runner.
# Each coverage file will live in its own folder with the same name as
# the artifact.
uses: actions/download-artifact@v4
with:
pattern: coverage_*
- name: List all downloaded artifacts
run: ls -l -R .
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v5
with:
# Upload all coverage report files
files: ./coverage_*/coverage.xml
# Fail the job so we know coverage isn't being updated. Otherwise it
# can silently drop and we won't know.
fail_ci_if_error: true
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}