Merge branch 'master' into 0103-poetry

.github/ISSUE_TEMPLATE/recipe-correction.md

@@ -0,0 +1,15 @@
+---
+name: Recipe correction template
+about: Use this template if you find an issue with a recipe
+title: ''
+labels: 'meta: correction'
+assignees: ''
+
+---
+
+## Recipe info:
+
+ * Name:
+ * link:
+
+## Correction request  

.github/ISSUE_TEMPLATE/recipe-issue-template.md

@@ -10,7 +10,5 @@ assignees: ''
 ## Recipe Name  
 (this will usually be the same as the issue name)
 
-(Provide link to `index.md` of the issue, if available. To be filled in after issue is created - you need the issue number!)
-
 ## Use case  
 (This might be the same text as the use case section of the issue, if your recipe is already well understood. Or it might require development in the issue discussion and be more provisional in nature).

.github/bin/addURL.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo "url: $URL" >> _config.yml

.github/workflows/live.yml

@@ -0,0 +1,108 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Deploy-live
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+    push:
+        branches:
+          - main
+          - master
+          - beta
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_WITH: test jekyll_plugins
+      SITE_ID:  'cookbook' # which iiif site this is
+      LIVE_PATH: '/api/cookbook'
+      # Required for ID substition in JSON manifests
+      URL: 'https://iiif.io'
+      JEKYLL_ENV: 'production'
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+    - uses: actions/checkout@v2
+
+    - name: Setup ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - run: gem install bundler && bundle
+
+    - name: add URL to config
+      run: .github/bin/addURL.sh
+
+     # build and test
+    - name: Build live site
+      run: bundle exec rake build:live
+    - name: Test html
+      run: bundle exec rake test:html
+    - name: Test internal links
+      run: bundle exec rake test:links:internal
+   # - name: Test *iiif.io* links
+   #   run: bundle exec rake test:links:iiif
+
+    # Validate
+    - name: Set up Python 3.x
+      uses: actions/setup-python@v2
+      with:
+        # Semantic version range syntax or exact version of a Python version
+        python-version: '3.x' 
+        # Optional - x64 or x86 architecture, defaults to x64
+        architecture: 'x64' 
+    - name: Cache pip
+      uses: actions/cache@v2
+      with:
+        # This path is specific to Ubuntu
+        path: ~/.cache/pip
+        # Look to see if there is a cache hit for the corresponding requirements file
+        key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+          ${{ runner.os }}-
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r scripts/requirements.txt
+
+    - name: validate      
+      run: scripts/validate.sh
+
+    # Deploy to preview site
+    - name: Create GitHub deployment
+      uses: glenrobson/[email protected]
+      id: deployment
+      with:
+        step: start
+        token: ${{ secrets.GITHUB_TOKEN }}
+        auto_inactive: 'false'
+        env: staging
+
+    - name: Deploy to S3
+      uses: glenrobson/[email protected]
+      with:
+        args: --acl public-read 
+      env:
+        AWS_S3_BUCKET: "iiif-website"
+        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        AWS_REGION: ${{ secrets.AWS_REGION }}
+        SOURCE_DIR: "_site"
+
+    - name: Update deployment status
+      uses: glenrobson/[email protected]
+      if: always()
+      with:
+        step: finish
+        auto_inactive: 'false'
+        token: ${{ secrets.GITHUB_TOKEN }}
+        status: ${{ job.status }}
+        deployment_id: ${{ steps.deployment.outputs.deployment_id }}
+        env_url: "https://iiif.io/api/cookbook/index.html"

.github/workflows/preview.yml

@@ -7,41 +7,45 @@ name: Deploy-preview
 on:
     push:
         branches:
-          - '*'
+          - '**'
           - '!master'
+          - '!main'
+          - '!beta'
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   # This workflow contains a single job called "build"
   build:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
+    env:
+      BUNDLE_WITH: test jekyll_plugins
+      SITE_ID:  'cookbook' # which iiif site this is
+      URL: 'https://preview.iiif.io'
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
     - uses: actions/checkout@v2
     # store branch name in ${BRANCH_NAME}
-    - uses: nelonoel/branch-name@v1
+    - name: Export BRANCH_NAME # store branch name in $BRANCH_NAME
+      run: echo BRANCH_NAME=`git rev-parse --abbrev-ref HEAD` >> $GITHUB_ENV
 
     - name: Setup ruby
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '2.6'
-    - run: gem install bundler  
+        bundler-cache: true
+    - run: gem install bundler && bundle
 
-    - uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-gems-
+     # build and test
+    - name: Build preview site
+      run: bundle exec rake build:preview
+    - name: Test html
+      run: bundle exec rake test:html
+    - name: Test internal links
+      run: bundle exec rake test:links:internal
+    - name: Test *iiif.io* links
+      run: bundle exec rake test:links:iiif
 
-    # Build jekyll site
-    - name: Build Jekyll
-      run: .github/bin/build_jekyll.sh
-      env:
-        CONFIG: "--config _config.yml"
-        BASE_URL: "/cookbook/${{ env.BRANCH_NAME}}"
     # Validate
     - name: Set up Python 3.x
       uses: actions/setup-python@v2
@@ -69,13 +73,21 @@ jobs:
     - name: validate      
       run: scripts/validate.sh
 
-    # Deploy to live site
+    - name: add URL to config
+      run: .github/bin/addURL.sh
+
+     # build and test
+    - name: Build preview site
+      run: bundle exec rake build:preview
+
+    # Deploy to preview site
     - name: Create GitHub deployment
-      uses: glenrobson/[email protected].1
+      uses: glenrobson/[email protected].2
       id: deployment
       with:
         step: start
         token: ${{ secrets.GITHUB_TOKEN }}
+        auto_inactive: 'false'
         env: staging
     - name: Deploy to S3
       uses: glenrobson/[email protected]
@@ -87,13 +99,14 @@ jobs:
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
         AWS_REGION: ${{ secrets.AWS_REGION }}
         SOURCE_DIR: "_site"
-        DEST_DIR: "cookbook/${BRANCH_NAME}"
+
     - name: Update deployment status
-      uses: glenrobson/[email protected].1
+      uses: glenrobson/[email protected].2
       if: always()
       with:
         step: finish
+        auto_inactive: 'false'
         token: ${{ secrets.GITHUB_TOKEN }}
         status: ${{ job.status }}
         deployment_id: ${{ steps.deployment.outputs.deployment_id }}
-        env_url: "https://preview.iiif.io/cookbook/${{ env.BRANCH_NAME}}/index.html"
+        env_url: "https://preview.iiif.io/${{ env.SITE_ID }}/${{ env.BRANCH_NAME}}/index.html"

.gitignore

@@ -1,5 +1,6 @@
 _site
 *.swp
-.ruby-version
 presentation-validator
 scripts/schema
+.jekyll-cache
+vendor

.ruby-version

@@ -0,0 +1 @@
+3.1.0

Gemfile

@@ -1,5 +1,21 @@
 source 'https://rubygems.org'
 
-gem 'jekyll', '>= 3.8.5'
-gem 'kramdown', '>= 1.17.0'
-gem 'rake'
+gem 'jekyll', '~> 4.1.1'
+
+# for local development, clone theme + use path loader
+# gem 'iiifc-theme', path: 'iiifc-theme'
+gem 'iiifc-theme', github: 'iiif/iiifc-theme', branch: 'ignore-font-awsome'
+
+# For open graph and Twitter Card elements
+gem 'jekyll-seo-tag'
+
+gem "webrick", "~> 1.7"
+
+# Pining jekyll-liquify as 0.0.3 is broken
+gem "jekyll-liquify", "0.0.2"
+
+group :development, :test do
+  gem 'html-proofer', "3.19.0"
+  gem 'rspec'
+  gem 'rake'
+end