Skip to content

Latest commit

 

History

History
685 lines (435 loc) · 20.8 KB

CHANGELOG.md

File metadata and controls

685 lines (435 loc) · 20.8 KB
Raw

Changelog

  • We use the GOV.UK versioning guidelines.
  • Mark breaking changes with BREAKING:. Be sure to include instructions on how applications should be upgraded.
  • Include a link to your pull request.
  • Don't include changes that are purely internal. The CHANGELOG should be a useful summary for people upgrading their application, not a replication of the commit log.

9.13.0

  • Allow custom tags in <head> for admin layout (PR #480)
  • Adds taxonomy list component (PR #476)

9.12.2

  • Remove fixed 'name=button' attribute for buttons, to avoid them becoming a form param (PR #479)

9.12.1

  • Renames the publishing-app metatag to publishing-application, to be consistent with rendering-application (PR #475)

9.12.0

  • Adds publishing-app metatag (PR #470)

9.11.0

  • Add data attributes and spellcheck support for textarea component (PR #468)
  • Add data attributes support for input component (PR #469)
  • Relevant step by step should now be open inside simple smart answers (PR #472)

9.10.0

  • Enables bold styling in govspeak blocks, removes rich govspeak feature (PR #463)

9.9.1

  • Stop document list rendering titles as headings (PR #465)

9.9.0

  • Step by step component, Google snippet improvement (PR #461)
  • Add tabs component (PR #455)
  • Adds styling for singular related step by step navs (PR #458)
  • Add schema.org isPartOf links from articles to step by steps (PR #384)

9.8.0

  • Add error message and hint components based on GOV.UK Frontend (PR #446)
  • Update feedback component to use GOV.UK Frontend styles (PR #447)
  • Remove brackets from show/hide links (PR #448)
  • Add experimental inset text component based on GOV.UK Frontend (PR #449)
  • Add experimental textarea component based on GOV.UK Frontend (PR #450)
  • Add reset styles to document list component (PR #451)
  • Add tests for contextual breadcrumbs (PR #457)
  • Allow prioritising taxonomy breadcrumbs (PR #457)
  • Contextual breadcrumbs will show taxon based breadcrumbs if prioritise_taxon_breadcrumbs is true (defaults to false if not passed) (PR #457)

9.7.0

  • Update radio component to use GOV.UK Frontend styles (PR #433)
  • Update button component to use GOV.UK Frontend styles (PR #439)
  • Update back-link component to use GOV.UK Frontend styles (PR #440)
  • Add conditional reveal support for radios using GOV.UK Frontend scripts (PR #441)
  • Update input component to use GOV.UK Frontend styles (PR #442)
  • Update label component to use GOV.UK Frontend styles (PR #443)
  • Upgrade to the latest version of the Design System (PR #444)

9.6.0

  • Change breadcrumb class name (PR #435)
  • Add admin component for select (PR #434)
  • Extend the double dot problem solution (PR #432)

9.5.3

  • Improve metadata positioning in document list for rtl layouts (PR #429)
  • Add favicon to admin layout (PR #426)
  • Disable GOV.UK Frontend global styles (PR #427)
  • Replace the location URL sent to Google Analytics with one that masks email addresses (PR #428)

9.5.2

  • Attempt to improve Google snippet display (PR #424)
  • Add JavaScript detection, HTML5 shim and IE8 stylesheet to admin layout (PR #419)

9.5.1

  • Extends the page title component to add in margin_bottom (PR #419)
  • Fix the step by step title sizing and spacing on mobile when it appears as a footer (PR #413)

9.5.0

  • Improve step nav 'remember open steps' code (PR #406)
  • The Notice component now accepts blocks (PR #407)
  • Add experimental layout-header component based on GOV.UK Frontend (PR #408)
  • Add robots nofollow meta tag to admin layout (PR #409)
  • Improve the accessibility of the previous/next arrows on mainstream guides (PR #410)
  • Import and initialise GOV.UK Frontend scripts in the admin layout (PR #415)
  • Remove unneeded options from step nav component (PR #416)
  • Add experimental skip link component based on GOV.UK Frontend (PR #417)
  • Add CSRF meta tag to admin layout (PR #418)

9.4.0

  • Add experimental admin layout (PR #371)
  • Add the GOV.UK Frontend library to the gem (PR #398)
  • Allow linking to the Design System on component pages (PR #401)
  • Add govuk:analytics:organisations meta tag if the current page is an organisation (PR #397)
  • Move the highlight box component from Collections to the gem (PR #403)
  • Add experimental layout-footer component based on GOV.UK Frontend (PR #404)

9.3.6

  • Make heading tag optional on image card (PR #394)

9.3.5

  • Extend image card to support html description (PR #392)

9.3.4

  • Adjust metadata spacing in image card (PR #390)
  • Fix focus states in branding model (PR #389)

9.3.3

  • Add explicit Civil Service branding (PR #387)

9.3.2

  • Fix heading structure in feedback component (PR #385)

9.3.1

  • Allow image card component to not have main link (PR #382)

9.3.0

  • Add Metadata component from Static (PR #374)
  • Remove the special casing to run this component in Static (#379)

9.2.3

  • Add metadata to image card component (PR #377)
  • Modify share links component (PR #376)
  • Remove underline on image card title link (PR #375)

9.2.2

  • Add no10 to the branding model (PR #372)

9.2.1

  • Add no margin top option to translation nav (PR #368)

9.2.0

  • Add organisation logo component from static (PR #365)
  • Tweaks document list spacing for context text on smaller screens (PR #363)
  • Makes heading component use h2 by default (PR #362)

9.1.1

  • Add placeholders for pages that don't have an image (#359)
  • It is no longer allowed to pass in unsafe HTML into the Govspeak component (#356). This will result in a warning for now, but in a future version this will become an error.

How to upgrade

Change instances like this:

<%= render 'govuk_publishing_components/components/govspeak', content:
"<p>Foo #{bar}</p>" %>

into the following safe version:

<%= render 'govuk_publishing_components/components/govspeak' do %>
  <p>Foo <%= bar %></p>
<% end %>

This will prevent XSS vulnerabilities where bar is user input.

9.1.0

  • Extend the document list component (PR #355)
  • Remove policies from the taxonomy navigation sidebar (PR #357)

9.0.1

  • The component guide is no longer using Slimmer::GovukComponents, so this gem can now be used with Slimmer 13.0.0 (PR #353)

9.0.0

  • Import images for the button component from static (PR #338)
  • Add contents list component (PR #342)
  • BREAKING: Iterate share links component (PR #316)
  • Add image card component (PR #322)
  • Add notice component (PR #346)
  • Iterate contents list component (PR #351)
  • Add "person" schema to the Machine readable metadata component (PR #343)

Upgrade instructions

Replace the govspeak component by running the following:

find app/views -type f -print0 | xargs -0 sed -i '' 's/govuk_component\/govspeak/govuk_publishing_components\/components\/govspeak/

The share links component has changed fundamentally, the PR to update it in government-frontend is here and it isn't used in any other app yet.

8.2.0

  • Add better meta tags for third parties to the "Machine readable metadata" component. If you're using this component you should remove any canonical tags, OpenGraph tags and Twitter cards (#335)
  • Move the Title component from static (PR #324)
  • Move the Lead paragraph component from static (PR #325)
  • Move the Next and previous component from static (PR #329)
  • Move the Government navigation component from static (PR #334)
  • Add a Phase banner component to replace the Alpha/Beta banners in Static (PR #333)

Upgrade instructions

Replace the Title and Lead paragraph by running the following:

find app/views -type f -print0 | xargs -0 sed -i '' 's/govuk_component\/previous_and_next_navigation/govuk_publishing_components\/components\/previous_and_next_navigation/g'
find app/views -type f -print0 | xargs -0 sed -i '' 's/govuk_component\/title/govuk_publishing_components\/components\/title/g'
find app/views -type f -print0 | xargs -0 sed -i '' 's/govuk_component\/lead_paragraph/govuk_publishing_components\/components\/lead_paragraph/g'
find app/views -type f -print0 | xargs -0 sed -i '' 's/govuk_component\/government_navigation/govuk_publishing_components\/components\/government_navigation/g'

Your tests are likely to need updating as well.

8.1.0

  • Add the "Machine readable metadata" component (PR #318)

8.0.1

  • Fix a bug in subscription links attributes (PR #314)

8.0.0

  • BREAKING: The Button component no longer accepts unescaped HTML in the info_text, you'll have to call html_safe on it yourself. Probably the only affected application is frontend (#305)

  • BREAKING: Remove optional canonical meta tag (applications can add this tag explicitly if they need it)

  • BREAKING: Iterate heading component (PR #307)

  • Use new breadcrumbs component in contextual breadcrumbs (PR #313)

  • Add share links component (PR #308)

  • Translation nav add brand and tracking (PR #298)

  • Subscription links add colour and tracking (PR #299)

  • Add breadcrumbs component (PR #309) with schema data (PR #310)

7.3.0

  • Fix automated a11y test error with input (PR #303)
  • Add an optional canonical meta tag (PR #302)
  • Iterate branding model (PR #300)

7.2.0

  • Add department colours to components (PR #296)
  • Modify subscription links component (PR #294)

7.1.0

  • Add subscription links component (PR #290)
  • Add translation nav component (PR #289)
  • Make components CSS available to static in the component guide (PR #286)
  • Add heading component (PR #288)

7.0.0

  • BREAKING: Breaks the search component (at the moment only used by finder-frontend, so if won't be breaking for other apps).
  • Add an optional meta tag to signal dates should be stripped from data sent to Google Analytics. (#282)

6.7.0

  • Feedback component: send users a different survey (#280)
  • Add the Meta tags component. This component should be used in place of the "analytics meta tags" component in static. They have the same behaviour. (#278)

6.6.0

  • Show all mainstream browse pages in the sidebar (#273)
  • Show "normal" navigation in addition to step by step, make sidebars consistent (#275)
  • Simplify the internal logic of breadcrumbs and sidebar (#277)

6.5.0

  • Add button component (PR #271)

6.4.0

  • Move text for JS appended elements into step nav template (PR #263)
  • Add link to step nav research (PR #261)
  • Add search component (PR #267)

6.3.0

  • Remove bottom border for last item in document lists (PR #266)
  • Create success alert component (PR #254)
  • Add padding-top flag to inverse header

6.2.0

  • Always use the related links sidebar for travel advice (PR #264)
  • Add padding-top flag to inverse header

6.1.0

  • Add taxonomy navigation component, this will eventually supersede the static component. It may well be possible to merge with parts of the related navigation component as some of the functionality is shared between the two.

6.0.0

  • Fix visited link colour on focus for white feedback links (PR #239)
  • Fix input error colour (PR #241)
  • Add helper for generating breadcrumbs on taxon and taxonomy-based finder pages (PR #242)
  • BREAKING: merge the govuk_navigation_helpers gem into this project (#244). To upgrade, you will have to use the contextual navigation components (sidebar and breadcrumbs) .

5.7.0

  • Restore underline to step nav related links links (PR #236)
  • Improve substep creation (PR #231)
  • Improve spacing of inverse header to allow it to replace publication header component in government-frontend (PR #238)
  • Improve list and link classnames (PR #230)
  • Remove preventLinkFollowingForCurrentTab code (PR #229)

5.6.0

  • Restore 'referer' field to feedback component form submission (PR #232)
  • Create single breadrumb and sidebar contextual navigation components. Not a breaking change, but you can drop govuk_navigation_helpers as a dependency now.
  • You can now add require a single Javascript to include all components, just like CSS.

Replace all individual includes with:

# application.js
//= require govuk_publishing_components/all_components
  • Update document list component with smaller margin spacing (PR #234)

5.5.6

  • Add optional margin top flag for feedback component (PR #222)

5.5.5

  • Add optional flags for spacing around document list component (PR #217)

5.5.4

  • Make changes released in 5.5.3 backwards compatible.

5.5.3

  • Enforce white content in inverse component (PR #214).

5.5.2

  • Add full-width flag to remove left and right padding when using a full width page header (PR #212).
  • Update design of document list component for topic pages (PR #202)

5.5.1

  • Fix bug in related_navigation helper that did not gracefully handle ordered related items that aren't tagged to a mainstream browse page (PR #210).

5.5.0

  • Add new inverse header component (PR #203).

5.4.1

  • Remove worldwide organisation links from the payload used by the related_navigation component, as they're not required.
  • Fix bug where the correct number of mainstream browse pages weren't displaying in the related_navigation component in cases where a grandparent mainstream browse page is present (PR #205).

5.4.0

  • Add document_list component from government-frontend, so that it can be used by collections. This is not a breaking change, but it is not backwards compatible with previous versions of the component. (PR #199)

5.3.0

  • Add step by step navigation component helpers

5.2.3

  • Feedback: add role button to links (PR #193)
  • Feedback: fix styling on older layouts (PR #194)

5.2.2

  • Feedback: add spacing above component (PR #191)
  • Feedback: set font sizes (PR #190)
  • Feedback: improve link spacing (PR #188)

5.2.1

  • Feedback: changes to the event tracking (PR #184)
  • Related Navigation: accessibility improvements (PR #182)

5.2.0

  • Add related_navigation component from government-frontend, so that it can also be used by frontend. This is not a breaking change, but it is not backwards compatible with previous versions of the component. (PR #164)

5.1.3

  • Accessibility fixes for the feedback component (PR #173)

5.1.2

  • Fix feedback component when JS disabled (PR #175)
  • Step nav accessibility changes (PR #160)

5.1.1

  • Improvements for the feedback component on mobile (PR #168 and #169)

5.1.0

  • Support other a customisable type attribute for input component (PR #165)
  • Add unique tracking to all GA events on step nav components (PR #162)
  • Add feedback component (PR #163)

5.0.0

  • BREAKING: Rename task list components (PR #156), breaking change

  • BREAKING: Remove task list groups (PR #154), breaking change

  • To include the CSS for all components in the gem, you can now do:

## application.scss
@import "govuk_publishing_components/all_components";

And for print styles

## print.scss
@import "govuk_publishing_components/all_components_print";

4.1.1

  • Fix Heroku review apps (PR #149)
  • Remove doubly included stylesheets (PR #148)
  • Update installation instructions (PR #147)
  • Refactor task list component code (PR #143)
  • Fix task list related namespace (PR #141)

4.1.0

  • Move error summary component into gem (PR #138)

4.0.0

  • BREAKING: Namespace hosted components with govuk_publishing_components (PR #136)
    • References to components hosted in gem need to point to govuk_publishing_components/components rather than /components. This includes stylesheets, partials and javascripts.
    • References to task list print styles must be updated to point at the new /print subdirectory

3.3.0

  • Move back link component in gem (PR #131)

3.2.1

  • Fix radio component not including welsh translation (PR #128)

3.2.0

  • Remove unneeded CSS from component guide (PR #126)
  • Add heading element into task list component and change get help link behaviour (PR #113)
  • Improve task list print styles (PR #125)
  • Move form components into gem (PR #116)

3.1.0

  • Add support for components which accept a block (PR #117)

3.0.3

  • Sort components by name in the component list (PR #114)
  • Remove ES6 syntax (replace const with var) to fix uglifier errors when compiling assets (PR #114)
  • Add procfile to allow running the dummy app (PR #115)

3.0.2

  • Add styles for active link where active link is in a choice list, and fix focus states on same in Firefox (PR #110)

3.0.1

  • Fix indent bug and number white background bug on newer iphones, overflow issue causing problem when text zoomed, fallback for older iphones, and improve print styles (PR #108)

3.0.0

  • Allow the gem to host components (PR #105)
  • Added task_list, task_list_header and task_list_related components which were in Static. It's not a breaking change to this gem to include them, but they are not backwardly compatible with previous versions of the components. (PR #105)
  • Work to tidy up the dummy application to more closely represent GOV.UK rails apps (PR #104)

2.0.0

BREAKING: breaking release, should be easy to migrate.

Previously with aXe we excluded all warnings relating to duplicate ids, this release allows you to exclude any rules you'd like to but removes this default. Any components that relied on this default will need this rule adding to their documentation file.

See test/.../docs/test-component-with-duplicate-ids.yml for an example of how this looks. (PR #101)

1.12.1

  • Use lead paragraph component (PR #95)

1.12.0

  • Add warnings and fail tests when no accessibility criteria are defined for a component (PR #90)

1.11.0

  • Add task to check for components existing without corresponding docs (PR #86)
  • Render aXe violations in component guide (PR #82)
  • Remove component guide hover styles (PR #81)

1.10.0

  • Add visual diff tool (PR #61)
  • Disable duplicate ID aXe rule (PR #80)

1.9.0

  • Use local govuk_components for static's component guide (PR #74)

1.8.2

  • Force cookie and survey banner styling on (PR #76)

1.8.1

  • Remove cookie and survey banner using CSS instead of setting cookies (PR #71)
  • Fix syntax highlighting styles (PR #70 and #73)

1.8.0

  • Add integration tests for apps to use when testing their component guide (PR #68)

1.7.0

  • Remove cookie and survey banners from the component guide to allow visual diff tool comparison (PR #65)
  • Make it clear when aXe has failed, succeeded or found errors (PR #64)

1.6.0

  • Set X-Frame-Options header to allowall, to allow inclusion of component guide in iFrames (PR #53)
  • Add shared accessibility criteria in component guide pages(PR #58)

1.5.0

  • Add links to component guide homepage linking to conventions and principles (PR #52)

1.4.0

  • Add dark_background context to examples (PR #49)

1.3.0

  • Add optional descriptions to examples (PR #47)

1.2.0

  • Exposes incomplete warnings from aXe in component guide pages (PR #40)

1.1.0

  • Allow gem to be used with static (PR #43)

1.0.1

Fixes issue around page scrolling unexpectedly.

  • Add context param to aXe so that options are passed correctly

1.0.0

All documentation will need updating when upgrading (see PR #37):

  • Rename fixtures to examples in YAML documentation
  • Nest example data within a named block to give examples more features

Steps to upgrade:

  • Rename fixtures in YAML files to "examples"
  • Nest data for each example in a data: block
fixtures:
  some_name:
    some_param: some_value

becomes:

examples:
  some_name:
    data:
      some_param: some_value

0.9.0

  • Add aXe accessibility testing javascript to component guide pages (PR #33)
  • Mark strings in YAML fixtures as HTML safe (PR #36)
  • Refactor internal structs to use classes (PR #34)

0.8.0

  • Add preview pages to component guide, to allow components to be viewed in isolation (PR #27)
  • Includes addition of 'preview all' and 'preview' pages

0.7.0

  • Relax required version of dependencies to allow gem to work with a Rails 5.1 project (PR #29)
  • Fix text in generator yml template (PR #30)

0.6.0

  • Add component generator (PR #24)

0.5.0

  • Allow print styles to be shown in guide (PR #19)

0.4.2

  • Relax slimmer version (PR #20)

0.4.1

  • Fix overlap issue with code snippets (PR #15)

0.4.0

  • Add syntax highlighting to code block showing how to call a component (PR #10)

0.3.1

  • Remove ApplicationRecord files from gem (PR #8)

0.3.0

  • Include body and accessibility acceptance criteria on component pages (PR #6)
  • Fix load ordering bug which would sometimes cause the component guide to use the app’s layout (PR #5)

0.2.0

  • Allow components to use application view helpers (PR #3)

0.1.0

  • Initial release