Skip to content

Commit 2c42e29

Browse files
mmckymmcky
committed
Initial setup of GitHub actions + Lecture Transfer
1 parent b1749c3 commit 2c42e29

222 files changed

Lines changed: 56971 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/.DS_Store‎

6 KB
Binary file not shown.

‎.github/workflows/cache.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Build Cache [using jupyter-book]
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
tests:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v2
12+
- name: Setup Anaconda
13+
uses: conda-incubator/setup-miniconda@v2
14+
with:
15+
auto-update-conda: true
16+
auto-activate-base: true
17+
miniconda-version: 'latest'
18+
python-version: 3.9
19+
environment-file: environment.yml
20+
activate-environment: quantecon
21+
- name: Install latex dependencies
22+
run: |
23+
sudo apt-get -qq update
24+
sudo apt-get install -y \
25+
texlive-latex-recommended \
26+
texlive-latex-extra \
27+
texlive-fonts-recommended \
28+
texlive-fonts-extra \
29+
texlive-xetex \
30+
latexmk \
31+
xindy \
32+
dvipng \
33+
cm-super
34+
- name: Build HTML
35+
shell: bash -l {0}
36+
run: |
37+
jb build lectures --path-output ./
38+
- name: Upload "_build" folder (cache)
39+
uses: actions/upload-artifact@v2
40+
with:
41+
name: build-cache
42+
path: _build

‎.github/workflows/ci.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: Build HTML [using jupyter-book]
2+
on: [push]
3+
jobs:
4+
tests:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- name: Checkout
8+
uses: actions/checkout@v2
9+
- name: Setup Anaconda
10+
uses: conda-incubator/setup-miniconda@v2
11+
with:
12+
auto-update-conda: true
13+
auto-activate-base: true
14+
miniconda-version: 'latest'
15+
python-version: 3.9
16+
environment-file: environment.yml
17+
activate-environment: quantecon
18+
- name: Install latex dependencies
19+
run: |
20+
sudo apt-get -qq update
21+
sudo apt-get install -y \
22+
texlive-latex-recommended \
23+
texlive-latex-extra \
24+
texlive-fonts-recommended \
25+
texlive-fonts-extra \
26+
texlive-xetex \
27+
latexmk \
28+
xindy \
29+
dvipng \
30+
cm-super
31+
- name: Display Conda Environment Versions
32+
shell: bash -l {0}
33+
run: conda list
34+
- name: Display Pip Versions
35+
shell: bash -l {0}
36+
run: pip list
37+
- name: Download "build" folder (cache)
38+
uses: dawidd6/action-download-artifact@v2
39+
with:
40+
workflow: cache.yml
41+
branch: main
42+
name: build-cache
43+
path: _build
44+
# Build Assets (Download Notebooks and PDF via LaTeX)
45+
- name: Build PDF from LaTeX
46+
shell: bash -l {0}
47+
run: |
48+
jb build lectures --builder pdflatex --path-output ./ -n --keep-going
49+
mkdir -p _build/html/_pdf
50+
cp -u _build/latex/*.pdf _build/html/_pdf
51+
- name: Build Download Notebooks (sphinx-tojupyter)
52+
shell: bash -l {0}
53+
run: |
54+
jb build lectures --path-output ./ --builder=custom --custom-builder=jupyter
55+
mkdir -p _build/html/_notebooks
56+
cp -u _build/jupyter/*.ipynb _build/html/_notebooks
57+
# Build HTML (Website)
58+
# BUG: rm .doctress to remove `sphinx` rendering issues for ipywidget mimetypes
59+
# and clear the sphinx cache for building final HTML documents.
60+
- name: Build HTML
61+
shell: bash -l {0}
62+
run: |
63+
rm -r _build/.doctrees
64+
jb build lectures --path-output ./
65+
- name: Save Build as Artifact
66+
uses: actions/upload-artifact@v1
67+
with:
68+
name: _build
69+
path: _build
70+
- name: Preview Deploy to Netlify
71+
uses: nwtgck/actions-netlify@v1.1
72+
with:
73+
publish-dir: '_build/html/'
74+
production-branch: master
75+
github-token: ${{ secrets.GITHUB_TOKEN }}
76+
deploy-message: "Preview Deploy from GitHub Actions"
77+
env:
78+
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
79+
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

‎.github/workflows/execution.yml‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
name: Run Execution Tests [Latest Anaconda]
2+
on:
3+
schedule:
4+
# UTC 22:00 is early morning in Australia
5+
- cron: '0 22 * * *'
6+
jobs:
7+
execution-tests-linux:
8+
name: Execution Tests (${{ matrix.python-version }}, ${{ matrix.os }})
9+
runs-on: ${{ matrix.os }}
10+
strategy:
11+
fail-fast: false
12+
matrix:
13+
os: ["ubuntu-latest"]
14+
python-version: ["3.9"]
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v2
18+
- uses: conda-incubator/setup-miniconda@v2
19+
with:
20+
auto-update-conda: true
21+
python-version: ${{ matrix.python-version }}
22+
- name: Install Anaconda + Dependencies
23+
shell: bash -l {0}
24+
run: |
25+
conda install anaconda
26+
pip install jupyter-book sphinx-multitoc-numbering quantecon-book-theme sphinxext-rediraffe sphinx-tojupyter sphinx-exercise
27+
- name: Install latex dependencies
28+
run: |
29+
sudo apt-get -qq update
30+
sudo apt-get install -y \
31+
texlive-latex-recommended \
32+
texlive-latex-extra \
33+
texlive-fonts-recommended \
34+
texlive-fonts-extra \
35+
texlive-xetex \
36+
latexmk \
37+
xindy \
38+
dvipng \
39+
cm-super
40+
- name: Build Lectures (+ Execution Checks)
41+
shell: bash -l {0}
42+
run: jb build lectures --path-output=./ -W --keep-going
43+
- name: Upload Execution Reports
44+
uses: actions/upload-artifact@v2
45+
if: failure()
46+
with:
47+
name: execution-reports
48+
path: _build/html/reports
49+
execution-tests-osx:
50+
name: Execution Tests (${{ matrix.python-version }}, ${{ matrix.os }})
51+
runs-on: ${{ matrix.os }}
52+
strategy:
53+
fail-fast: false
54+
matrix:
55+
os: ["macos-latest"]
56+
python-version: ["3.8"]
57+
steps:
58+
- name: Checkout
59+
uses: actions/checkout@v2
60+
- uses: conda-incubator/setup-miniconda@v2
61+
with:
62+
auto-update-conda: true
63+
python-version: ${{ matrix.python-version }}
64+
- name: Install Anaconda + Dependencies
65+
shell: bash -l {0}
66+
run: |
67+
conda install anaconda
68+
pip install jupyter-book sphinx-multitoc-numbering quantecon-book-theme sphinxext-rediraffe sphinx-tojupyter sphinx-exercise
69+
- name: Install latex dependencies
70+
run: |
71+
brew install texlive
72+
- name: Build Lectures (+ Execution Checks)
73+
shell: bash -l {0}
74+
run: jb build lectures --path-output=./ -W --keep-going
75+
- name: Upload Execution Reports
76+
uses: actions/upload-artifact@v2
77+
if: failure()
78+
with:
79+
name: execution-reports
80+
path: _build/html/reports
81+
# execution-tests-win:
82+
# name: Execution Tests (${{ matrix.python-version }}, ${{ matrix.os }})
83+
# runs-on: ${{ matrix.os }}
84+
# strategy:
85+
# fail-fast: false
86+
# matrix:
87+
# os: ["windows-latest"]
88+
# python-version: ["3.8"]
89+
# steps:
90+
# - name: Checkout
91+
# uses: actions/checkout@v2
92+
# - uses: conda-incubator/setup-miniconda@v2
93+
# with:
94+
# auto-update-conda: true
95+
# python-version: ${{ matrix.python-version }}
96+
# - name: Install Anaconda + Dependencies
97+
# shell: powershell
98+
# run: |
99+
# conda install anaconda
100+
# pip install jupyter-book
101+
# pip install jupyter-book sphinx-multitoc-numbering quantecon-book-theme sphinxext-rediraffe sphinx_tojupyter
102+
# - name: Build Lectures (+ Execution Checks)
103+
# shell: powershell
104+
# run: jb build lectures --path-output=./ -W --keep-going
105+
# - name: Upload Execution Reports
106+
# uses: actions/upload-artifact@v2
107+
# if: failure()
108+
# with:
109+
# name: execution-reports
110+
# path: _build/html/reports

‎.github/workflows/linkcheck.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Link Checker [Anaconda, Linux]
2+
on:
3+
pull_request:
4+
types: [opened, reopened]
5+
schedule:
6+
# UTC 12:00 is early morning in Australia
7+
- cron: '0 12 * * *'
8+
jobs:
9+
link-check-linux:
10+
name: Link Checking (${{ matrix.python-version }}, ${{ matrix.os }})
11+
runs-on: ${{ matrix.os }}
12+
strategy:
13+
fail-fast: false
14+
matrix:
15+
os: ["ubuntu-latest"]
16+
python-version: ["3.9"]
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v2
20+
- name: Setup Anaconda
21+
uses: conda-incubator/setup-miniconda@v2
22+
with:
23+
auto-update-conda: true
24+
auto-activate-base: true
25+
miniconda-version: 'latest'
26+
python-version: 3.9
27+
environment-file: environment.yml
28+
activate-environment: quantecon
29+
- name: Download "build" folder (cache)
30+
uses: dawidd6/action-download-artifact@v2
31+
with:
32+
workflow: cache.yml
33+
branch: main
34+
name: build-cache
35+
path: _build
36+
- name: Link Checker
37+
shell: bash -l {0}
38+
run: jb build lectures --path-output=./ --builder=custom --custom-builder=linkcheck
39+
- name: Upload Link Checker Reports
40+
uses: actions/upload-artifact@v2
41+
if: failure()
42+
with:
43+
name: linkcheck-reports
44+
path: _build/linkcheck

‎.github/workflows/publish.yml‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
name: Build & Publish to GH-PAGES
2+
on:
3+
push:
4+
tags:
5+
- 'publish*'
6+
jobs:
7+
publish:
8+
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout
12+
uses: actions/checkout@v2
13+
- name: Setup Anaconda
14+
uses: conda-incubator/setup-miniconda@v2
15+
with:
16+
auto-update-conda: true
17+
auto-activate-base: true
18+
miniconda-version: 'latest'
19+
python-version: 3.9
20+
environment-file: environment.yml
21+
activate-environment: quantecon
22+
- name: Install latex dependencies
23+
run: |
24+
sudo apt-get -qq update
25+
sudo apt-get install -y \
26+
texlive-latex-recommended \
27+
texlive-latex-extra \
28+
texlive-fonts-recommended \
29+
texlive-fonts-extra \
30+
texlive-xetex \
31+
latexmk \
32+
xindy \
33+
dvipng \
34+
cm-super
35+
- name: Display Conda Environment Versions
36+
shell: bash -l {0}
37+
run: conda list
38+
- name: Display Pip Versions
39+
shell: bash -l {0}
40+
run: pip list
41+
- name: Download "build" folder (cache)
42+
uses: dawidd6/action-download-artifact@v2
43+
with:
44+
workflow: cache.yml
45+
branch: main
46+
name: build-cache
47+
path: _build
48+
# Build Assets (Download Notebooks and PDF via LaTeX)
49+
- name: Build PDF from LaTeX
50+
shell: bash -l {0}
51+
run: |
52+
jb build lectures --builder pdflatex --path-output ./ -n --keep-going
53+
- name: Copy LaTeX PDF for GH-PAGES
54+
shell: bash -l {0}
55+
run: |
56+
mkdir -p _build/html/_pdf
57+
cp -u _build/latex/*.pdf _build/html/_pdf
58+
- name: Build Download Notebooks (sphinx-tojupyter)
59+
shell: bash -l {0}
60+
run: |
61+
jb build lectures --path-output ./ --builder=custom --custom-builder=jupyter
62+
- name: Copy Download Notebooks for GH-PAGES
63+
shell: bash -l {0}
64+
run: |
65+
mkdir -p _build/html/_notebooks
66+
cp -u _build/jupyter/*.ipynb _build/html/_notebooks
67+
# Build HTML (Website)
68+
# BUG: rm .doctress to remove `sphinx` rendering issues for ipywidget mimetypes
69+
# and clear the sphinx cache for building final HTML documents.
70+
- name: Build HTML
71+
shell: bash -l {0}
72+
run: |
73+
rm -r _build/.doctrees
74+
jb build lectures --path-output ./
75+
- name: Deploy website to gh-pages
76+
uses: peaceiris/actions-gh-pages@v3
77+
with:
78+
github_token: ${{ secrets.GITHUB_TOKEN }}
79+
publish_dir: _build/html/
80+
# cname: intro.quantecon.org
81+
- name: Upload "_build" folder (cache)
82+
uses: actions/upload-artifact@v2
83+
with:
84+
name: build-publish
85+
path: _build
86+
# - name: Prepare lecture-python-intro.notebooks sync
87+
# shell: bash -l {0}
88+
# run: |
89+
# mkdir -p _build/lecture-python-intro.notebooks
90+
# cp -a _notebook_repo/. _build/lecture-python-intro.notebooks
91+
# cp _build/jupyter/*.ipynb _build/lecture-python-intro.notebooks
92+
# ls -a _build/lecture-python-intro.notebooks
93+
# - name: Commit latest notebooks to lecture-python-intro.notebooks
94+
# uses: cpina/github-action-push-to-another-repository@master
95+
# env:
96+
# API_TOKEN_GITHUB: ${{ secrets.QUANTECON_SERVICES_PAT }}
97+
# with:
98+
# source-directory: '_build/lecture-python-intro.notebooks/'
99+
# destination-repository-username: 'QuantEcon'
100+
# destination-repository-name: 'lecture-python-intro.notebooks'
101+
# commit-message: 'auto publishing updates to notebooks'
102+
# destination-github-username: 'quantecon-services'
103+
# user-email: services@quantecon.org

0 commit comments

Comments
 (0)