Skip to content

Commit

Permalink
Separate docs/test yml
Browse files Browse the repository at this point in the history
  • Loading branch information
andgoldschmidt committed May 6, 2023
1 parent b9ceb32 commit 9583097
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 54 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/pull-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Docs

on: [pull_request]

jobs:
docs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [ "3.7" ]
poetry-version: [ "1.2.1" ]
steps:
# ======
# Checkout, set up python
# ======
- name: Check out
uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
# ======
# Install and configure poetry from cache
# ======
- name: Load cached Poetry installation
id: cached-poetry
uses: actions/cache@v3
with:
path: ~/.local # the path depends on the OS
key: poetry-${{ matrix.poetry-version }}
# ======
# Load cached venv if cache exists
# Install dependencies if cache does not exist
# ======
- name: Load cached venv
id: cached-poetry-dependencies-docs
uses: actions/cache@v3
with:
path: .venv
key: docs-${{ matrix.python-version }}-${{ matrix.poetry-version }}-${{ hashFiles('**/poetry.lock') }}
- name: Install dependencies
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: poetry install --no-interaction --no-root -E docs
# ======
# Install Pandoc
# ======
- name: Use pandoc (external to Poetry)
uses: nikeee/setup-pandoc@v1
# uses: docker://pandoc/latex:2.9
- run: pip install pandoc
# ======
# Run test suite
# ======
- name: Make docs
run: poetry run sphinx-build docs docs/_build
57 changes: 3 additions & 54 deletions .github/workflows/push-test.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: Test

# Overlap if PR is from the same repo, but pull_request is nec. for forks, etc.
# Push/pull overlap if PR is from the same repo,
# but pull_request is nec. for forks, etc.
on: [push, pull_request]

jobs:
Expand Down Expand Up @@ -56,56 +57,4 @@ jobs:
# https://github.com/marketplace/actions/install-poetry-action#codecov-upload
# ======
- name: Run tests
run: poetry run pytest

docs:
runs-on: ubuntu-latest
needs: [ test ]
strategy:
matrix:
python-version: [ "3.7" ]
poetry-version: [ "1.2.1" ]
steps:
# ======
# Checkout, set up python
# ======
- name: Check out
uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
# ======
# Install and configure poetry from cache
# ======
- name: Load cached Poetry installation
id: cached-poetry
uses: actions/cache@v3
with:
path: ~/.local # the path depends on the OS
key: poetry-${{ matrix.poetry-version }}
# ======
# Load cached venv if cache exists
# Install dependencies if cache does not exist
# ======
- name: Load cached venv
id: cached-poetry-dependencies-docs
uses: actions/cache@v3
with:
path: .venv
key: docs-${{ matrix.python-version }}-${{ matrix.poetry-version }}-${{ hashFiles('**/poetry.lock') }}
- name: Install dependencies
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: poetry install --no-interaction --no-root -E docs
# ======
# Install Pandoc
# ======
- name: Use pandoc (external to Poetry)
uses: nikeee/setup-pandoc@v1
# uses: docker://pandoc/latex:2.9
- run: pip install pandoc
# ======
# Run test suite
# ======
- name: Make docs
run: poetry run sphinx-build docs docs/_build
run: poetry run pytest

0 comments on commit 9583097

Please sign in to comment.