jekyll-theme-bas-style-kit 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54c4be6b3f545080f6b9a1732d0cb9ed6df145bd1e12bfd3bed99bd5d5d087f8
-  data.tar.gz: a499c53f7ce5ae7eddf776c21abf72ccad53ac450d4b8898b6051e5e3056a7dd
+  metadata.gz: 3905484aaab5b75365199d0b9a17442652f2a67f9f06b96e33555d6d8fe0233b
+  data.tar.gz: dac3c03bfcaa3bbcd00f7dc7654475a12224b189c4e7ac973897d3e688d01cce
 SHA512:
-  metadata.gz: 6b5fb5a4c2bff1760efb1e2add4f834d56cb2c0c558fff58b83e4ee9d99dbdfa08b10af8709cf541d2488058f085261f6d198604c0f6c0bd1d71187b94fa16fa
-  data.tar.gz: 67a8d3c47dde8f49ce089d0345da5a59cccb92cb314422c6c8ca35522af85393919493681c13e127737843490bb43f7ae3e421cadca6d580e87345aaaa3fa1e5
+  metadata.gz: d0744c66e5db1712a59bf9ce43164eac99b5cbba8b1309013b8ee2c88bf2524a740fef4252dc4d1692a115ba0c19aa910dc1d4918850b152849d62ccb0f5ae66
+  data.tar.gz: b3a9f999182330414b1fd6d054dad63b020839c0650bd71c5220237a46fd6ed2729004a84a8b41e20fabbe8591460173015ebddfae67648c95bb3a97eaff1d75

data/CHANGELOG.md

@@ -5,6 +5,31 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## [Unreleased][unreleased]
 
+## 0.7.0 - 2018-11-24
+
+### Added
+
+* 'Problem with this service' (basic) page pattern variant
+* 'Problem with this service' (contact) page pattern variant
+* 'Problem with this service' (alternative) page pattern variant
+* 'Service unavailable' (contact) page pattern variant
+* 'Service unavailable' (availability) page pattern variant
+* 'Service unavailable' (alternative) page pattern variant
+* 'Service unavailable' (partly closed) page pattern variant
+* 'Service unavailable' (closed) page pattern variant
+* 'Service unavailable' (replaced) page pattern variant
+* Updated to Jekyll 3.8.5 to address security vulnerability
+* Updated to Style Kit 0.5.0-beta
+* Snyk dependency scanning support
+
+### Fixed
+
+* README typo
+
+### Changed
+
+* Improving release procedures
+
 ## 0.6.0 - 2018-09-18
 
 ### Changed [BREAKING!]
@@ -19,6 +44,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 * Implemented Style Kit Favicon
 * Implemented 'page not found' pattern and support for design patterns generally
 * Implemented 'Service unavailable (basic)' pattern
+* Ruby dependencies are now scanned for vulnerabilities using Snyk
 
 ### Changed
 

data/README.md

@@ -1,6 +1,6 @@
 # BAS Style Kit Jekyll Theme
 
-Jekyll theme for the [BAS Style Kit](https://stlye-kit.web.bas.ac.uk).
+Jekyll theme for the [BAS Style Kit](https://style-kit.web.bas.ac.uk).
 
 ![Screenshot of theme](screenshot.png)
 
@@ -84,10 +84,38 @@ For example, information to show when a service is unavailable, formatting dates
 username in a consistent way. See the [Style Kit documentation](https://style-kit.web.bas.ac.uk/patterns) for more 
 information.
 
-These patterns are implemented by this theme based on the reference examples included in the Style Kit. These 
-include patterns for:
+These patterns are implemented by this theme based on the reference examples included in the Style Kit.
 
-* **pages** - standalone pages designed to be used without customisation, defined as [Views](#views)
+#### Page patterns
+
+These template include [Views](#views) for all page patterns. In most cases all variants of a pattern use the same view,
+but with different options using variables and/or page content.
+
+See the [Style Kit documentation](https://style-kit.web.bas.ac.uk) for general information on using these patterns.
+
+##### 'page not found' pattern
+
+No configuration options.
+
+##### 'service unavailable' pattern
+
+Optionally, use page content for:
+
+* contact information
+* details of alternative services
+
+Optionally, use a `pattern_availability` page variable for setting the availability line:
+
+* a value of `closed` will show conventional text
+* a value of `replaced` will show conventional text
+* no value will show conventional text
+
+##### 'problem with this service' pattern
+
+Optionally, use page content for:
+
+* contact information
+* details of alternative services
 
 ### Using custom CSS/JS
 
@@ -118,7 +146,7 @@ All views use the `.html` extension. I.e. the view `page-not-found` should be re
 All views are namespaced using a `bas-style-kit/` directory - i.e. the view `page-not-found.html` should be referenced 
 as `bas-style-kit/page-not-found.html`.
 
-Within Jekyll views are implemented as layouts. To implement a view create a page with the relevant 'view layout.
+Within Jekyll, views are implemented as layouts. To use a view, create a page with the relevant 'view' layout.
 
 ```
 ---
@@ -126,7 +154,8 @@ layout: views/bas-style-kit/page-not-found
 ---
 ```
 
-**Note:** You do not need to add any page content.
+Views for some pattern variants can be used as-is, others require variables or page content to be set as well. See the
+[Page patterns](#page-patterns) section for more information.
 
 ### Layouts
 
@@ -344,6 +373,14 @@ $ docker-compose push app
 $ docker login docker-registry.data.bas.ac.uk
 ```
 
+#### Dependency vulnerability scanning
+
+To ensure the security of this project, and users of the Style Kit, all dependencies are checked against
+[Snyk](https://app.snyk.io/org/antarctica/project/a409ca29-86a3-45de-9838-5f1d7d1aca12) for vulnerabilities.
+
+Through [Continuous Integration](#continuous-integration), on each commit current dependencies are tested and a 
+snapshot uploaded to Snyk. This snapshot is then monitored for vulnerabilities.
+
 ### Jekyll plugins
 
 Additional Jekyll plugins (gems) can be used by listing them as dependencies in the `gems` option in `_config.yml`.
@@ -364,6 +401,12 @@ The `jekyll-theme-bas-style-kit.gemspec` file details the properties of the Gem
 **Note:** The `spec.files` parameter controls which files in this project are copied into the Gem. If a file is not 
 listed it won't be included. This is separate to the Git `.gitignore` file.
 
+## Testing
+
+### Continuous Integration
+
+The BAS GitLab instance is used for Continuous Integration using settings defined in `.gitlab-ci.yml`.
+
 ## GitHub mirror
 
 A read-only mirror of this project's repository is maintained on GitHub, to support Jekyll's automatic theme 
@@ -377,10 +420,11 @@ Before release:
 
 1. create a release branch
 2. remove `-develop` from the version in:
+  * `.gitlab-ci.yml`
   * `jekyll-theme-bas-style-kit.gemspec`
   * `docker-compose.yml`
   * `_data/bsk_jekyll_vars.json`
-3. push the app docker image [1]
+3. build and push the app docker image [1]
 4. if new config options have been set, update the usage section
 5. update screen-shot (width: 900px)
 6. close release in changelog
@@ -392,6 +436,7 @@ Before release:
 After release:
 
 1. bump the version with `-develop` as a prefix in:
+  * `.gitlab-ci.yml`
   * `jekyll-theme-bas-style-kit.gemspec`
   * `docker-compose.yml`
   * `_data/bsk_jekyll_vars.json`
@@ -418,8 +463,6 @@ $ gem push jekyll-theme-bas-style-kit-*.gem
 This project uses [issue tracking](https://trello.com/b/0Mhzizpk/bas-style-kit) to manage development of new 
 features/improvements and reporting bugs.
 
-**Note:** Read & write access to this issue tracker is restricted. Contact the project maintainer to request access.
-
 ## Feedback
 
 The maintainer of this project is the BAS Web & Applications Team, they can be contacted through the 

data/_data/bas-style-kit/bsk-css.yml

@@ -1,5 +1,5 @@
 ---
 -
-    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.5.0-alpha/css/bas-style-kit.min.css'
-    integrity: 'sha256-nWXiUZmHWfWNh1kXmFmOIeYXTJQL0BYUcuN0lZH+YRk='
+    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.5.0-beta/css/bas-style-kit.min.css'
+    integrity: 'sha256-7W+t8HHEKqkGFLCdHj4Fvaz6JAY6hB8T6B0ElpoepIU='
     type: 'remote'

data/_data/bas-style-kit/bsk-js.yml

@@ -8,6 +8,6 @@
     integrity: 'sha256-EareStqgZTnMUqLWtDkCa3SldvB8NPBY8u5C6ZUMWRc='
     type: 'remote'
 -
-    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.5.0-alpha/js/bas-style-kit.min.js'
-    integrity: 'sha256-hWgpo+9I3Nv3OcGXddejrZZNUNEzKBxaoxO/4IYImoM='
+    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.5.0-beta/js/bas-style-kit.min.js'
+    integrity: 'sha256-zqDnDK69Sm44Abb2ZWqiZ4uqrVFTQRajeflPB9lzGFE='
     type: 'remote'

data/_data/bas-style-kit/bsk-vars.yml

@@ -1,3 +1,3 @@
 ---
-theme_version: "0.6.0"
-bsk_version: "0.5.0-alpha"
+theme_version: "0.7.0"
+bsk_version: "0.5.0-beta"

data/_layouts/views/bas-style-kit/bsk--problem-with-service.html

@@ -0,0 +1,10 @@
+---
+layout: bas-style-kit/bsk--standard
+main_content_classes: bsk-pattern-problem-with-service
+title: Service unavailable
+---
+
+<h1 class="bsk-page-header">Sorry, there is a problem with this service</h1>
+<p class="bsk-lead">Please try again later.</p>
+
+{{ content }}

data/_layouts/views/bas-style-kit/bsk--service-unavailable.html

@@ -0,0 +1,20 @@
+---
+layout: bas-style-kit/bsk--standard
+main_content_classes: bsk-pattern-service-unavailable
+title: Service unavailable
+---
+
+<h1 class="bsk-page-header">Sorry, {{ site.bas_style_kit_jekyll_theme.attributes.site_brand.text }} is unavailable</h1>
+{% if page.pattern_availability %}
+  {% if page.pattern_availability == 'closed' %}
+    <p class="bsk-lead">This service has been {{ page.pattern_availability }} and can no longer be used.</p>
+  {% elsif page.pattern_availability == 'replaced' %}
+    <p class="bsk-lead">This service has been {{ page.pattern_availability }} and can no longer be used.</p>
+  {% else %}
+    <p class="bsk-lead">{{ page.pattern_availability }}</p>
+  {% endif %}
+{% else %}
+  <p class="bsk-lead">You will be able to use the service later.</p>
+{% endif %}
+
+{{ content }}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-bas-style-kit
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Felix Fennell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -19,7 +19,7 @@ dependencies:
         version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.3
+        version: 3.8.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.8.3
+        version: 3.8.5
 - !ruby/object:Gem::Dependency
   name: jekyll-data
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +171,8 @@ files:
 - _layouts/bas-style-kit/bsk--standard.html
 - _layouts/bas-style-kit/html.html
 - _layouts/views/bas-style-kit/bsk--page-not-found.html
-- _layouts/views/bas-style-kit/bsk--service-unavailable-basic.html
+- _layouts/views/bas-style-kit/bsk--problem-with-service.html
+- _layouts/views/bas-style-kit/bsk--service-unavailable.html
 - _sass/main.scss
 - assets/empty
 - screenshot.png

data/_layouts/views/bas-style-kit/bsk--service-unavailable-basic.html

@@ -1,8 +0,0 @@
----
-layout: bas-style-kit/bsk--standard
-main_content_classes: bsk-pattern-service-unavailable
-title: Service unavailable
----
-
-<h1 class="bsk-page-header">Service unavailable</h1>
-<p class="bsk-lead">You will be able to use the service later</p>