govuk_tech_docs 6.2.1 → 6.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62edf3302d34a29ee8024355838612a76a1a28bf427875b03d3ac2c29d1f841b
-  data.tar.gz: 1d1e7af654e7b0b6cba51267c5022f57c71cfa0dafa8d41102fee162c7bb8714
+  metadata.gz: 87a42820b4c7571de0db48c86a823c8510520cfd91e7504e33b82d503eaad139
+  data.tar.gz: 826755aa09f87263317723aead5ef82cd456b74863f5492c72eea512099d5737
 SHA512:
-  metadata.gz: b5787bc5a26543f7408f041d801eb8025b47d6d414ac4f0154ccb539b30bfefec8ad39fcfe9106331c47d0c8296c9a22f94ca89d44b1e83de710ec1727d4c3ce
-  data.tar.gz: f2ac22d61f066089ef8984f2a7bf2c0f183742e37c92cf7db28d91f2d0ae2f7f1bc311edc9ca5db90055635cf9a24c0cd629cbdf39d2b84d60438483e5255df9
+  metadata.gz: e3e3f3da335130b1241dd526bc04bf17b9f14c6ed41aec60d4447b847ec6cb2e762a29983edcc4ee251e7adb944f5bd7f8331f147e3c3bd9cf5890867d50d552
+  data.tar.gz: 0512cb5a6002f61c3ec370e77d95b2c008001ebd2a1686f216d7b8cafe1cc97c1a13e40855d0a4eeba5ba27c1d983a743b9f1413a12d8ef263a4591785a19a9b

data/.github/dependabot.yml

@@ -7,14 +7,23 @@ version: 2
 updates:
   # 1. Update Ruby dependencies (Gemfile/gemspec) in the root
   - package-ecosystem: "bundler"
-    directory: "/" 
+    directory: "/"
     schedule:
       interval: "weekly"
       day: "monday"
       time: "06:00"
     commit-message:
       prefix: chore
-    open-pull-requests-limit: 5
+    open-pull-requests-limit: 3
+    groups:
+      prod-safe-updates:
+        dependency-type: "production"
+        patterns:
+          - "*"
+        update-types:
+          - "minor"
+          - "patch"
+
 
   # 2. Update GitHub Actions (keeps your CI workflows secure)
   - package-ecosystem: "github-actions"
@@ -29,26 +38,29 @@ updates:
       github-actions-updates:
         patterns:
           - "*"
+
   - package-ecosystem: "npm"
     directory: "/" 
     schedule:
       interval: "weekly"
       day: "monday"
       time: "06:00"
-    open-pull-requests-limit: 5
-    
+    open-pull-requests-limit: 3
     groups:
       # Group all "development" dependencies (linters, test runners, etc.)
       dev-dependencies:
         dependency-type: "development"
+        patterns:
+          - "*"
         update-types:
           - "patch"
           - "minor"
-      
       # Group all "production" dependencies (react, express, etc.) 
       # but ONLY for minor/patch versions to avoid breaking changes
       prod-safe-updates:
         dependency-type: "production"
+        patterns:
+          - "*"
         update-types:
           - "patch"
           - "minor"

data/.github/workflows/dependency-review.yaml

@@ -1,5 +1,9 @@
 name: 'Dependency Review'
-on: [pull_request]
+on:
+  pull_request:
+    branches: [ "main" ]
+  push:
+    branches: [ "main" ]
 
 permissions:
   contents: read
@@ -9,9 +13,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v6
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v4
+        uses: actions/dependency-review-action@a1d282b36b6f3519aa1f3fc636f609c47dddb294 #5.0.0
         with:
+          # If it's a PR, use the target branch. If it's a push, use 'main'.
+          base-ref: ${{ github.event.pull_request.base.ref || 'main' }}
+          # If it's a PR, use the source branch. If it's a push, use the current commit.
+          head-ref: ${{ github.event.pull_request.head.ref || github.sha }}
           fail-on-severity: high
           show-patched-versions: true

data/.github/workflows/publish.yaml

@@ -16,11 +16,11 @@ jobs:
       go: ${{ steps.gem_version.outputs.new_version }}
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           show-progress: false
 
-      - uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@6aaa311d81eba98ae12eaffbcb63296ace0efcde # v1.307.0
         with:
           ruby-version: '3'
 
@@ -48,16 +48,16 @@ jobs:
     if: needs.pre.outputs.go == 'true'
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           show-progress: false
 
-      - uses: actions/setup-node@v6
+      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
         with:
           node-version-file: '.nvmrc'
           cache: 'npm'
 
-      - uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@6aaa311d81eba98ae12eaffbcb63296ace0efcde # v1.307.0
         with:
           ruby-version: '3'
           bundler-cache: true

data/.github/workflows/test.yaml

@@ -1,10 +1,10 @@
 name: Test
 
 on:
-  push:
-    branches:
-      - main
   pull_request:
+    branches: [ "main" ]
+  push:
+    branches: [ "main" ]
   workflow_dispatch:
 
 jobs:
@@ -17,16 +17,16 @@ jobs:
         ruby: ['3.3', '3.4', '4.0']
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           show-progress: false
 
-      - uses: actions/setup-node@v6
+      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
         with:
           node-version-file: '.nvmrc'
           cache: 'npm'
 
-      - uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@6aaa311d81eba98ae12eaffbcb63296ace0efcde # v1.307.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 6.2.3
+
+- [Fix TOC sidebar not scrolling to active item on page load](https://github.com/alphagov/tech-docs-gem/pull/480)
+
+## 6.2.2
+
+- Update [govuk_tech_docs.gemspec](govuk_tech_docs.gemspec) to only run `npm` if `npm` is installed.  Allows gem versions scans to complete properly.
+
 ## 6.2.1
 
 - [Fix comments in code blocks being hard to read](https://github.com/alphagov/tech-docs-gem/pull/477) 

data/govuk_tech_docs.gemspec

@@ -4,11 +4,17 @@ lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "govuk_tech_docs/version"
 
-`npm ci`
-abort "npm ci failed" unless $CHILD_STATUS.success?
-
-unless File.exist?("node_modules/govuk-frontend/dist/govuk/_base.scss")
-  abort "govuk-frontend npm package not installed"
+# npm is not necessarily expected in a gemspec, this makes a big assumption about the environment
+# Additionally, for actions such as evaluating the gemspec (e.g. for vulnerability patching) we do not actaully want npm packages
+# We will move these sections into specific rake tasks when we get a chance
+if system("which npm > /dev/null 2>&1")
+  `npm ci`
+  abort "npm ci failed to run" unless $CHILD_STATUS.success?
+  unless File.exist?("node_modules/govuk-frontend/dist/govuk/_base.scss")
+    abort "govuk-frontend and other npm packages not installed"
+  end
+else
+  warn "npm is not available, no assets will be generated.  If you did not expect this please confirm your environment settings."
 end
 
 Gem::Specification.new do |spec|

data/lib/assets/javascripts/_modules/in-page-navigation.js

@@ -2,13 +2,11 @@
   'use strict'
 
   Modules.InPageNavigation = function InPageNavigation () {
-    var $tocPane
-    var $contentPane
-    var $tocItems
-    var $targets
+    let $contentPane
+    let $tocItems
+    let $targets
 
     this.start = function start ($element) {
-      $tocPane = $element.find('.app-pane__toc')
       $contentPane = $element.find('.app-pane__content')
       $tocItems = $('.js-toc-list').find('a')
       $targets = $contentPane.find('[id]')
@@ -29,7 +27,7 @@
         } else {
           // Store the initial position so that we can restore it even if we
           // never scroll.
-          handleInitialLoadEvent()
+          window.requestAnimationFrame(handleInitialLoadEvent)
         }
       }
     }
@@ -41,7 +39,7 @@
     }
 
     function handleInitialLoadEvent () {
-      var fragment = fragmentForTargetElement()
+      let fragment = fragmentForTargetElement()
 
       if (!fragment) {
         fragment = fragmentForFirstElementInView()
@@ -51,7 +49,7 @@
     }
 
     function handleScrollEvent () {
-      var fragment = fragmentForFirstElementInView()
+      const fragment = fragmentForFirstElementInView()
 
       storeCurrentPositionInHistoryApi(fragment)
       highlightActiveItemInToc(fragment)
@@ -70,8 +68,8 @@
     function highlightActiveItemInToc (fragment) {
       // Navigation items for single page navigation don't necessarily include the path name, but
       // navigation items for multipage navigation items do include it. This checks for either case.
-      var $activeTocItem = $tocItems.filter(function (_) {
-        var url = new URL($(this).attr('href'), window.location.href)
+      let $activeTocItem = $tocItems.filter(function (_) {
+        const url = new URL($(this).attr('href'), window.location.href)
         return url.href === window.location.href
       })
 
@@ -79,35 +77,19 @@
       // Check to see if any nav items contain just the path name.
       if (!$activeTocItem.get(0)) {
         $activeTocItem = $tocItems.filter(function (_) {
-          var url = new URL($(this).attr('href'), window.location.href)
+          const url = new URL($(this).attr('href'), window.location.href)
           return url.hash === '' && url.pathname === window.location.pathname
         })
       }
       if ($activeTocItem.get(0)) {
         $tocItems.removeClass('toc-link--in-view')
         $activeTocItem.addClass('toc-link--in-view')
-        scrollTocToActiveItem($activeTocItem)
+        scrollTocToActiveItem($activeTocItem.get(0))
       }
     }
 
-    function scrollTocToActiveItem ($activeTocItem) {
-      var paneHeight = $tocPane.height()
-      var linkTop = $activeTocItem.position().top
-      var linkBottom = linkTop + $activeTocItem.outerHeight()
-
-      var offset = null
-
-      if (linkTop < 0) {
-        offset = linkTop
-      } else if (linkBottom >= paneHeight) {
-        offset = -(paneHeight - linkBottom)
-      } else {
-        return
-      }
-
-      var newScrollTop = $tocPane.scrollTop() + offset
-
-      $tocPane.scrollTop(newScrollTop)
+    function scrollTocToActiveItem (activeTocElement) {
+      activeTocElement.scrollIntoView({ block: 'nearest', inline: 'nearest' })
     }
 
     function fragmentForTargetElement () {
@@ -115,14 +97,14 @@
     }
 
     function fragmentForFirstElementInView () {
-      var result = null
+      let result = null
 
       $($targets.get().reverse()).each(function checkIfInView (index) {
         if (result) {
           return
         }
 
-        var $this = $(this)
+        const $this = $(this)
 
         if (Math.floor($this.position().top) <= 0) {
           result = $this

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "6.2.1".freeze
+  VERSION = "6.2.3".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 6.2.1
+  version: 6.2.3
 platform: ruby
 authors:
 - Government Digital Service