Merge pull request #62 from sustainers/feat/deploy-book-action

ci: Add a deploy-book action

.github/workflows/deploy-book.yml

@@ -0,0 +1,60 @@
+name: deploy-book
+
+# Run this when the master or main branch changes
+on:
+  push:
+    branches:
+    - master
+    - main
+    # If your git repository has the Jupyter Book within some-subfolder next to
+    # unrelated files, you can make this run only if a file within that specific
+    # folder has been modified.
+    #
+    # paths:
+    # - some-subfolder/**
+
+# This job installs dependencies, builds the book, and pushes it to `gh-pages`
+jobs:
+  deploy-book:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - uses: actions/checkout@v3
+
+    # Install dependencies
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.11
+
+    - name: Install dependencies
+      run: |
+        pip install -r requirements.txt
+
+    # (optional) Cache your executed notebooks between runs
+    # if you have config:
+    # execute:
+    #   execute_notebooks: cache
+    - name: cache executed notebooks
+      uses: actions/cache@v3
+      with:
+        path: _build/.jupyter_cache
+        key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}
+
+    # Build the book
+    - name: Build the book
+      run: |
+        TZ=UTC jupyter-book build --all .
+
+    # Upload the book's HTML as an artifact
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v2
+      with:
+        path: "_build/html"
+
+    # Deploy the book's HTML to GitHub Pages
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v2

_build/html/_sources/organizations.md

@@ -25,7 +25,7 @@ Sorted alphabetically.
 
 - **[CHAOSS](./organizations/chaoss.md)**
 - [InnerSource Commons](https://innersourcecommons.org/)
-- [OSPO++](https://ospoplusplus.org/)
+- [OSPO++](https://ospoplusplus.org/) (Site down)
 - [ReSA](https://www.researchsoft.org/about-resa/)
 - [The Carpentries](https://carpentries.org)
   - [Software Carpentry](https://software-carpentry.org)

_build/html/_sources/organizations/example.md

@@ -1,6 +1,6 @@
 # Organization Name
 
-*Homepage*: [Link](website)
+*Homepage*: [Link](http://example.com)
 *Contact*: Any appropriate person to contact, if there is one
 
 Description

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

@@ -2,7 +2,7 @@
 
 - *OSPO*: Yes, in the Libraries and Academic Innovation
 - *Personnel*: David Lippert, Lorena Barba, Robin Delaloye
-- *Link*: [https://library.gwu.edu/ospo](https://library.gwu.edu/ospo)
+- *Link*: [https://library.gwu.edu/ospo](https://ospo.gwu.edu)
 - *Member of*: [HELIOS](https://www.heliosopen.org/members), [OSF](https://osf.io/institutions/gwu)
 
 ## General Description

_build/html/organizations.html

@@ -442,7 +442,7 @@ <h2>Communities of practice<a class="headerlink" href="#communities-of-practice"
 <ul class="simple">
 <li><p><strong><a class="reference internal" href="organizations/chaoss.html"><span class="std std-doc">CHAOSS</span></a></strong></p></li>
 <li><p><a class="reference external" href="https://innersourcecommons.org/">InnerSource Commons</a></p></li>
-<li><p><a class="reference external" href="https://ospoplusplus.org/">OSPO++</a></p></li>
+<li><p><a class="reference external" href="https://ospoplusplus.org/">OSPO++</a> (Site down)</p></li>
 <li><p><a class="reference external" href="https://www.researchsoft.org/about-resa/">ReSA</a></p></li>
 <li><p><a class="reference external" href="https://carpentries.org">The Carpentries</a></p>
 <ul>

_build/html/organizations/example.html

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

_build/html/universities/george-washington.html

@@ -418,7 +418,7 @@ <h1>George Washington University<a class="headerlink" href="#george-washington-u
 <ul class="simple">
 <li><p><em>OSPO</em>: Yes, in the Libraries and Academic Innovation</p></li>
 <li><p><em>Personnel</em>: David Lippert, Lorena Barba, Robin Delaloye</p></li>
-<li><p><em>Link</em>: <a class="reference external" href="https://library.gwu.edu/ospo">https://library.gwu.edu/ospo</a></p></li>
+<li><p><em>Link</em>: <a class="reference external" href="https://ospo.gwu.edu">https://library.gwu.edu/ospo</a></p></li>
 <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>
 </ul>
 <section id="general-description">

requirements.txt

@@ -1,3 +1,4 @@
 jupyter-book
 matplotlib
 numpy
+tzdata