Skip to content

Commit 390529c

Browse files
authored
Merge pull request #62 from sustainers/feat/deploy-book-action
ci: Add a deploy-book action
2 parents 05f690d + 688f0b8 commit 390529c

File tree

13 files changed

+68
-7
lines changed

13 files changed

+68
-7
lines changed

.github/workflows/deploy-book.yml

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: deploy-book
2+
3+
# Run this when the master or main branch changes
4+
on:
5+
push:
6+
branches:
7+
- master
8+
- main
9+
# If your git repository has the Jupyter Book within some-subfolder next to
10+
# unrelated files, you can make this run only if a file within that specific
11+
# folder has been modified.
12+
#
13+
# paths:
14+
# - some-subfolder/**
15+
16+
# This job installs dependencies, builds the book, and pushes it to `gh-pages`
17+
jobs:
18+
deploy-book:
19+
runs-on: ubuntu-latest
20+
permissions:
21+
pages: write
22+
id-token: write
23+
steps:
24+
- uses: actions/checkout@v3
25+
26+
# Install dependencies
27+
- name: Set up Python 3.11
28+
uses: actions/setup-python@v4
29+
with:
30+
python-version: 3.11
31+
32+
- name: Install dependencies
33+
run: |
34+
pip install -r requirements.txt
35+
36+
# (optional) Cache your executed notebooks between runs
37+
# if you have config:
38+
# execute:
39+
# execute_notebooks: cache
40+
- name: cache executed notebooks
41+
uses: actions/cache@v3
42+
with:
43+
path: _build/.jupyter_cache
44+
key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
45+
46+
# Build the book
47+
- name: Build the book
48+
run: |
49+
TZ=UTC jupyter-book build --all .
50+
51+
# Upload the book's HTML as an artifact
52+
- name: Upload artifact
53+
uses: actions/upload-pages-artifact@v2
54+
with:
55+
path: "_build/html"
56+
57+
# Deploy the book's HTML to GitHub Pages
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v2

_build/.doctrees/environment.pickle

1.85 KB
Binary file not shown.
56 Bytes
Binary file not shown.
-164 Bytes
Binary file not shown.
Binary file not shown.

_build/html/_sources/organizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Sorted alphabetically.
2525

2626
- **[CHAOSS](./organizations/chaoss.md)**
2727
- [InnerSource Commons](https://innersourcecommons.org/)
28-
- [OSPO++](https://ospoplusplus.org/)
28+
- [OSPO++](https://ospoplusplus.org/) (Site down)
2929
- [ReSA](https://www.researchsoft.org/about-resa/)
3030
- [The Carpentries](https://carpentries.org)
3131
- [Software Carpentry](https://software-carpentry.org)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Organization Name
22

3-
*Homepage*: [Link](website)
3+
*Homepage*: [Link](http://example.com)
44
*Contact*: Any appropriate person to contact, if there is one
55

66
Description

_build/html/_sources/universities/george-washington.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
- *OSPO*: Yes, in the Libraries and Academic Innovation
44
- *Personnel*: David Lippert, Lorena Barba, Robin Delaloye
5-
- *Link*: [https://library.gwu.edu/ospo](https://library.gwu.edu/ospo)
5+
- *Link*: [https://library.gwu.edu/ospo](https://ospo.gwu.edu)
66
- *Member of*: [HELIOS](https://www.heliosopen.org/members), [OSF](https://osf.io/institutions/gwu)
77

88
## General Description

_build/html/organizations.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ <h2>Communities of practice<a class="headerlink" href="#communities-of-practice"
442442
<ul class="simple">
443443
<li><p><strong><a class="reference internal" href="organizations/chaoss.html"><span class="std std-doc">CHAOSS</span></a></strong></p></li>
444444
<li><p><a class="reference external" href="https://innersourcecommons.org/">InnerSource Commons</a></p></li>
445-
<li><p><a class="reference external" href="https://ospoplusplus.org/">OSPO++</a></p></li>
445+
<li><p><a class="reference external" href="https://ospoplusplus.org/">OSPO++</a> (Site down)</p></li>
446446
<li><p><a class="reference external" href="https://www.researchsoft.org/about-resa/">ReSA</a></p></li>
447447
<li><p><a class="reference external" href="https://carpentries.org">The Carpentries</a></p>
448448
<ul>

_build/html/organizations/example.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ <h1>Organization Name</h1>
402402

403403
<section class="tex2jax_ignore mathjax_ignore" id="organization-name">
404404
<h1>Organization Name<a class="headerlink" href="#organization-name" title="Link to this heading">#</a></h1>
405-
<p><em>Homepage</em>: <a class="reference internal" href="#website"><span class="xref myst">Link</span></a>
405+
<p><em>Homepage</em>: <a class="reference external" href="http://example.com">Link</a>
406406
<em>Contact</em>: Any appropriate person to contact, if there is one</p>
407407
<p>Description</p>
408408
</section>

_build/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_build/html/universities/george-washington.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ <h1>George Washington University<a class="headerlink" href="#george-washington-u
418418
<ul class="simple">
419419
<li><p><em>OSPO</em>: Yes, in the Libraries and Academic Innovation</p></li>
420420
<li><p><em>Personnel</em>: David Lippert, Lorena Barba, Robin Delaloye</p></li>
421-
<li><p><em>Link</em>: <a class="reference external" href="https://library.gwu.edu/ospo">https://library.gwu.edu/ospo</a></p></li>
421+
<li><p><em>Link</em>: <a class="reference external" href="https://ospo.gwu.edu">https://library.gwu.edu/ospo</a></p></li>
422422
<li><p><em>Member of</em>: <a class="reference external" href="https://www.heliosopen.org/members">HELIOS</a>, <a class="reference external" href="https://osf.io/institutions/gwu">OSF</a></p></li>
423423
</ul>
424424
<section id="general-description">

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
jupyter-book
22
matplotlib
33
numpy
4+
tzdata

0 commit comments

Comments
 (0)