Skip to content

Commit a6c7bdf

Browse files
brian-rosebrian-rose
committed
First commit with workflows from template
0 parents  commit a6c7bdf

File tree

6 files changed

+502
-0
lines changed

6 files changed

+502
-0
lines changed

‎.github/dependabot.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
# - package-ecosystem: pip
4+
# directory: "/"
5+
# schedule:
6+
# interval: daily
7+
- package-ecosystem: 'github-actions'
8+
directory: '/'
9+
schedule:
10+
# Check for updates once a week
11+
interval: 'weekly'

‎.github/workflows/build-book.yaml

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: build-book
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
environment_name:
7+
description: 'Name of conda environment to activate'
8+
required: false
9+
default: 'cookbook-dev'
10+
type: string
11+
environment_file:
12+
description: 'Name of conda environment file'
13+
required: false
14+
default: 'environment.yml'
15+
type: string
16+
path_to_notebooks:
17+
description: 'Location of the JupyterBook source relative to repo root'
18+
required: false
19+
default: './'
20+
type: string
21+
use_cached_environment:
22+
description: 'Flag for whether we should attempt to retrieve a previously cached environment.'
23+
required: false
24+
default: 'true'
25+
type: string # had a lot of trouble with boolean types, see https://github.com/actions/runner/issues/1483
26+
27+
jobs:
28+
build:
29+
runs-on: ubuntu-latest
30+
defaults:
31+
run:
32+
shell: bash -l {0}
33+
steps:
34+
- uses: actions/checkout@v3
35+
36+
- name: Setup Mambaforge
37+
uses: conda-incubator/setup-miniconda@v2
38+
with:
39+
miniforge-variant: Mambaforge
40+
miniforge-version: latest
41+
activate-environment: ${{ inputs.environment_name }}
42+
use-mamba: true
43+
44+
- name: Set cache date
45+
if: ${{ inputs.use_cached_environment == 'true' }}
46+
run: echo "DATE=$(date +'%Y%m%d')" >> $GITHUB_ENV
47+
48+
- uses: actions/cache@v3
49+
if: inputs.use_cached_environment == 'true'
50+
with:
51+
path: /usr/share/miniconda3/envs/${{ inputs.environment_name }}
52+
# This should create a key that looks like 'linux-64-conda-environment.yml-[HASH]-DATE'
53+
# Logic inspired by https://dev.to/epassaro/caching-anaconda-environments-on-github-actions-2d08
54+
key: ${{ format('linux-64-conda-{0}-{1}-{2}', inputs.environment_file, hashFiles(format('{0}', inputs.environment_file)), env.DATE )}}
55+
id: cache
56+
57+
- name: Update environment
58+
if: |
59+
inputs.use_cached_environment != 'true'
60+
|| steps.cache.outputs.cache-hit != 'true'
61+
run: mamba env update -n ${{ inputs.environment_name }} -f ${{ inputs.environment_file }}
62+
63+
- name: Build the book
64+
run: |
65+
jupyter-book build ${{ inputs.path_to_notebooks }}
66+
- name: Zip the book
67+
run: |
68+
set -x
69+
set -e
70+
if [ -f book.zip ]; then
71+
rm -rf book.zip
72+
fi
73+
zip -r book.zip ${{ inputs.path_to_notebooks }}/_build/html
74+
- name: Upload zipped book artifact
75+
uses: actions/upload-artifact@v3
76+
with:
77+
name: book-zip-${{github.event.number}}
78+
path: ./book.zip

‎.github/workflows/link-checker.yaml

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: link-checker
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
environment_name:
7+
description: 'Name of conda environment to activate'
8+
required: false
9+
default: 'cookbook-dev'
10+
type: string
11+
environment_file:
12+
description: 'Name of conda environment file'
13+
required: false
14+
default: 'environment.yml'
15+
type: string
16+
path_to_notebooks:
17+
description: 'Location of the JupyterBook source relative to repo root'
18+
required: false
19+
default: './'
20+
type: string
21+
use_cached_environment:
22+
description: 'Flag for whether we should attempt to retrieve a previously cached environment.'
23+
required: false
24+
default: 'true'
25+
type: string
26+
27+
jobs:
28+
link-checker:
29+
runs-on: ubuntu-latest
30+
defaults:
31+
run:
32+
shell: bash -l {0}
33+
steps:
34+
- name: Cancel previous runs
35+
uses: styfle/[email protected]
36+
with:
37+
access_token: ${{ github.token }}
38+
- uses: actions/checkout@v3
39+
40+
- name: Setup Mambaforge
41+
uses: conda-incubator/setup-miniconda@v2
42+
with:
43+
miniforge-variant: Mambaforge
44+
miniforge-version: latest
45+
activate-environment: ${{ inputs.environment_name }}
46+
use-mamba: true
47+
48+
- name: Set cache date
49+
if: inputs.use_cached_environment == 'true'
50+
run: echo "DATE=$(date +'%Y%m%d')" >> $GITHUB_ENV
51+
52+
- uses: actions/cache@v3
53+
if: inputs.use_cached_environment == 'true'
54+
with:
55+
path: /usr/share/miniconda3/envs/${{ inputs.environment_name }}
56+
# This should create a key that looks like 'linux-64-conda-environment.yml-[HASH]-DATE'
57+
# Logic inspired by https://dev.to/epassaro/caching-anaconda-environments-on-github-actions-2d08
58+
key: ${{ format('linux-64-conda-{0}-{1}-{2}', inputs.environment_file, hashFiles(format('{0}', inputs.environment_file)), env.DATE )}}
59+
id: cache
60+
61+
- name: Update environment
62+
if: |
63+
inputs.use_cached_environment != 'true'
64+
|| steps.cache.outputs.cache-hit != 'true'
65+
run: mamba env update -n ${{ inputs.environment_name }} -f ${{ inputs.environment_file }}
66+
67+
- name: Disable notebook execution
68+
shell: python
69+
run: |
70+
import yaml
71+
with open('${{ inputs.path_to_notebooks }}/_config.yml') as f:
72+
data = yaml.safe_load(f)
73+
data['execute']['execute_notebooks'] = 'off'
74+
with open('${{ inputs.path_to_notebooks }}/_config.yml', 'w') as f:
75+
yaml.dump(data, f)
76+
- name: Check external links
77+
run: |
78+
jupyter-book build --builder linkcheck ${{ inputs.path_to_notebooks }}

‎.gitignore

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
notebooks/_build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
wheels/
24+
pip-wheel-metadata/
25+
share/python-wheels/
26+
*.egg-info/
27+
.installed.cfg
28+
*.egg
29+
MANIFEST
30+
31+
# PyInstaller
32+
# Usually these files are written by a python script from a template
33+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
34+
*.manifest
35+
*.spec
36+
37+
# Installer logs
38+
pip-log.txt
39+
pip-delete-this-directory.txt
40+
41+
# Unit test / coverage reports
42+
htmlcov/
43+
.tox/
44+
.nox/
45+
.coverage
46+
.coverage.*
47+
.cache
48+
nosetests.xml
49+
coverage.xml
50+
*.cover
51+
*.py,cover
52+
.hypothesis/
53+
.pytest_cache/
54+
55+
# Translations
56+
*.mo
57+
*.pot
58+
59+
# Django stuff:
60+
*.log
61+
local_settings.py
62+
db.sqlite3
63+
db.sqlite3-journal
64+
65+
# Flask stuff:
66+
instance/
67+
.webassets-cache
68+
69+
# Scrapy stuff:
70+
.scrapy
71+
72+
# Sphinx documentation
73+
docs/_build/
74+
75+
# PyBuilder
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
.python-version
87+
88+
# pipenv
89+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
90+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
91+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
92+
# install all needed dependencies.
93+
#Pipfile.lock
94+
95+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
96+
__pypackages__/
97+
98+
# Celery stuff
99+
celerybeat-schedule
100+
celerybeat.pid
101+
102+
# SageMath parsed files
103+
*.sage.py
104+
105+
# Environments
106+
.env
107+
.venv
108+
env/
109+
venv/
110+
ENV/
111+
env.bak/
112+
venv.bak/
113+
114+
# Spyder project settings
115+
.spyderproject
116+
.spyproject
117+
118+
# Rope project settings
119+
.ropeproject
120+
121+
# mkdocs documentation
122+
/site
123+
124+
# mypy
125+
.mypy_cache/
126+
.dmypy.json
127+
dmypy.json
128+
129+
# Pyre type checker
130+
.pyre/

0 commit comments

Comments
 (0)