Skip to content

Bump pypa/gh-action-pypi-publish from 1.8.12 to 1.9.0 #200

Bump pypa/gh-action-pypi-publish from 1.8.12 to 1.9.0

Bump pypa/gh-action-pypi-publish from 1.8.12 to 1.9.0 #200

Workflow file for this run

# This workflow install sphinx_gmt, and build documentation (i.e., running tests)
name: Tests
on:
push:
branches: [main]
pull_request:
release:
types:
- published
jobs:
style_check:
name: Style Checks
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4.1.6
- name: Set up Python
uses: actions/setup-python@v5.1.0
with:
python-version: 3.9
- name: Install pacakges
run: pip install sphinx black pylint
- name: Formatting check (black and pylint)
run: make check
test:
name: ${{ matrix.os }} - Python ${{ matrix.python-version }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
python-version: ['3.8', '3.10']
os: [ubuntu-latest, macOS-latest, windows-latest]
defaults:
run:
shell: bash -l {0}
steps:
# Cancel previous runs that are not completed
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.12.0
with:
access_token: ${{ github.token }}
- name: Checkout
uses: actions/checkout@v4.1.6
with:
# fecth all history so that setuptools_scm works
fetch-depth: 0
# Install Mambaforge with conda-forge dependencies
- name: Setup Mambaforge
uses: conda-incubator/setup-miniconda@v3.0.1
with:
activate-environment: sphinx_gmt
python-version: ${{ matrix.python-version }}
channels: conda-forge,nodefaults
channel-priority: strict
miniforge-version: latest
miniforge-variant: Mambaforge
mamba-version: "*"
use-mamba: true
# Install GMT and other required dependencies from conda-forge
- name: Install GMT and required dependencies
run: |
mamba install --yes gmt jinja2 sphinx sphinx_rtd_theme build
# Show installed pkg information for postmortem diagnostic
- name: List installed packages
run: mamba list
# Install the package that we want to test
- name: Install the package
run: |
python -m build --sdist
pip install dist/*
# Build the documentation
- name: Build the documentation
run: make -C doc clean all
- name: Checkout the gh-pages branch
uses: actions/checkout@v4.1.6
with:
ref: gh-pages
# Checkout to this folder instead of the current one
path: deploy
# Download the entire history
fetch-depth: 0
if: (github.event_name == 'release' || github.event_name == 'push') && (matrix.os == 'ubuntu-latest') && (matrix.python-version == '3.10')
- name: Push the built HTML to gh-pages
run: |
# Detect if this is a release or from the main branch
if [[ "${GITHUB_EVENT_NAME}" == "release" ]]; then
# Get the tag name without the "refs/tags/" part
version="${GITHUB_REF#refs/*/}"
else
version=dev
fi
echo "Deploying version: $version"
# Make the new commit message. Needs to happen before cd into deploy
# to get the right commit hash.
message="Deploy $version from $(git rev-parse --short HEAD)"
cd deploy
# Need to have this file so that Github doesn't try to run Jekyll
touch .nojekyll
# Delete all the files and replace with our new set
echo -e "\nRemoving old files from previous builds of ${version}:"
rm -rvf ${version}
echo -e "\nCopying HTML files to ${version}:"
cp -Rvf ../doc/_build/html/ ${version}/
# If this is a new release, update the link from /latest to it
if [[ "${version}" != "dev" ]]; then
echo -e "\nSetup link from ${version} to 'latest'."
rm -f latest
ln -sf ${version} latest
fi
# Stage the commit
git add -A .
echo -e "\nChanges to be applied:"
git status
# Configure git to be the GitHub Actions account
git config user.email "github-actions[bot]@users.noreply.github.com"
git config user.name "github-actions[bot]"
# If this is a dev build and the last commit was from a dev build
# (detect if "dev" was in the previous commit message), reuse the
# same commit
if [[ "${version}" == "dev" && `git log -1 --format='%s'` == *"dev"* ]]; then
echo -e "\nAmending last commit:"
git commit --amend --reset-author -m "$message"
else
echo -e "\nMaking a new commit:"
git commit -m "$message"
fi
# Make the push quiet just in case there is anything that could leak
# sensitive information.
echo -e "\nPushing changes to gh-pages."
git push -fq origin gh-pages 2>&1 >/dev/null
echo -e "\nFinished uploading generated files."
if: (github.event_name == 'release' || github.event_name == 'push') && (matrix.os == 'ubuntu-latest') && (matrix.python-version == '3.10')