Merge pull request #264 from MarkLodato/gemfile

Clean up jekyll config and add dependabot.

Merge pull request #264 from MarkLodato/gemfile
Clean up jekyll config and add dependabot.
37624527 · Mark Lodato · GitHub · 75190d58 · 6c2ca616 · 37624527
Unverified Commit 37624527 authored Jan 11, 2022 by Mark Lodato Committed by GitHub Jan 11, 2022
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
 version: 2
 updates:

+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+
 - package-ecosystem: github-actions
  directory: "/"
  schedule:

--- a/.gitignore
+++ b/.gitignore
+.bundle
 .DS_store
+.jekyll-cache
 .sass-cache
 _site
 node_modules
-.jekyll-cache/
+/docs/vendor
--- a/docs/.DS_Store
+++ b/docs/.DS_Store
--- a/docs/.ruby-version
+++ b/docs/.ruby-version
+2.7.3
--- a/docs/Gemfile
+++ b/docs/Gemfile
 source "https://rubygems.org"
-
-gem 'jekyll', '4.2.1'
-gem 'jekyll-seo-tag'
-gem 'hash-joiner'
-gem 'json'
-gem 'jekyll-commonmark-ghpages'
-gem 'jekyll-sitemap'
-gem 'jekyll-coffeescript'
-gem 'jekyll-default-layout'
-gem 'jekyll-gist'
-gem 'jekyll-github-metadata'
-gem 'jekyll-optional-front-matter'
-gem 'jekyll-paginate'
-gem 'jekyll-readme-index'
-gem 'jekyll-titles-from-headings'
-gem 'jekyll-relative-links'
-gem 'jekyll-toc'
-gem 'minima'
\ No newline at end of file
+gem 'github-pages', group: :jekyll_plugins
+gem 'netrc'    # Allows using ~/.netrc for personal access token
+gem 'webrick'  # Needed for Ruby 3
--- a/docs/Gemfile.lock
+++ b/docs/Gemfile.lock
 GEM
  remote: https://rubygems.org/
  specs:
+    activesupport (6.0.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
    addressable (2.8.0)
      public_suffix (>= 2.0.2, < 5.0)
    coffee-script (2.4.1)
      coffee-script-source
      execjs
-    coffee-script-source (1.12.2)
+    coffee-script-source (1.11.1)
    colorator (1.1.0)
    commonmarker (0.17.13)
      ruby-enum (~> 0.5)
    concurrent-ruby (1.1.9)
+    dnsruby (1.61.7)
+      simpleidn (~> 0.1)
    em-websocket (0.5.3)
      eventmachine (>= 0.12.9)
      http_parser.rb (~> 0)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
    eventmachine (1.2.7)
    execjs (2.8.1)
-    faraday (1.8.0)
+    faraday (1.9.3)
      faraday-em_http (~> 1.0)
      faraday-em_synchrony (~> 1.0)
      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
      faraday-patron (~> 1.0)
      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
      ruby2_keywords (>= 0.0.4)
    faraday-em_http (1.0.0)
    faraday-em_synchrony (1.0.0)
    faraday-excon (1.1.0)
    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
    faraday-net_http (1.0.1)
    faraday-net_http_persistent (1.2.0)
    faraday-patron (1.0.0)
    faraday-rack (1.0.0)
-    ffi (1.15.4)
+    faraday-retry (1.0.3)
+    ffi (1.15.5)
    forwardable-extended (2.6.0)
-    hash-joiner (0.0.7)
-      safe_yaml
+    gemoji (3.0.1)
+    github-pages (223)
+      github-pages-health-check (= 1.17.9)
+      jekyll (= 3.9.0)
+      jekyll-avatar (= 0.7.0)
+      jekyll-coffeescript (= 1.1.1)
+      jekyll-commonmark-ghpages (= 0.1.6)
+      jekyll-default-layout (= 0.1.4)
+      jekyll-feed (= 0.15.1)
+      jekyll-gist (= 1.5.0)
+      jekyll-github-metadata (= 2.13.0)
+      jekyll-include-cache (= 0.2.1)
+      jekyll-mentions (= 1.6.0)
+      jekyll-optional-front-matter (= 0.3.2)
+      jekyll-paginate (= 1.1.0)
+      jekyll-readme-index (= 0.3.0)
+      jekyll-redirect-from (= 0.16.0)
+      jekyll-relative-links (= 0.6.1)
+      jekyll-remote-theme (= 0.4.3)
+      jekyll-sass-converter (= 1.5.2)
+      jekyll-seo-tag (= 2.7.1)
+      jekyll-sitemap (= 1.4.0)
+      jekyll-swiss (= 1.0.0)
+      jekyll-theme-architect (= 0.2.0)
+      jekyll-theme-cayman (= 0.2.0)
+      jekyll-theme-dinky (= 0.2.0)
+      jekyll-theme-hacker (= 0.2.0)
+      jekyll-theme-leap-day (= 0.2.0)
+      jekyll-theme-merlot (= 0.2.0)
+      jekyll-theme-midnight (= 0.2.0)
+      jekyll-theme-minimal (= 0.2.0)
+      jekyll-theme-modernist (= 0.2.0)
+      jekyll-theme-primer (= 0.6.0)
+      jekyll-theme-slate (= 0.2.0)
+      jekyll-theme-tactile (= 0.2.0)
+      jekyll-theme-time-machine (= 0.2.0)
+      jekyll-titles-from-headings (= 0.5.3)
+      jemoji (= 0.12.0)
+      kramdown (= 2.3.1)
+      kramdown-parser-gfm (= 1.1.0)
+      liquid (= 4.0.3)
+      mercenary (~> 0.3)
+      minima (= 2.5.1)
+      nokogiri (>= 1.12.5, < 2.0)
+      rouge (= 3.26.0)
+      terminal-table (~> 1.4)
+    github-pages-health-check (1.17.9)
+      addressable (~> 2.3)
+      dnsruby (~> 1.60)
+      octokit (~> 4.0)
+      public_suffix (>= 3.0, < 5.0)
+      typhoeus (~> 1.3)
+    html-pipeline (2.14.0)
+      activesupport (>= 2)
+      nokogiri (>= 1.4)
    http_parser.rb (0.8.0)
-    i18n (1.8.11)
+    i18n (0.9.5)
      concurrent-ruby (~> 1.0)
-    jekyll (4.2.1)
+    jekyll (3.9.0)
      addressable (~> 2.4)
      colorator (~> 1.0)
      em-websocket (~> 0.5)
-      i18n (~> 1.0)
-      jekyll-sass-converter (~> 2.0)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
      jekyll-watch (~> 2.0)
-      kramdown (~> 2.3)
-      kramdown-parser-gfm (~> 1.0)
+      kramdown (>= 1.17, < 3)
      liquid (~> 4.0)
-      mercenary (~> 0.4.0)
+      mercenary (~> 0.3.3)
      pathutil (~> 0.9)
-      rouge (~> 3.0)
+      rouge (>= 1.7, < 4)
      safe_yaml (~> 1.0)
-      terminal-table (~> 2.0)
-    jekyll-coffeescript (2.0.0)
+    jekyll-avatar (0.7.0)
+      jekyll (>= 3.0, < 5.0)
+    jekyll-coffeescript (1.1.1)
      coffee-script (~> 2.2)
-      coffee-script-source (~> 1.12)
+      coffee-script-source (~> 1.11.1)
    jekyll-commonmark (1.3.1)
      commonmarker (~> 0.14)
      jekyll (>= 3.7, < 5.0)
@@ -67,8 +134,8 @@ GEM
      commonmarker (~> 0.17.6)
      jekyll-commonmark (~> 1.2)
      rouge (>= 2.0, < 4.0)
-    jekyll-default-layout (0.1.5)
-      jekyll (>= 3.0, < 5.0)
+    jekyll-default-layout (0.1.4)
+      jekyll (~> 3.0)
    jekyll-feed (0.15.1)
      jekyll (>= 3.7, < 5.0)
    jekyll-gist (1.5.0)
@@ -76,27 +143,80 @@ GEM
    jekyll-github-metadata (2.13.0)
      jekyll (>= 3.4, < 5.0)
      octokit (~> 4.0, != 4.4.0)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-mentions (1.6.0)
+      html-pipeline (~> 2.3)
+      jekyll (>= 3.7, < 5.0)
    jekyll-optional-front-matter (0.3.2)
      jekyll (>= 3.0, < 5.0)
    jekyll-paginate (1.1.0)
    jekyll-readme-index (0.3.0)
      jekyll (>= 3.0, < 5.0)
+    jekyll-redirect-from (0.16.0)
+      jekyll (>= 3.3, < 5.0)
    jekyll-relative-links (0.6.1)
      jekyll (>= 3.3, < 5.0)
-    jekyll-sass-converter (2.1.0)
-      sassc (> 2.0.1, < 3.0)
+    jekyll-remote-theme (0.4.3)
+      addressable (~> 2.0)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+      rubyzip (>= 1.3.0, < 3.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
    jekyll-seo-tag (2.7.1)
      jekyll (>= 3.8, < 5.0)
    jekyll-sitemap (1.4.0)
      jekyll (>= 3.7, < 5.0)
+    jekyll-swiss (1.0.0)
+    jekyll-theme-architect (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-cayman (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-dinky (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-hacker (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-leap-day (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-merlot (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-midnight (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-minimal (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-modernist (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-primer (0.6.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-github-metadata (~> 2.9)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-slate (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-tactile (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-time-machine (0.2.0)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
    jekyll-titles-from-headings (0.5.3)
      jekyll (>= 3.3, < 5.0)
-    jekyll-toc (0.17.1)
-      jekyll (>= 3.9)
-      nokogiri (~> 1.11)
    jekyll-watch (2.2.1)
      listen (~> 3.0)
-    json (2.6.1)
+    jemoji (0.12.0)
+      gemoji (~> 3.0)
+      html-pipeline (~> 2.2)
+      jekyll (>= 3.0, < 5.0)
    kramdown (2.3.1)
      rexml
    kramdown-parser-gfm (1.1.0)
@@ -105,13 +225,17 @@ GEM
    listen (3.7.0)
      rb-fsevent (~> 0.10, >= 0.10.3)
      rb-inotify (~> 0.9, >= 0.9.10)
-    mercenary (0.4.0)
+    mercenary (0.3.6)
+    mini_portile2 (2.7.1)
    minima (2.5.1)
      jekyll (>= 3.5, < 5.0)
      jekyll-feed (~> 0.9)
      jekyll-seo-tag (~> 2.1)
+    minitest (5.15.0)
    multipart-post (2.1.1)
-    nokogiri (1.12.5-x86_64-darwin)
+    netrc (0.11.0)
+    nokogiri (1.13.0)
+      mini_portile2 (~> 2.7.0)
      racc (~> 1.4)
    octokit (4.21.0)
      faraday (>= 0.9)
@@ -124,42 +248,43 @@ GEM
    rb-inotify (0.10.1)
      ffi (~> 1.0)
    rexml (3.2.5)
-    rouge (3.26.1)
+    rouge (3.26.0)
    ruby-enum (0.9.0)
      i18n
    ruby2_keywords (0.0.5)
+    rubyzip (2.3.2)
    safe_yaml (1.0.5)
-    sassc (2.4.0)
-      ffi (~> 1.9)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
    sawyer (0.8.2)
      addressable (>= 2.3.5)
      faraday (> 0.8, < 2.0)
-    terminal-table (2.0.0)
+    simpleidn (0.2.1)
+      unf (~> 0.1.4)
+    terminal-table (1.8.0)
      unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
    unicode-display_width (1.8.0)
+    webrick (1.7.0)
+    zeitwerk (2.5.3)

 PLATFORMS
-  x86_64-darwin-18
-  x86_64-darwin-19
+  ruby

 DEPENDENCIES
-  hash-joiner
-  jekyll (= 4.2.1)
-  jekyll-coffeescript
-  jekyll-commonmark-ghpages
-  jekyll-default-layout
-  jekyll-gist
-  jekyll-github-metadata
-  jekyll-optional-front-matter
-  jekyll-paginate
-  jekyll-readme-index
-  jekyll-relative-links
-  jekyll-seo-tag
-  jekyll-sitemap
-  jekyll-titles-from-headings
-  jekyll-toc
-  json
-  minima
+  github-pages
+  netrc
+  webrick

 BUNDLED WITH
-   2.2.31
+   2.1.4
--- a/docs/README.md
+++ b/docs/README.md
 # slsa.dev sources

-This directory contains sources for [https://slsa.dev](https://slsa.dev), served via GitHub pages
-and rendered with Jekyll.
+This directory contains sources for [https://slsa.dev](https://slsa.dev), served
+via GitHub pages and rendered with Jekyll.

 ## Developing and testing locally

-1.  [Install Jekyll](https://jekyllrb.com/docs/installation/#guides). This link provides an installation guide for your chosen platform.
-2.  Clone this repo and change directory to `/docs`.
-3.  `bundle install` (to install Jekyll's dependencies).
-4.  Run the project locally with `jekyll serve` (if you'd like live reload use `jekyll serve --livereload`).
-5.  Browse to [http://localhost:4000](http://localhost:4000) to view the site locally.
+1.  Install ruby, bundler, and the dev headers:
+
+    ```bash
+    apt install ruby ruby-dev bundler
+    ```
+
+    Alternatively, you can use `rbenv` to use the exact version of Ruby used by
+    GitHub Pages, but Debian's versions are likely close enough.
+
+2.  Clone this repo and change directory to `/docs`:
+
+    ```bash
+    git clone https://github.com/slsa-framework/slsa
+    cd slsa/docs
+    ```
+
+3.  Install the dependencies locally:
+
+    ```bash
+    bundle config set --local path 'vendor/bundle'
+    bundle install
+    ```
+
+4.  (optional) To enable `jekyll-github-metadata` to read metadata about the
+    slsa repository from the GitHub API, create a GitHub
+    [personal access token](https://github.com/settings/tokens/new) and add it
+    to your `~/.netrc`, like so:
+
+    ```none
+    machine api.github.com
+        login github-username
+        password 123abc-your-token
+    ```
+
+5.  Run the project locally with `jekyll serve` (optionally appending
+    `--livereload`):
+
+    ```bash
+    bundle exec jekyll serve
+    ```
+
+6.  Browse to http://localhost:4000 to view the site locally.

 ## Deployment

-Pushing to `main` will trigger a deployment of Github Pages.
+Pushing to `main` will trigger a deployment of GitHub Pages.
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -15,7 +15,12 @@ collections:
    sort_by: order
    output: true
 exclude:
+  - CNAME
+  - Gemfile
+  - Gemfile.lock
+  - Makefile
  - README.md
+  - vendor/
 google_analytics: G-VNK063J3QF
 theme: minima
 permalink: :path/:basename