govuk_tech_docs 5.0.2 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3773129390067305ad3b391de58affa2e676c03ebef9fdee22b6bb06b505a8ca
-  data.tar.gz: 26de82c078bdcc632ef000cc99be7042fbf5f5ff2d002708ca630a590c112e1e
+  metadata.gz: 6dc363343ebff60652f16de327d4bc64c8c7d043ca22de573699c62fd177e354
+  data.tar.gz: ff3c5f3505a3592592c088d0e652279eaba401a886fb76bf100e29e266b19d64
 SHA512:
-  metadata.gz: fe7f6dd7f27f110961c92d837b9e26b165da23db2d7ab7b149839e24215485ad3501db19d38f2cc3217b8a80a23b5e0bd0ac00ae04aad75463dee4688baeef76
-  data.tar.gz: 2d5927b74dc6a1e4fe2abd69933142ff5153414319e887c086162e47d050f30613444144c5b89a51777627e05cb903e64a233bc59b984d3f2f2854e0e36ce88d
+  metadata.gz: 68280ebd9b54a3b89962caa936fdda0754459284ac714e5399af7d785f997a52cf4c65c71f0f8fc3dd402a03c38705a8d3b4f0a859ce5590492be3be8c37265b
+  data.tar.gz: bb17570b442df5edffacbb28f4fa5837b8066b63a30cec06ba6952f0bf2f50ea6bb0be536828c08bce108275d4ecd964e0ab768ba1a420d456bd0d68bc83dd78

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## Unreleased
 
+### New Features
+
+- [Adds support for GA4 as a separate tracking parameter from Universal Analytics](https://github.com/alphagov/tech-docs-gem/pull/350)
+
+NB: [Universal Analytics is now gone](https://support.google.com/analytics/answer/11583528?hl=en) so anyone still using the older approach is likely facing broken analytics, or has developed a workaround.
+We'll return at a later date with a major breaking change that deprecates UA code.
+
+## 5.1.0
+
+### New features
+
+- [Add GA4 support](https://github.com/alphagov/tech-docs-gem/pull/350)
+
+### Fixes
+
+- [Fix syntax highlighting by pinning middleman-syntax to v3.6+](https://github.com/alphagov/tech-docs-gem/pull/427)
+
 ## 5.0.2
 
 ### Fixes
@@ -60,7 +77,7 @@ To use the service_link at the start of the path to the favicon images, you need
 
 - [Allow non-GOV.UK favicon and opengraph assets](https://github.com/alphagov/tech-docs-gem/pull/387)
 
-To use a non-crown assets, you need to 
+To use a non-crown assets, you need to
 - add `favicon.ico`, `favicon.svg` and `opengraph-image.png` to your `source/images` folder.
 - set `show_govuk_logo: false`
 
@@ -158,22 +175,22 @@ You can now [configure your Tech Docs Template (TDT) to build your documentation
 
 Thanks [@eddgrant](https://github.com/eddgrant) for contributing this feature and the associated fixes.
 
-This change was introduced in [pull request #291: Support sites deployed on paths other than "/" (by generating relative links)](https://github.com/alphagov/tech-docs-gem/pull/291). 
+This change was introduced in [pull request #291: Support sites deployed on paths other than "/" (by generating relative links)](https://github.com/alphagov/tech-docs-gem/pull/291).
 
 ## 3.1.0
 
 ### New features
 
-There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.0.0. 
+There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.0.0.
 
 1. Update your documentation site to use the latest template version. You can [follow the TDT guidance on using the latest template version](https://tdt-documentation.london.cloudapps.digital/maintain_project/use_latest_template/).
-2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the [GOV.UK Frontend 4.0.0 release note](https://github.com/alphagov/govuk-frontend/releases/tag/v4.0.0) for more information. 
+2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the [GOV.UK Frontend 4.0.0 release note](https://github.com/alphagov/govuk-frontend/releases/tag/v4.0.0) for more information.
 
 ## 3.0.1
 
 ### Fixes
 
-We’ve made the following fixes to the tech docs gem in [pull request #281: Don't break TOC when OpenAPI description includes headers](https://github.com/alphagov/tech-docs-gem/pull/281): 
+We’ve made the following fixes to the tech docs gem in [pull request #281: Don't break TOC when OpenAPI description includes headers](https://github.com/alphagov/tech-docs-gem/pull/281):
 
 * we now render OpenAPI Markdown with the same Markdown renderer as other documents
 * table of contents (TOC) uses `TechDocsHTMLRenderer` to render the headings with IDs

data/example/config/tech-docs.yml

@@ -19,7 +19,10 @@ footer_links:
   Accessibility: /hidden-page.html
   Hidden Page: /hidden-page.html
 
-# Tracking ID from Google Analytics (e.g. UA-XXXX-Y)
+# Tracking ID (if using GA4 e.g G-XXXXXX)
+ga4_tracking_id:
+
+# Tracking ID from Google Universal Analytics (e.g. UA-XXXX-Y)
 ga_tracking_id:
 
 # Enable multipage navigation in the sidebar

data/govuk_tech_docs.gemspec

@@ -48,7 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "middleman-livereload"
   spec.add_dependency "middleman-search-gds"
   spec.add_dependency "middleman-sprockets", "~> 4.0.0"
-  spec.add_dependency "middleman-syntax", "~> 3.4"
+  spec.add_dependency "middleman-syntax", "~> 3.6"
   spec.add_dependency "mutex_m" # TODO: remove once activesupport declares this itself.
   spec.add_dependency "nokogiri"
   spec.add_dependency "openapi3_parser", "~> 0.9.0"

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "5.0.2".freeze
+  VERSION = "5.1.0".freeze
 end

data/lib/source/layouts/_analytics_head.erb

@@ -0,0 +1,10 @@
+<% if config[:tech_docs][:ga4_tracking_id].is_a?(String) && !config[:tech_docs][:ga4_tracking_id].empty? %>
+  <!-- Google tag (gtag.js) -->
+  <script async src="https://www.googletagmanager.com/gtag/js?id=<%= config[:tech_docs][:ga4_tracking_id]%>"></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag('js', new Date());
+    gtag('config', '<%= config[:tech_docs][:ga4_tracking_id] %>');
+  </script>
+<% end %>

data/lib/source/layouts/core.erb

@@ -1,6 +1,8 @@
 <!doctype html>
 <html lang="en" class="govuk-template <%= config[:tech_docs][:show_govuk_logo] ? 'govuk-template--rebranded ' : '' %>no-js">
   <head>
+    <%= partial 'layouts/analytics_head' %>
+
     <meta content="IE=edge" http-equiv="X-UA-Compatible">
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.1.0
 platform: ruby
 authors:
 - Government Digital Service
@@ -197,14 +197,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: mutex_m
   requirement: !ruby/object:Gem::Requirement
@@ -481,6 +481,7 @@ files:
 - lib/source/images/search-button.png
 - lib/source/images/search-result-caret.svg
 - lib/source/layouts/_analytics.erb
+- lib/source/layouts/_analytics_head.erb
 - lib/source/layouts/_footer.erb
 - lib/source/layouts/_header.erb
 - lib/source/layouts/_page_review.erb
@@ -729,7 +730,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Gem to distribute the GOV.UK Tech Docs Template
 test_files: []