CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.8.0 - 2021-07-01

Changed

• Re-generate Javascript and CSS when building gem (#101).
• Javascript and CSS preprocessing tools updated to latest versions (#101).
• Use Yarn to manage Javascript packages (#101).
• Commit dependency lock-files to git to ensure repeatable builds (#101).
• Upgrade urijs from 1.17.1 to 1.19.6 (#102).
• Upgrade prismjs from 1.4.1 to 1.24.0 (#105).

Removed

• Generated Javascript and CSS is removed from the git repository (#101).

0.7.0 - 2021-06-11

Added

• Support sprockets version 4 (#98).

Changed

• Moved guide asset compilation configuration to lib/guide/engine.rb, as recommended by the Rails Engine Guide (#100).

Removed

• The sass-rails dependency is removed (#99).

0.6.1 - 2021-06-10

Fixed

• Custom javascript and CSS is included in HTML scenarios (#97).

0.6.0 - 2021-06-09

Added

• Add actionpack and actionview as explicit dependencies (#94). Previously, these were transitive dependencies.
• Record project metadata in the gem spec (#96).

Changed

• CI build moved to run on GitHub Actions (#91).
• CI test suite runs against the latest versions of Nodejs, Ruby, and Rails (#92).

Removed

• Removed support for Ruby 2.5 and lower (#94). Ruby 2.6 and higher is required.
• Removed support for Rails 5.1 and lower (#94). Rails 5.2 and higher is required.

Fixed

• Fixed scenarios not rendering with Rails 6 (#93). Please ensure formats are specified using symbols when defining structures:

   def formats
  -  ['html', 'text']
  +  [:html, :text]
   end
  
   def layout_templates
     {
  -    'html' => 'layouts/my_html_layout',
  -    'text' => 'layouts/my_text_layout'
  +    html: 'layouts/my_html_layout',
  +    text: 'layouts/my_text_layout'
     }
   end

• Fixed links not using engine mount point (#95).

• The README.md file is included in the gem (#96).

0.5.0 - 2021-03-25

Added

• Move Buildkite CI configuration to code (#86).
• Relaxed rails dependency constraints (#87). Allow using version 6 or greater.

Changed

• Replace rails dependency with dependency on railties, activemodel, and sprockets-rails (#89).

0.4.1 - 2018-08-09

Changed

• Replace render text: 'plain text' with render plain: 'plain text' (#85).

0.4.0 - 2017-12-14

Added

• Support for Rails 5 (#82, #83):
  • Relax the dependency constraints to allow rails 5.x
  • Update the test suite to run against rails 4.2 and 5.1

0.3.2 - 2017-03-26

Removed

• Removed explicit support for Markdown (#81). Downstream applications can implement this if desired.

0.3.1 - 2017-02-23

Added

• First public release!