Merge branch 'main' into reviewnb

.all-contributorsrc

@@ -42,7 +42,7 @@
     },
     {
       "login": "JessicaS11",
-      "name": "Jessica",
+      "name": "Jessica Scheick",
       "avatar_url": "https://avatars.githubusercontent.com/u/11756442?v=4",
       "profile": "https://github.com/JessicaS11",
       "contributions": [

.github/actions/README.md

@@ -20,6 +20,9 @@ The `workflows/` subfolder contains continuous integration workflows
 #### [binder-badge.yaml](../workflows/binder-badge.yaml)
 Create [binder](https://mybinder.readthedocs.io/en/latest/howto/gh-actions-badges.html) badges with links to test tutorial notebooks
 
+#### [build-website.yaml](../workflows/build-website.yaml)
+Build the websites (JupyterBook and front page). Run on Pull Requests against every commit and via a 'cron' schedule to maintain caching [since otherwise the cache expires if untouched in 7 days](https://docs.github.com/en/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)
+
 #### [deploy.yaml](../workflows/deploy.yaml)
 Render and publish the websites (JupyterBook and landing page) to GitHub Pages
 
@@ -35,8 +38,12 @@ Quality assessment and quality control. Standardizes formatting including spell
 #### [repo2docker.yaml](../workflows/repo2docker.yaml)
 [Build a Docker image](https://github.com/jupyterhub/repo2docker-action) for JupyterHub/BinderHub
 
-#### [test.yaml](../workflows/test.yaml)
-Build the websites (JupyterBook and front page). Run on Pull Requests against every commit and via a 'cron' schedule to maintain caching [since otherwise the cache expires if untouched in 7 days](https://docs.github.com/en/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy)
+#### [template-sync.yaml](../workflows/template-sync.yaml)
+Open a PR to update the templated repo to incorporate changes made to the
+[template repo](https://github.com/uwhackweek/jupyterbook-template).
+Template users should fill out the [.templatesyncignore](../../../.templatesyncignore)
+to specify which files they do not want updated from the template.
+
 
 ## Security
 

.github/actions/buildresources/action.yaml

@@ -21,7 +21,7 @@ runs:
   steps:
     - name: Setup JupyterBook Cache
       if: inputs.jb-cache == 'true'
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ./book/_build
         # NOTE: change key to "jupyterbook-N+1" to force rebuilding cache
@@ -52,8 +52,8 @@ runs:
 
     - name: Save Build
       if: ${{ always() && inputs.jb-save == 'true'}}
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
-        name: build
+        name: build-${{ inputs.os }}
         path: book/_build/
 

.github/workflows/build_website.yaml

@@ -8,9 +8,9 @@ on:
   pull_request_target:
     types: [labeled, synchronize]
     paths:
-      - '.github/**'
+      - '.github/**/*'
       - '{{ cookiecutter.repo_directory }}/**'
-      - 'book/**'
+      - 'book/**/*'
       - 'conda/**'
       - 'scripts/**'
       - 'cookiecutter.yaml'
@@ -31,7 +31,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         ref: ${{ github.event.pull_request.head.sha }}
 
@@ -49,3 +49,4 @@ jobs:
         jb-cache: false
         publish-to-gh: false
         jb-save: true
+        os: ${{ matrix.os }}

.github/workflows/deploy.yaml

@@ -7,19 +7,18 @@ on:
       - '{{ cookiecutter.repo_directory }}/**'
       - 'scripts/**'
       - '.github/workflows/deploy.yaml'
-      - '.github/actions/**'
       - 'cookiecutter.yaml'
 
     branches:
       - main
 
 jobs:
   build-and-deploy:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Configure NASA Earthdata Login
       continue-on-error: true

.github/workflows/manual.yaml

@@ -5,12 +5,12 @@ on:
 
 jobs:
   build-and-test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
-      
+      uses: actions/checkout@v4
+
     - name: Configure NASA Earthdata Login
       continue-on-error: true
       env:
@@ -19,7 +19,7 @@ jobs:
       run: |
         echo "machine urs.earthdata.nasa.gov login $EARTHDATA_USER password $EARTHDATA_PASS" > ~/.netrc
         chmod 0600 ~/.netrc
-        
+
     - uses: ./.github/actions/buildresources
       with:
         jb-cache: false

.github/workflows/netlifypreview.yaml

@@ -6,14 +6,14 @@ on:
 
 jobs:
   add-preview:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     # This workflow accesses secrets and checks out a PR, so only run if labelled
     # https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
     if: contains(github.event.pull_request.labels.*.name, 'preview')
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         ref: ${{ github.event.pull_request.head.sha }}
 
@@ -34,7 +34,7 @@ jobs:
 
     - name: Deploy Website Preview
       if: always()
-      uses: nwtgck/actions-netlify@v2.0
+      uses: nwtgck/actions-netlify@v3.0
       with:
         publish-dir: './book/_build/html'
         production-deploy: false

.github/workflows/qaqc.yaml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   quality-control:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     defaults:
       run:
         shell: bash -l {0}
@@ -31,7 +31,7 @@ jobs:
       uses: codespell-project/actions-codespell@master
       with:
         check_filenames: true
-        skip: '*.js,qaqc.yml,*.geojson'
+        skip: '*.js,*.css,qaqc.yml,*.geojson'
         ignore_words_file: .codespellignore
         only_warn: 1
 

.github/workflows/template-sync.yaml

@@ -0,0 +1,33 @@
+name: 'Sync to Template'
+description: 'Get updates to the Jupyterbook from the template repo'
+
+on:
+  # cronjob trigger (minute, hour, day, month, day-of-week; here 1st of month)
+  # schedule:
+  # - cron:  "0 0 1 * *"
+  # manual trigger
+  workflow_dispatch:
+
+jobs:
+  repo-sync:
+    runs-on: ubuntu-latest
+    # https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      # To use this repository's private action, you must check out the repository
+      - name: Checkout
+        uses: actions/checkout@v4
+        # https://github.com/actions/checkout#usage
+        # uncomment if you use submodules within the source repository
+        # with:
+        #   submodules: true
+
+      - name: actions-template-sync
+        uses: AndreasAugustin/actions-template-sync@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          source_repo_path: uwhackweek/jupyterbook-template
+          upstream_branch: main # defaults to main

.templatesyncignore

@@ -0,0 +1,15 @@
+# THIS FILE CANNOT BE SYNCED
+# use glob patterns as in .gitignore
+# recommend listing non-basics tutorial directories here
+
+# configuration files
+cookiecutter.yaml
+
+# environment lock files
+./conda/*lock.yml
+
+# book files (configuration, usage-specific)
+./book/_config.yml
+./book/team.yaml
+
+# event-specific tutorials

README.md

@@ -14,8 +14,8 @@ We've found that every hackweek benefits from a single-page website to get peopl
 
 We've used this template for the following events:
 
-* ICESat-2 Hackweek 2022: https://icesat-2.hackweek.io
-* SnowEx Hackweek 2021: https://snowex-hackweek.github.io/website/intro.html
+* ICESat-2 Hackweek 2022 + 2023: https://icesat-2.hackweek.io
+* SnowEx Hackweeks (2021, 2022): https://snowex.hackweek.io
 
 
 ## How to use this template

book/projects/project_roadmap.md

@@ -1,6 +1,6 @@
 # Project Roadmap
 
-Each project will progress through these stages: 
+Each project will progress through these stages:
 
 ```{image} ../img/project-timeline.png
 :alt: flowchart of typical hackweek project timelines
@@ -36,15 +36,15 @@ We facilitate a project team formation session at the end of the first day of th
 ## **Teamwork**
 
 * kick-off meeting focuses on hearing from each team member:
-    * What are your unique learning goals? 
+    * What are your unique learning goals?
     * How do you work best? What level of group interaction works for you?
     * What skills and background are you most excited to share with the team?
     * When are you available to meet?
-* set up team computing infrastructure on Slack and GitHub ([Project Initiallization](project_initialization)) 
+* set up team computing infrastructure on Slack and GitHub ([Project Initialization](project_initialization))
 * project work begins and teams have regular check-ins to chart progress
 * project outputs are recorded in a GitHub repository
 
-## **Presentations** 
+## **Presentations**
 
 * each team has 15 minutes to share what was learned, what challenges arose, what might be worth trying next
 * individual contributions to the group effort are recognized and celebrated
@@ -54,7 +54,7 @@ We facilitate a project team formation session at the end of the first day of th
 * We aspire to keep projects going after the hackweek! This is an optional (ideal) outcome of hackweek project work.
 * Project leads/helpers will transition to longer-term engagement via mentorship role (optional/with support).
 * Additional people join a growing Community of Practice (for example, centered on a community software library).
-* software, research results are packaged and shared/published. 
+* software, research results are packaged and shared/published.