govuk_tech_docs 6.3.0 → 6.4.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14e31166315775ce210071e6369ceed8e305111f6667a75e9dfb56216879616
-  data.tar.gz: 79b82c15e10ac592f12fa635db39838d0676cb86abcc2a33e654ed22cbe2cd7c
+  metadata.gz: 4bdc6cdd2fc1c883f3d0e5a3c25b3fce362207729376181436ce17d19ecf8bf0
+  data.tar.gz: 1eced113c1c927f274f513a2a84edfa5bc590e445845cf9b55af852d7ebe7fad
 SHA512:
-  metadata.gz: 8fea921277de197457d49755c9c7ddee7cf60cfcff80e599304824a47b6f094e58947a7673f849719b00a730a7d2a6b4c9e5933b5c70b5d0d9b627d797c30cf2
-  data.tar.gz: 2009a67d569ae66cfeda08739e7223a74da595bdba126a9bb0f440bb5c5704ec90e8285ea543a4943ea794350b7fdffafb0e230f2aa308d8c71d9db1ed24fc3b
+  metadata.gz: bead1914b3ad00993bcf519a1931d70463e5a22c5f3c5665355ac39e24610b027ba54dc729f47142568af2ccfc5d3192c631e56adcedaa7c14f240a8eb3eb8f8
+  data.tar.gz: cabbdfc6bb527131c71a52be3bde21545967cb6afaa3797e35612c2fcf0a513268594d9cf0a773fa2dc735082d95390546c1374634745d850e7242765f30cd42

data/.github/workflows/build-middleman-artifact.yaml

@@ -15,15 +15,15 @@ jobs:
         working-directory: documentation
     steps:
       - name: Checkout repository
-        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           fetch-depth: 0
       - name: Setup Node
-        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
+        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
         with:
           node-version-file: 'documentation/.nvmrc'
       - name: Setup Ruby
-        uses: ruby/setup-ruby@89f90524b88a01fe6e0b732220432cc6142926af # v1.313.0
+        uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           bundler-cache: true
           working-directory: documentation

data/.github/workflows/check-documentation-updates.yaml

@@ -0,0 +1,32 @@
+name: check-documentation-updates
+
+on:
+  workflow_call:
+    outputs:
+      documentation-updated:
+        value: ${{ jobs.check-documentation-updates.outputs.documentation-updated }}
+
+
+jobs:
+  check-documentation-updates:
+    runs-on: ubuntu-latest
+    outputs:
+      documentation-updated: ${{ steps.documentation_updated.outputs.documentation-updated }}
+
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          show-progress: false
+
+      - uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
+        with:
+          ruby-version: '3'
+
+      - name: Documentation updated
+        id: documentation_updated
+        run: |
+          if git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -q '^documentation/'; then
+            echo "documentation-updated=true" >> $GITHUB_OUTPUT
+          else
+            echo "documentation-updated=false" >> $GITHUB_OUTPUT
+          fi

data/.github/workflows/check-gem-version.yaml

@@ -0,0 +1,36 @@
+name: check-gem-version
+on:
+  workflow_call:
+    outputs:
+      version-changed:
+        value: ${{ jobs.check-gem-version.outputs.version-changed }}
+
+
+jobs:
+  check-gem-version:
+    runs-on: ubuntu-latest
+    outputs:
+      version-changed: ${{ steps.gem_version.outputs.version-changed }}
+
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          show-progress: false
+
+      - uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
+        with:
+          ruby-version: '3'
+
+      - name: Gem version changed
+        id: gem_version
+        run: |
+          gem_version=$(ruby -r rubygems -e "puts Gem::Specification::load('govuk_tech_docs.gemspec').version")
+          echo "gem_version=$gem_version" >> "$GITHUB_OUTPUT"
+  
+          if git fetch origin "refs/tags/v$gem_version" >/dev/null 2>&1
+          then
+            echo "Tag 'v$gem_version' already exists"
+            echo "version-changed=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "version-changed=true" >> "$GITHUB_OUTPUT"
+          fi

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

@@ -1,9 +1,6 @@
 name: 'Dependency Review'
 on:
-  pull_request:
-    branches: [ "main" ]
-  push:
-    branches: [ "main" ]
+  workflow_call:
 
 permissions:
   contents: read
@@ -13,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
       - name: 'Dependency Review'
         uses: actions/dependency-review-action@a1d282b36b6f3519aa1f3fc636f609c47dddb294 #5.0.0
         with:

data/.github/workflows/pipeline.yaml

@@ -0,0 +1,50 @@
+name: pipeline
+on:
+  pull_request:
+    branches: [ "main"]
+  push:
+    branches: [ "main"]
+
+jobs:
+  dependency-review:
+    uses: ./.github/workflows/dependency-review.yaml
+    permissions:
+      contents: read
+
+  test:
+    needs: dependency-review
+    uses: ./.github/workflows/test.yaml
+    permissions:
+      contents: read          # Allows the action to check out your repository code
+      pull-requests: write    # Allows the action to comment on or update the Dependabot PR
+      statuses: write         # Allows the action to post pass/fail build statuses
+
+  check-gem-version:
+    needs: test
+    uses: ./.github/workflows/check-gem-version.yaml
+
+  publish-gem:
+    needs: check-gem-version
+    if: github.event_name == 'push' && needs.check-gem-version.outputs.version-changed == 'true'
+    with:
+      new-gem-version: true
+    uses: ./.github/workflows/publish-gem.yaml
+    permissions:
+      contents: write  # needed to be able to tag the release
+
+  check-documentation-updates:
+     needs: publish-gem
+     if: |
+       github.event_name == 'push' && 
+       always() && 
+       (needs.publish-gem.result == 'success' || needs.publish-gem.result == 'skipped')
+     uses: ./.github/workflows/check-documentation-updates.yaml
+
+  publish-github-pages:
+    needs: check-documentation-updates
+    if: github.event_name == 'push' && needs.check-documentation-updates.outputs.documentation-updated == 'true'
+    uses: ./.github/workflows/publish-github-pages.yaml
+    permissions:
+      contents: read
+      pages: write
+      id-token: write

data/.github/workflows/publish-gem.yaml

@@ -0,0 +1,61 @@
+name: Publish
+
+on:
+  workflow_call:
+    inputs:
+      new-gem-version:
+        default: false
+        type: boolean
+  
+  workflow_dispatch:
+    inputs:
+      new-gem-version:
+        description: 'Force publish gem?'
+        default: false
+        type: boolean
+
+concurrency: rubygems
+
+jobs:
+  deploy:
+    name: Publish Ruby Gem
+    environment: rubygems
+    permissions:
+      contents: write  # needed to be able to tag the release
+    runs-on: ubuntu-latest
+    if: inputs.new-gem-version
+
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          show-progress: false
+
+      - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
+        with:
+          ruby-version: '3'
+          bundler-cache: true
+
+      - name: Publish
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        run: |
+          mkdir -p ~/.gem
+
+          cat << EOF > ~/.gem/credentials
+          ---
+          :rubygems_api_key: ${RUBYGEMS_API_KEY}
+          EOF
+
+          chmod 0600 ~/.gem/credentials
+
+          # tag will be associated with github-actions bot user, see
+          # https://github.community/t/github-actions-bot-email-address/17204
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+          bundle exec rake release

data/.github/workflows/{deploy-to-pages.yaml → publish-github-pages.yaml}

@@ -1,8 +1,7 @@
-name: 'Deploy to GitHub Pages'
+name: Publish GitHub pages
 on:
-  push:
-    branches: ["main", "feature/publish-documentation"]
-    paths: ['documentation/**']
+  workflow_call:
+
 
 permissions:
   contents: read

data/.github/workflows/test.yaml

@@ -1,37 +1,38 @@
 name: Test
 
 on:
-  pull_request:
-    branches: [ "main" ]
-  push:
-    branches: [ "main" ]
-  workflow_dispatch:
+  workflow_call:
 
 permissions:
   contents: read          # Allows the action to check out your repository code
   pull-requests: write    # Allows the action to comment on or update the Dependabot PR
   statuses: write         # Allows the action to post pass/fail build statuses
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     name: Test
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
         ruby: ['3.3', '3.4', '4.0']
 
     steps:
-      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           show-progress: false
 
-      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
+      - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
         with:
           node-version-file: '.nvmrc'
           cache: 'npm'
 
-      - uses: ruby/setup-ruby@89f90524b88a01fe6e0b732220432cc6142926af # v1.313.0
+      - uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--format documentation

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Unreleased changes
+
+## 6.3.1.beta
+
+- [Remove govuk wrapper class](https://github.com/alphagov/tech-docs-gem/pull/530) that introduced extra padding 
+- Update[ template html syntax](https://github.com/alphagov/tech-docs-gem/pull/520) to more closely match gov.uk design template
+- bump govuk-frontend from [6.2.0 to 6.3.0](https://github.com/alphagov/tech-docs-gem/pull/517)
+
 ## 6.3.0
 
 - Bugfix [issue 258](https://github.com/alphagov/tech-docs-template/issues/258) - page layout structure to remove whitespace on short pages ([pull request 513](https://github.com/alphagov/tech-docs-gem/pull/513))  

data/README.md

@@ -163,7 +163,7 @@ the [Tech Docs template documentation on previewing your documentation](https://
 You can run the Ruby test suite with the following command:
 
 ```shell
-bundle exec rspec
+bundle exec rake spec
 ```
 
 To test a specific file include the filepath after `rspec`.

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "6.3.0".freeze
+  VERSION = "6.4.0.beta".freeze
 end

data/lib/source/layouts/_footer.erb

@@ -1,4 +1,4 @@
-<div class="govuk-footer app-footer" role="contentinfo">
+<div class="govuk-footer app-footer">
   <% if config[:tech_docs][:show_govuk_logo] %>
   <svg focusable="false" role="presentation" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 60" height="30" width="32" fill="currentcolor" class="govuk-footer__crown">
     <g>

data/lib/source/layouts/_header.erb

@@ -1,4 +1,4 @@
-<div class="govuk-header app-header" role="banner" data-module="govuk-header">
+<div class="govuk-header app-header">
   <div class="govuk-header__container govuk-header__container--full-width">
     <div class="govuk-header__logo">
       <% if config[:tech_docs][:service_link] %>

data/lib/source/layouts/_service_navigation.erb

@@ -1,4 +1,5 @@
- <div class="govuk-width-container">
+<div class="govuk-service-navigation app-pane__navigation" data-module="govuk-service-navigation">
+<div class="govuk-width-container">
     <div class="govuk-service-navigation__container">
       <nav aria-label="Menu" class="govuk-service-navigation__wrapper">
         <button type="button" class="govuk-service-navigation__toggle govuk-js-service-navigation-toggle" aria-controls="navigation" hidden aria-hidden="true">
@@ -20,3 +21,4 @@
       </nav>
     </div>
   </div>
+</div>

data/lib/source/layouts/core.erb

@@ -50,13 +50,11 @@
 
   <body class="govuk-template__body">
     <script>document.body.className += ' js-enabled' + ('noModule' in HTMLScriptElement.prototype ? ' govuk-frontend-supported' : '');</script>
-    <header class="govuk-template__header app-header" role="banner" data-module="govuk-header">
+    <header class="govuk-template__header app-header">
       <%= partial 'layouts/header' %>
     </header>
     <% if config[:tech_docs][:header_links] %>
-      <div class="govuk-service-navigation app-pane__navigation" data-module="govuk-service-navigation">
         <%= partial 'layouts/service_navigation' %>
-      </div>
     <% end %>
 
 
@@ -87,7 +85,7 @@
         <% end %>
 
         <div class="app-pane__content toc-open-disabled" aria-label="Content">
-          <main id="content" class="govuk-main-wrapper technical-documentation"<% if config[:tech_docs][:enable_anchored_headings] != false %> data-module="anchored-headings"<% end %>>
+          <main id="content" class="technical-documentation"<% if config[:tech_docs][:enable_anchored_headings] != false %> data-module="anchored-headings"<% end %>>
             <%= yield %>
             <%= partial "layouts/page_review" %>
           </main>

data/node_modules/govuk-frontend/dist/govuk/all.bundle.js

@@ -4,7 +4,7 @@
   (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.GOVUKFrontend = global.GOVUKFrontend || {}));
 })(this, (function (exports) { 'use strict';
 
-  const version = '6.2.0';
+  const version = '6.4.0';
 
   function getBreakpoint(name) {
     const property = `--govuk-breakpoint-${name}`;
@@ -1594,16 +1594,13 @@
       this.id = void 0;
       this.$announcements = void 0;
       this.enteredAnotherElement = void 0;
-      const $input = this.$root.querySelector('input');
+      const $input = this.$root.querySelector('input[type="file"]');
       if ($input === null) {
         throw new ElementError({
           component: FileUpload,
           identifier: 'File inputs (`<input type="file">`)'
         });
       }
-      if ($input.type !== 'file') {
-        throw new ElementError(formatErrorMessage(FileUpload, 'File input (`<input type="file">`) attribute (`type`) is not `file`'));
-      }
       this.$input = $input;
       if (!this.$input.id) {
         throw new ElementError({

data/node_modules/govuk-frontend/dist/govuk/all.bundle.mjs

@@ -1,4 +1,4 @@
-const version = '6.2.0';
+const version = '6.4.0';
 
 function getBreakpoint(name) {
   const property = `--govuk-breakpoint-${name}`;
@@ -1588,16 +1588,13 @@ class FileUpload extends ConfigurableComponent {
     this.id = void 0;
     this.$announcements = void 0;
     this.enteredAnotherElement = void 0;
-    const $input = this.$root.querySelector('input');
+    const $input = this.$root.querySelector('input[type="file"]');
     if ($input === null) {
       throw new ElementError({
         component: FileUpload,
         identifier: 'File inputs (`<input type="file">`)'
       });
     }
-    if ($input.type !== 'file') {
-      throw new ElementError(formatErrorMessage(FileUpload, 'File input (`<input type="file">`) attribute (`type`) is not `file`'));
-    }
     this.$input = $input;
     if (!this.$input.id) {
       throw new ElementError({

data/node_modules/govuk-frontend/dist/govuk/common/govuk-frontend-version.mjs

@@ -1,4 +1,4 @@
-const version = '6.2.0';
+const version = '6.4.0';
 
 export { version };
 //# sourceMappingURL=govuk-frontend-version.mjs.map

data/node_modules/govuk-frontend/dist/govuk/components/_index.import.scss

@@ -13,6 +13,7 @@
 @import "fieldset";
 @import "file-upload";
 @import "footer";
+@import "generic-header";
 @import "header";
 @import "hint";
 @import "input";

data/node_modules/govuk-frontend/dist/govuk/components/_index.scss

@@ -13,6 +13,7 @@
 @use "fieldset";
 @use "file-upload";
 @use "footer";
+@use "generic-header";
 @use "header";
 @use "hint";
 @use "input";

data/node_modules/govuk-frontend/dist/govuk/components/breadcrumbs/_mixin.scss

@@ -124,11 +124,7 @@
   }
 
   .govuk-breadcrumbs--inverse {
-    color: base.govuk-colour("white");
-
-    .govuk-breadcrumbs__link {
-      @include base.govuk-link-style-inverse;
-    }
+    --govuk-text-colour: #{base.govuk-functional-colour(inverse-text)};
 
     .govuk-breadcrumbs__list-item::before {
       border-color: currentcolor;

data/node_modules/govuk-frontend/dist/govuk/components/checkboxes/_mixin.scss

@@ -41,7 +41,7 @@
     // __item using flex-wrap because we want hints on a separate line.
     max-width: calc(100% - #{(($govuk-checkboxes-label-padding-left-right * 2) + $govuk-touch-target-size)});
     margin-bottom: 0;
-    padding: (base.govuk-spacing(1) + base.$govuk-border-width-form-element) base.govuk-spacing(3);
+    padding: (base.govuk-spacing(1) + base.$govuk-border-width-form-element) $govuk-checkboxes-label-padding-left-right;
     cursor: pointer;
     // remove 300ms pause on mobile
     touch-action: manipulation;
@@ -206,6 +206,12 @@
     }
 
     .govuk-checkboxes__label {
+      // Recalculate max-width to account for the smaller checkbox size
+      // 1px comes from padding-left (defined below)
+      max-width: calc(
+        100% - #{($govuk-touch-target-size - $input-offset) + $govuk-checkboxes-label-padding-left-right + 1px}
+      );
+
       // Create a tiny space between the small checkbox hover state so that it
       // doesn't clash with the label
       padding-left: 1px;

data/node_modules/govuk-frontend/dist/govuk/components/exit-this-page/_mixin.scss

@@ -69,7 +69,11 @@
     right: 0;
     bottom: 0;
     left: 0;
-    background-color: base.govuk-colour("white");
+    // The overlay is imitating a default browser window so we can use
+    // system colours ensure it matches the browser's default colours.
+    // https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Values/system-color
+    color: CanvasText;
+    background-color: Canvas;
   }
 
   // This class is added to the body when the Exit This Page button is activated

data/node_modules/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.js

@@ -387,16 +387,13 @@
       this.id = void 0;
       this.$announcements = void 0;
       this.enteredAnotherElement = void 0;
-      const $input = this.$root.querySelector('input');
+      const $input = this.$root.querySelector('input[type="file"]');
       if ($input === null) {
         throw new ElementError({
           component: FileUpload,
           identifier: 'File inputs (`<input type="file">`)'
         });
       }
-      if ($input.type !== 'file') {
-        throw new ElementError(formatErrorMessage(FileUpload, 'File input (`<input type="file">`) attribute (`type`) is not `file`'));
-      }
       this.$input = $input;
       if (!this.$input.id) {
         throw new ElementError({

data/node_modules/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.mjs

@@ -381,16 +381,13 @@ class FileUpload extends ConfigurableComponent {
     this.id = void 0;
     this.$announcements = void 0;
     this.enteredAnotherElement = void 0;
-    const $input = this.$root.querySelector('input');
+    const $input = this.$root.querySelector('input[type="file"]');
     if ($input === null) {
       throw new ElementError({
         component: FileUpload,
         identifier: 'File inputs (`<input type="file">`)'
       });
     }
-    if ($input.type !== 'file') {
-      throw new ElementError(formatErrorMessage(FileUpload, 'File input (`<input type="file">`) attribute (`type`) is not `file`'));
-    }
     this.$input = $input;
     if (!this.$input.id) {
       throw new ElementError({

data/node_modules/govuk-frontend/dist/govuk/components/file-upload/file-upload.mjs

@@ -1,6 +1,5 @@
 import { closestAttributeValue } from '../../common/closest-attribute-value.mjs';
 import { ConfigurableComponent } from '../../common/configuration.mjs';
-import { formatErrorMessage } from '../../common/index.mjs';
 import { ElementError } from '../../errors/index.mjs';
 import { I18n } from '../../i18n.mjs';
 
@@ -25,16 +24,13 @@ class FileUpload extends ConfigurableComponent {
     this.id = void 0;
     this.$announcements = void 0;
     this.enteredAnotherElement = void 0;
-    const $input = this.$root.querySelector('input');
+    const $input = this.$root.querySelector('input[type="file"]');
     if ($input === null) {
       throw new ElementError({
         component: FileUpload,
         identifier: 'File inputs (`<input type="file">`)'
       });
     }
-    if ($input.type !== 'file') {
-      throw new ElementError(formatErrorMessage(FileUpload, 'File input (`<input type="file">`) attribute (`type`) is not `file`'));
-    }
     this.$input = $input;
     if (!this.$input.id) {
       throw new ElementError({

data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_generic-header.import.scss

@@ -0,0 +1,6 @@
+@use "../../settings/warnings--internal";
+
+@include warnings--internal.component-scss-file-warning("generic-header");
+
+@import "index";
+

data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_index.import.scss

@@ -0,0 +1,8 @@
+@use "mixin";
+
+@import "../../base";
+
+@include govuk-exports("govuk/component/generic-header") {
+  @include mixin.styles;
+}
+

data/node_modules/govuk-frontend/dist/govuk/components/generic-header/_index.scss

@@ -0,0 +1,5 @@
+@use "../../custom-properties";
+@use "mixin";
+
+@include mixin.styles;
+