45 starter workflow (atbcb#47)

* Specify minimum ruby version * Update dependencies * Remove unnecessary package.json entries * cleanup work, make sure jekyll-assets and jekyll watch are ok * Bust CircleCI Cache
apburnes-tests · Dec 20, 2019 · 668ae23 · 668ae23
1 parent c44e7bd
commit 668ae23
Show file tree

Hide file tree

Showing 12 changed files with 442 additions and 254 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -7,20 +7,20 @@ jobs:
       - checkout
       - restore_cache:
           keys:
-            - v1-npm-{{ checksum "package-lock.json" }}
-            - v1-npm-
+            - v2-npm-{{ checksum "package-lock.json" }}
+            - v2-npm-
       - run: npm install
       - save_cache:
-          key: v1-npm-{{ checksum "package-lock.json" }}
+          key: v2-npm-{{ checksum "package-lock.json" }}
           paths:
             - node_modules
       - restore_cache:
           keys:
-            - v1-bundle-{{ checksum "Gemfile.lock" }}
-            - v1-bundle-
+            - v2-bundle-{{ checksum "Gemfile.lock" }}
+            - v2-bundle-
       - run: bundle install --path vendor/bundle
       - save_cache:
-          key: v1-bundle-{{ checksum "Gemfile.lock" }}
+          key: v2-bundle-{{ checksum "Gemfile.lock" }}
           paths:
             - vendor/bundle
       - run: npm run build

diff --git a/Gemfile b/Gemfile
@@ -12,6 +12,8 @@ source "https://rubygems.org"
 # Happy Jekylling!
 gem "jekyll", "~> 3.8"
 
+# See https://github.com/envygeeks/jekyll-assets/issues/622
+gem "sprockets", "~> 3.7"
 
 # If you have any plugins, put them here!
 group :jekyll_plugins do

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,48 +1,39 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (5.2.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     colorator (1.1.0)
-    colorize (0.8.1)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.5)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     ethon (0.12.0)
       ffi (>= 1.3.0)
     eventmachine (1.2.7)
-    eventmachine (1.2.7-java)
-    eventmachine (1.2.7-x64-mingw32)
-    eventmachine (1.2.7-x86-mingw32)
     execjs (2.7.0)
     extras (0.3.0)
       forwardable-extended (~> 2.5)
     fastimage (2.1.7)
-    ffi (1.10.0)
-    ffi (1.10.0-java)
-    ffi (1.10.0-x64-mingw32)
-    ffi (1.10.0-x86-mingw32)
+    ffi (1.11.3)
     forwardable-extended (2.6.0)
-    html-proofer (3.10.1)
-      activesupport (>= 4.2, < 6.0)
+    html-proofer (3.14.1)
       addressable (~> 2.3)
-      colorize (~> 0.8)
-      mercenary (~> 0.3.2)
-      nokogiri (~> 1.9)
+      mercenary (~> 0.3)
+      nokogiri (~> 1.10)
       parallel (~> 1.3)
+      rainbow (~> 3.0)
       typhoeus (~> 1.3)
       yell (~> 2.0)
     http_parser.rb (0.6.0)
-    http_parser.rb (0.6.0-java)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.5)
+    jekyll (3.8.6)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -66,53 +57,47 @@ GEM
       nokogiri (~> 1.8)
       pathutil (~> 0.16)
       sprockets (>= 3.3, < 4.1.beta)
-    jekyll-feed (0.11.0)
-      jekyll (~> 3.3)
+    jekyll-feed (0.13.0)
+      jekyll (>= 3.7, < 5.0)
     jekyll-paginate-v2 (2.0.0)
       jekyll (~> 3.0)
-    jekyll-redirect-from (0.14.0)
-      jekyll (~> 3.3)
+    jekyll-redirect-from (0.15.0)
+      jekyll (>= 3.3, < 5.0)
     jekyll-sanity (1.2.0)
       jekyll (~> 3.1)
     jekyll-sass-converter (1.5.2)
       sass (~> 3.4)
-    jekyll-seo-tag (2.6.0)
-      jekyll (~> 3.3)
-    jekyll-sitemap (1.2.0)
-      jekyll (~> 3.3)
-    jekyll-watch (2.1.2)
+    jekyll-seo-tag (2.6.1)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-watch (2.2.1)
       listen (~> 3.0)
     kramdown (1.17.0)
-    liquid (4.0.1)
+    liquid (4.0.3)
     liquid-tag-parser (1.9.0)
       extras (~> 0.3)
       liquid (>= 3.0, < 5.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.4)
-      mini_portile2 (~> 2.4.0)
-    nokogiri (1.10.4-java)
-    nokogiri (1.10.4-x64-mingw32)
-      mini_portile2 (~> 2.4.0)
-    nokogiri (1.10.4-x86-mingw32)
+    minitest (5.13.0)
+    nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
-    parallel (1.13.0)
+    parallel (1.19.1)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (3.0.3)
+    public_suffix (4.0.1)
     rack (2.0.7)
+    rainbow (3.0.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    rouge (3.3.0)
-    ruby_dep (1.5.0)
-    safe_yaml (1.0.4)
-    sass (3.7.3)
+    rouge (3.14.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -121,21 +106,14 @@ GEM
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     thread_safe (0.3.6)
-    thread_safe (0.3.6-java)
     typhoeus (1.3.1)
       ethon (>= 0.9.0)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    tzinfo-data (1.2019.3)
-      tzinfo (>= 1.0.0)
-    yell (2.0.7)
+    yell (2.2.0)
 
 PLATFORMS
-  java
   ruby
-  x64-mingw32
-  x86-mingw32
-  x86-mswin32
 
 DEPENDENCIES
   html-proofer (~> 3.10)
@@ -146,6 +124,7 @@ DEPENDENCIES
   jekyll-redirect-from
   jekyll-seo-tag
   jekyll-sitemap
+  sprockets (~> 3.7)
   tzinfo-data
 
 RUBY VERSION

diff --git a/README.md b/README.md
@@ -92,39 +92,42 @@ searchgov:
 
 - `search/index.html` is used by search.gov.
 
+## Getting Started
 
+### Installation as a starter
 
+#### With `npx`
+The simplest way to create your own repository based on this starter is to use `npx` (included with `node`) with `degit`.
 
-## Installation
+    $ npx degit https://github.com/18F/federalist-uswds-jekyll <destination-folder>
+    $ cd <destination-folder>
+    $ git init
 
-Clone the repository.
+#### With `git`
+    $ git clone --depth 1 https://github.com/18F/federalist-uswds-jekyll <destination-folder>
+    $ cd <destination-folder>
+    $ npm run reset
+    $ git init
+
+### Installation for development
 
     $ git clone https://github.com/18F/federalist-uswds-jekyll
     $ cd federalist-uswds-jekyll
 
-Install the Node.js dependencies.
+Note that when built by Federalist, `npm run federalist` is used instead of the
+`build` script.
 
+### Install dependencies and run app
     $ npm install
-
-Build the site.
-
-    $ npm run build
-
-Run the site locally.
-
+    $ bundle install
     $ npm start
 
 Open your web browser to [localhost:4000](http://localhost:4000/) to view your
 site.
 
-After you make changes, be sure to run the tests.
-
+### Testing
     $ npm test
 
-Note that when built by Federalist, `npm run federalist` is used instead of the
-`build` script.
-
-
 ## Technologies you should be familiarize yourself with
 
 - [Jekyll](https://jekyllrb.com/docs/) - The primary site engine that builds your code and content.

diff --git a/assets/css/index.scss → _assets/css/index.scss b/assets/css/index.scss → _assets/css/index.scss
diff --git a/assets/images/hire-us.jpg → _assets/images/hire-us.jpg b/assets/images/hire-us.jpg → _assets/images/hire-us.jpg
diff --git a/assets/js/app.js → _assets/js/app.js b/assets/js/app.js → _assets/js/app.js
diff --git a/assets/uploads/cloud-gov-logo.png → _assets/uploads/cloud-gov-logo.png b/assets/uploads/cloud-gov-logo.png → _assets/uploads/cloud-gov-logo.png
diff --git a/_config.yml b/_config.yml
@@ -135,21 +135,16 @@ pagination:
   indexpage: "index.html"
 
 exclude:
-  - Gemfile
-  - Gemfile.lock
-  - node_modules
-  - vendor/bundle
-  - vendor/cache
-  - vendor/gems
-  - vendor/ruby
-  - node_modules
   - package.json
   - package-lock.json
   - README.md
-  - src
   - CONTRIBUTING.md
   - LICENSE.md
-  - assets
+  - degit.json
+  - vendor
+  - node_modules
+  - Gemfile
+  - Gemfile.lock
 
 assets:
   sources:

diff --git a/degit.json b/degit.json
@@ -0,0 +1,11 @@
+[
+  {
+    "action": "remove",
+    "files": [
+      "Gemfile.lock",
+      "package-lock.json",
+      "LICENSE.md",
+      "CONTRIBUTING.md"
+    ]
+  }
+]