Skip to content

Surfit

Surfit #269

Workflow file for this run

name: QualityControl
on:
pull_request:
branches:
- main
jobs:
quality-control:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -l {0}
steps:
- uses: actions/checkout@v3
- uses: ./.github/actions/setupconda
- name: Install NB-Clean
run: |
pip install nb-clean==2.0.2
- name: Ensure clean notebooks
run: |
python .github/workflows/ensure_clean_notebooks.py
# NOTE: this isn't a comprehensive spellcheck, just common typos
- name: Spellcheck
if: always()
uses: codespell-project/actions-codespell@v2
with:
check_filenames: true
skip: '*.js,qaqc.yml,acp_lidar_box.geojson'
ignore_words_file: .codespellignore
only_warn: 1
# borrowed from https://github.com/ProjectPythia/pythia-foundations/blob/main/.github/workflows/link-checker.yaml
- name: Disable Notebook Execution Before Linkcheck
if: always()
shell: python
run: |
import yaml
with open('./book/_config.yml') as f:
data = yaml.safe_load(f)
data['execute']['execute_notebooks'] = 'off'
with open('./book/_config.yml', 'w') as f:
yaml.dump(data, f)
- name: Check External Links
continue-on-error: true
timeout-minutes: 5
if: always()
run: |
jb build book --builder linkcheck