govuk_tech_docs 6.6.0.rc.local.tested → 6.6.0

data/.github/ISSUE_TEMPLATE/bug.yaml

@@ -1,69 +0,0 @@
-name: 🐛 Bug report
-description: Something is broken or not working as expected
-title: "[Bug]: "
-labels: ["bug"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thank you for reporting a bug in `tech-docs-gem`
-        Please include as much detail as you can.  This will help us prioritise this issue correctly.
-
-  - type: textarea
-    id: tech-docs-gem-version
-    attributes:
-      label: tech-docs-gem version
-      description: Which version of the tech docs gem are you using
-    validations:
-      required: true 
-      
-  - type: textarea
-    id: ruby-version
-    attributes:
-      label: ruby version
-      description: Which version of the ruby are you using (if known)
-    validations:
-      required: false
-
-  - type: textarea
-    id: description
-    attributes:
-      label: What happened?
-      description: Describe the problem and what you expected to happen.
-    validations:
-      required: true
-
-  - type: textarea
-    id: reproduction
-    attributes:
-      label: Steps to reproduce
-      description: |
-        Tell us how to reproduce the issue.
-        Example:
-        1. Run `bundle exec middleman serve`
-        2. Visit `/guides/setup`
-        3. See white screen of death
-      placeholder: Step-by-step instructions
-    validations:
-      required: true
-
-
-  - type: textarea
-    id: logs
-    attributes:
-      label: Logs or error output
-      description: Any error messages or logs if available 
-    validations:
-      required: false
-
-  - type: checkboxes
-    id: checks
-    attributes:
-      label: Checks
-      options:
-        - label: I have searched for existing issues
-          required: true
-        - label: I have checked other users also have this issue
-          required: true
-        - label: I have checked that I am not using a local or forked repository with untested changes
-          required: true

data/.github/ISSUE_TEMPLATE/config.yaml

@@ -1,6 +0,0 @@
-
-blank_issues_enabled: false
-contact_links:
-  - name: Ask a question or get help
-    url: https://ukgovernmentdigital.slack.com/archives/C1ZM2T0SG
-    about: Uk Government digital slack channel for Technical Writers

data/.github/ISSUE_TEMPLATE/documentation.yaml

@@ -1,29 +0,0 @@
-name: ✨ New or updated documentation
-description: Suggest a new feature or improvement
-title: "[Documentation]: "
-labels: ["documentation"]
-body:
-  - type: checkboxes
-    id: documentation-type
-    attributes:
-      label: Is this
-      options:
-        - label: a suggestion for new content
-          required: false
-        - label: an update to existing content
-          required: false
-        - label: a suggestion to remove content
-          required: false
-
-  - type: textarea
-    id: user-need
-    attributes:
-      label: User need
-      description: Do you have evidence that the change will meet the needs of users? Let us know about any user research or testing you’ve done
-
-  - type: textarea
-    id: proposal
-    attributes:
-      label: Proposed solution
-      description: Optional — describe how you think this would look or link to a draft
-

data/.github/ISSUE_TEMPLATE/enhancement.yaml

@@ -1,25 +0,0 @@
-name: ✨ New or updated feature
-description: Suggest a new feature or improvement
-title: "[Enhancement]: "
-labels: ["enhancement"]
-body:
-  - type: textarea
-    id: problem
-    attributes:
-      label: What should change?
-      description: What would fix the issue? Is this something you think should behave differently, or something that you currently cannot do?
-    validations:
-      required: true
-
-  - type: textarea
-    id: user-need
-    attributes:
-      label: User need
-      description: Do you have evidence that the change will meet the needs of users? Let us know about any user research or testing you’ve done
-
-  - type: textarea
-    id: proposal
-    attributes:
-      label: Proposed solution
-      description: Optional — describe how you think this could work or a solution you have in mind
-

data/.github/dependabot.yml

@@ -1,67 +0,0 @@
-version: 2
-updates:
-  # 1. Update Ruby dependencies (Gemfile/gemspec) in the root
-  - package-ecosystem: "bundler"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "monday"
-      time: "06:00"
-    # Essential for gem projects without a Gemfile.lock:
-    versioning-strategy: "increase"
-    commit-message:
-      prefix: chore
-    open-pull-requests-limit: 5
-    groups:
-      prod-safe-updates:
-        dependency-type: "production"
-        patterns:
-          - "*"
-        update-types:
-          - "minor"
-          - "patch"
-      dev-safe-updates:
-        dependency-type: "development"
-        patterns:
-          - "*"
-        update-types:
-          - "minor"
-          - "patch"
-
-  # 2. Update GitHub Actions
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "monday"
-      time: "06:00"
-    commit-message:
-      prefix: chore
-    groups:
-      github-actions-updates:
-        patterns:
-          - "*"
-
-  # 3. Update npm dependencies
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "monday"
-      time: "06:00"
-    open-pull-requests-limit: 5
-    groups:
-      dev-dependencies:
-        dependency-type: "development"
-        patterns:
-          - "*"
-        update-types:
-          - "patch"
-          - "minor"
-      prod-safe-updates:
-        dependency-type: "production"
-        patterns:
-          - "*"
-        update-types:
-          - "patch"
-          - "minor"

data/.github/pull_request_template.md

@@ -1,28 +0,0 @@
-## Proposed changes
-
-### What changed
-
-Describe the changes made and the impact the changes have.
-
-## Related issue or tracking reference
-
-You should have an open GitHub issue that this PR will fix.  
-
-- Fixes #
-- Relates to #
-
-> If there is no issue, please open one or please explain why one is not needed (for example small maintenance change, routine dependency update).
-
-## Screenshots or examples (if relevant)
-
-Include screenshots, logs, or rendered output if this change affects layout or behaviour.
-
-## Checklist
-
-Before you request approval you should confirm that:
-
-- [ ] the pull request has a clear title with a short description about the update in the documentation
-- [ ] GitHub actions all pass
-- [ ] you have tested the changes with a fresh build against the latest version of the `tech-docs-gem`
-- [ ] you have linked this PR to an issue (or explained why none exists)
-- [ ] you have updated documentation if needed

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

@@ -1,41 +0,0 @@
-name: 'Build middleman artifact'
-on:
-  workflow_call:
-    inputs:
-      upload-artifact:
-        default: false
-        required: false
-        type: boolean
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: documentation
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-        with:
-          fetch-depth: 0
-      - name: Setup Node
-        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
-        with:
-          node-version-file: 'documentation/.nvmrc'
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@14594264cd68ce8a2345dd349bc3d138a4ef85c8 # v1.327.0
-        with:
-          bundler-cache: true
-          working-directory: documentation
-          ruby-version: '3'
-      - name: Install gems
-        run: bundle install
-      - name: Build
-        run: bundle exec middleman build
-      - name: Upload artifact
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v4.1.3
-        if: ${{ inputs.upload-artifact }}
-        with:
-          name: build
-          path: documentation/build/**
-          retention-days: 1

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

@@ -1,33 +0,0 @@
-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
-          fetch-depth: 2
-
-      - uses: ruby/setup-ruby@14594264cd68ce8a2345dd349bc3d138a4ef85c8 # v1.327.0
-        with:
-          ruby-version: '3'
-
-      - name: Documentation updated
-        id: documentation_updated
-        run: |
-          if git diff --name-only HEAD^ HEAD | 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

@@ -1,36 +0,0 @@
-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@14594264cd68ce8a2345dd349bc3d138a4ef85c8 # v1.327.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/npm-vulnerability-scanner.yaml

@@ -1,55 +0,0 @@
-name: NPM Audit Security Check
-
-on:
-  workflow_call:
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-jobs:
-  npm-audit:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
-
-      - name: Setup Node.js
-        uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020
-        with:
-          node-version: '20'
-          cache: 'npm'
-
-      - name: Run NPM Audit & Generate Summary
-        run: |
-          # 1. Run npm audit in JSON mode to capture raw audit metadata
-          AUDIT_JSON=$(npm audit --audit-level=high --json 2>/dev/null) || true
-
-          # 2. Extract counts using node's built-in JSON parser
-          CRITICAL_COUNT=$(echo "$AUDIT_JSON" | node -e "let d=''; process.stdin.on('data', c => d += c); process.stdin.on('end', () => { try { console.log(JSON.parse(d).metadata.vulnerabilities.critical || 0) } catch { console.log(0) } })")
-          HIGH_COUNT=$(echo "$AUDIT_JSON" | node -e "let d=''; process.stdin.on('data', c => d += c); process.stdin.on('end', () => { try { console.log(JSON.parse(d).metadata.vulnerabilities.high || 0) } catch { console.log(0) } })")
-          
-          # 3. Build GitHub Job Summary Markdown
-          echo "## 🛡️ NPM Dependency Audit Summary" >> $GITHUB_STEP_SUMMARY
-          echo "" >> $GITHUB_STEP_SUMMARY
-
-          if [ "$CRITICAL_COUNT" -eq 0 ] && [ "$HIGH_COUNT" -eq 0 ]; then
-            echo "✅ **No high or critical vulnerabilities found!** All JS packages passed security checks." >> $GITHUB_STEP_SUMMARY
-          else
-            echo "⚠️ **High/Critical Vulnerabilities Detected in npm Dependencies**" >> $GITHUB_STEP_SUMMARY
-            echo "" >> $GITHUB_STEP_SUMMARY
-            echo "| Vulnerability Severity | Total Count |" >> $GITHUB_STEP_SUMMARY
-            echo "| :--- | :--- |" >> $GITHUB_STEP_SUMMARY
-            echo "| 🔴 **Critical** | $CRITICAL_COUNT \vert{}" >> $GITHUB_STEP_SUMMARY
-            echo "| 🟠 **High** | $HIGH_COUNT \vert{}" >> $GITHUB_STEP_SUMMARY
-            echo "" >> $GITHUB_STEP_SUMMARY
-            echo "### Detailed Audit Report" >> $GITHUB_STEP_SUMMARY
-            echo '```text' >> $GITHUB_STEP_SUMMARY
-            # Output human-readable audit text into the summary block
-            npm audit --audit-level=high 2>/dev/null || true
-            echo '```' >> $GITHUB_STEP_SUMMARY
-
-            # 4. Fail the workflow step
-            echo "::error::npm audit detected $CRITICAL_COUNT critical and $HIGH_COUNT high vulnerabilities."
-            exit 1
-          fi

data/.github/workflows/pipeline.yaml

@@ -1,58 +0,0 @@
-name: pipeline
-on:
-  workflow_dispatch:
-  pull_request:
-    branches: [ "main"]
-  push:
-    branches: [ "main"]
-
-jobs:
-  npm-vulnerability-scanner:
-    uses: ./.github/workflows/npm-vulnerability-scanner.yaml
-    permissions:
-      contents: read
-
-  ruby-vulnerability-scanner:
-    needs: npm-vulnerability-scanner
-    uses: ./.github/workflows/ruby-vulnerability-scanner.yaml
-    permissions:
-      contents: read
-
-  test:
-    needs: ruby-vulnerability-scanner
-    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
-      id-token: write
-
-  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: always() && github.event_name == 'push' && needs.check-documentation-updates.result == 'success' && 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

@@ -1,52 +0,0 @@
-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
-
-permissions:
-  contents: write
-  id-token: write
-
-jobs:
-  deploy:
-    name: Publish Ruby Gem
-    environment: rubygems
-    permissions:
-      contents: write  # needed to be able to tag the release
-      id-token: write
-    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'
-
-      - name: Install Node dependencies
-        run: npm install
-
-      - uses: ruby/setup-ruby@14594264cd68ce8a2345dd349bc3d138a4ef85c8 # v1.327.0
-        with:
-          ruby-version: '3'
-          bundler-cache: true
-
-      - name: Publish to rubygems.org
-        uses: rubygems/release-gem@7f9650160c1a4e7989fdc9855807bdbd421d8b6b # v1.4.1

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

@@ -1,38 +0,0 @@
-name: Publish GitHub pages
-on:
-  workflow_call:
-  workflow_dispatch:
-
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  build:
-    uses: ./.github/workflows/build-middleman-artifact.yaml
-    with:
-      upload-artifact: true
-  deploy-to-pages:
-    needs: build
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Download build artifact
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c #v8.0.1
-        with:
-          name: build
-          path: build
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 #v5.0.0
-        with:
-          path: "build"
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1

data/.github/workflows/ruby-vulnerability-scanner.yaml

@@ -1,44 +0,0 @@
-name: Ruby vulnerability scanner
-
-on:
-  workflow_call:
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-jobs:
-  bundler-audit:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
-
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@14594264cd68ce8a2345dd349bc3d138a4ef85c8
-        with:
-          ruby-version: '3.3'
-          bundler-cache: true
-
-      - name: Run Audit Check
-        run: |
-          gem install bundler-audit
-          
-          # Run audit and save output to file (preventing immediate job failure via || true)
-          bundle-audit check --update > audit_results.txt || AUDIT_EXIT_CODE=$?
-          
-          echo "## 🛡️ Ruby Dependency Audit Summary" >> $GITHUB_STEP_SUMMARY
-          
-          if [ -z "$AUDIT_EXIT_CODE" ]; then
-            echo "::notice::No vulnerabilities found in Ruby dependencies."
-            echo "✅ **No vulnerabilities found!** All resolved gems from your `.gemspec` passed security checks." >> $GITHUB_STEP_SUMMARY
-          else
-            echo "⚠️ **Vulnerabilities Detected in Ruby Dependencies**" >> $GITHUB_STEP_SUMMARY
-            echo "" >> $GITHUB_STEP_SUMMARY
-            echo '```text' >> $GITHUB_STEP_SUMMARY
-            cat audit_results.txt >> $GITHUB_STEP_SUMMARY
-            echo '```' >> $GITHUB_STEP_SUMMARY
-          
-            # Fail the step if vulnerabilities were found
-            exit $AUDIT_EXIT_CODE
-          fi

data/.github/workflows/test.yaml

@@ -1,48 +0,0 @@
-name: Test
-
-on:
-  workflow_call:
-  workflow_dispatch:
-
-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.4', '4.0']
-
-    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@14594264cd68ce8a2345dd349bc3d138a4ef85c8 # v1.327.0
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Lint Ruby and javascript files
-        run: bundle exec rake lint
-
-      - name: Run Ruby unit tests
-        run: bundle exec rake spec
-
-      - name: Run Javascript tests
-        run: bundle exec rake jasmine:ci

data/documentation/.nvmrc

@@ -1 +0,0 @@
-20

data/documentation/Gemfile

@@ -1,11 +0,0 @@
-source "https://rubygems.org"
-
-# For faster file watcher updates on Windows:
-gem "wdm", "~> 0.1.0", platforms: %i[mswin mingw]
-
-# Windows does not come with time zone data
-gem "tzinfo-data", platforms: %i[mswin mingw jruby]
-
-gem "govuk_tech_docs", path: ".."
-
-gem "middleman-gh-pages"