Merge pull request #25 from NHSDigital/rossbugginsnhs/2024-07-03-impo…

…rt-hw-and-internal Rossbugginsnhs/2024 07 03 import hw and internal
NHSDigital · Jul 3, 2024 · 696e6d4 · 696e6d4
2 parents 6b782a8 + f80e8bf
commit 696e6d4
Show file tree

Hide file tree

Showing 26 changed files with 266 additions and 151 deletions.
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -0,0 +1 @@
+FROM --platform=linux/amd64 mcr.microsoft.com/devcontainers/jekyll:2-bullseye
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -1,41 +1,21 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/templates/tree/main/src/jekyll
 {
-  "name": "Jekyll",
-  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-  "image": "mcr.microsoft.com/devcontainers/jekyll:2-bullseye",
-  // Features to add to the dev container. More info: https://containers.dev/features.
-  // "features": {},
-  // Use 'forwardPorts' to make a list of ports inside the container available locally.
-  // "forwardPorts": [],
-  // Uncomment the next line to run commands after the container is created.
-  "postCreateCommand": "zsh scripts/devcontainer/postcreatecommand.sh",
-  "postStartCommand": "zsh scripts/devcontainer/poststartcommand.sh",
-  "forwardPorts": [4000],
-  // Configure tool-specific properties.
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
   "customizations": {
     "codespaces": {
-      "openFiles": ["README.md", ".github/SECURITY.md", "docs/index.md"]
+      "openFiles": [
+        "README.md",
+        ".github/SECURITY.md",
+        "docs/index.md"
+      ]
     },
     "vscode": {
-      // Set *default* container specific settings.json values on container create.
-      "settings": {
-        "autoOpenWorkspace.enableAutoOpenIfSingleWorkspace": true,
-        "editor.formatOnSave": true,
-        "files.insertFinalNewline": true,
-        "[makefile]": {
-          "editor.insertSpaces": false,
-          "editor.detectIndentation": false
-        }
-      },
-      // Add the IDs of extensions you want installed when the container is created.
       "extensions": [
-        "zoma.vscode-auto-open-workspace",
         "alefragnani.bookmarks",
         "davidanson.vscode-markdownlint",
         "dbaeumer.vscode-eslint",
         "donjayamanne.githistory",
-        "eamodio.gitlens",
         "editorconfig.editorconfig",
         "esbenp.prettier-vscode",
         "github.codespaces",
@@ -45,6 +25,8 @@
         "github.vscode-pull-request-github",
         "hediet.vscode-drawio",
         "johnpapa.vscode-peacock",
+        "joshx.workspace-terminals",
+        "maattdd.gitless",
         "mhutchie.git-graph",
         "ms-azuretools.vscode-docker",
         "ms-vscode-remote.remote-containers",
@@ -54,6 +36,7 @@
         "ms-vsliveshare.vsliveshare",
         "redhat.vscode-xml",
         "streetsidesoftware.code-spell-checker-british-english",
+        "takumii.markdowntable",
         "tamasfe.even-better-toml",
         "tomoki1207.pdf",
         "vscode-icons-team.vscode-icons",
@@ -62,43 +45,59 @@
         "yzane.markdown-pdf",
         "yzhang.dictionary-completion",
         "yzhang.markdown-all-in-one",
-        "joshx.workspace-terminals",
-        "takumii.markdowntable"
-      ]
+        "zoma.vscode-auto-open-workspace"
+      ],
+      "settings": {
+        "[makefile]": {
+          "editor.detectIndentation": false,
+          "editor.insertSpaces": false
+        },
+        "autoOpenWorkspace.enableAutoOpenIfSingleWorkspace": true,
+        "editor.formatOnSave": true,
+        "extensions.ignoreRecommendations": true,
+        "files.insertFinalNewline": true
+      }
     }
   },
   "features": {
     "ghcr.io/devcontainers/features/aws-cli:1": {
       "version": "latest"
     },
+    "ghcr.io/devcontainers/features/common-utils:2": {
+      "configureZshAsDefaultShell": true,
+      "installOhMyZsh": true,
+      "installOhMyZshConfig": true,
+      "installZsh": true,
+      "upgradePackages": true,
+      "userGid": "automatic",
+      "userUid": "automatic",
+      "username": "automatic"
+    },
     "ghcr.io/devcontainers/features/docker-in-docker:2": {
-      "moby": true,
       "azureDnsAutoDetection": true,
+      "dockerDashComposeVersion": "latest",
       "installDockerBuildx": true,
       "installDockerComposeSwitch": true,
-      "version": "latest",
-      "dockerDashComposeVersion": "latest"
-    },
-    "ghcr.io/devcontainers/features/node:1": {
-      "nodeGypDependencies": true,
-      "version": "lts",
-      "nvmVersion": "latest"
+      "moby": true,
+      "version": "latest"
     },
     "ghcr.io/devcontainers/features/github-cli:1": {
       "installDirectlyFromGitHubRelease": true,
       "version": "latest"
     },
-    "ghcr.io/devcontainers/features/common-utils:2": {
-      "installZsh": true,
-      "configureZshAsDefaultShell": true,
-      "installOhMyZsh": true,
-      "installOhMyZshConfig": true,
-      "upgradePackages": true,
-      "username": "automatic",
-      "userUid": "automatic",
-      "userGid": "automatic"
+    "ghcr.io/devcontainers/features/node:1": {
+      "nodeGypDependencies": true,
+      "nvmVersion": "latest",
+      "version": "lts"
     }
-  }
-  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-  // "remoteUser": "root"
+  },
+  "forwardPorts": [
+    4000
+  ],
+  "name": "Jekyll",
+  "postCreateCommand": "zsh scripts/devcontainer/postcreatecommand.sh",
+  "postStartCommand": "zsh scripts/devcontainer/poststartcommand.sh",
+  "runArgs": [
+    "--platform=linux/amd64"
+  ]
 }
diff --git a/.editorconfig b/.editorconfig
@@ -19,3 +19,13 @@ indent_size = 4
 
 [{Makefile,*.mk,go.mod,go.sum,*.go,.gitmodules}]
 indent_style = tab
+
+# Ignore paths
+[Gemfile.lock]
+charset = unset
+end_of_line = unset
+insert_final_newline = unset
+trim_trailing_whitespace = unset
+indent_style = unset
+indent_size = unset
+generated_code = true
diff --git a/.github/actions/build-docs/action.yml b/.github/actions/build-docs/action.yml
@@ -19,7 +19,7 @@ runs:
     - name: Setup Ruby
       uses: ruby/[email protected]
       with:
-        ruby-version: "3.1" # Not needed with a .ruby-version file
+        ruby-version: "3.2" # Not needed with a .ruby-version file
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
         cache-version: 0 # Increment this number if you need to re-download cached gems
         working-directory: "./docs"

diff --git a/.gitleaksignore b/.gitleaksignore
@@ -1,3 +1,5 @@
 # SEE: https://github.com/gitleaks/gitleaks/blob/master/README.md#gitleaksignore
 
 cd9c0efec38c5d63053dd865e5d4e207c0760d91:docs/guides/Perform_static_analysis.md:generic-api-key:37
+96096685ab3d6876671e2bc9a6ff4d48fc56e521:src/helloworld/helloworld.sln:ipv4:4
+4f4e8c15629b2cb09356a7fed4d72953590227ce:docs/Gemfile.lock:ipv4:4
diff --git a/.tool-versions b/.tool-versions
@@ -3,7 +3,7 @@
 terraform 1.7.0
 pre-commit 3.6.0
 nodejs 18.18.2
-gitleaks 8.15.3
+gitleaks 8.18.4
 
 # ==============================================================================
 # The section below is reserved for Docker image versions.

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,19 +1,20 @@
 {
   "autoOpenWorkspace.enableAutoOpenIfSingleWorkspace": true,
   "files.exclude": {
+    "**/.DS_Store": true,
     "**/.git": true,
-    "**/.svn": true,
     "**/.hg": true,
+    "**/.ruby-lsp": true,
+    "**/.svn": true,
     "**/CVS": true,
-    "**/.DS_Store": true,
     "**/Thumbs.db": true,
-    "**/.ruby-lsp": true,
-    "docs": true,
-    ".github": true,
     ".devcontainer": true,
+    ".github": true,
     ".vscode": false,
-    "tests":true,
-    "infrastructure":true,
-    "scripts":true
+    "docs": true,
+    "infrastructure": true,
+    "scripts": true,
+    "terraform": true,
+    "tests": true
   }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Removed
+
+### Deprecated
+
+### Fixed
+
+### Security
+
+## [0.0.1] - 2024-06-20
+
+### Added
+
+- Initial release
+
+[unreleased]: https://github.com/NHSDigital/nhs-notify-internal/compare/v0.0.1...HEAD
+[0.0.1]: https://github.com/NHSDigital/nhs-notify-internal/releases/tag/v0.0.1
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -2,6 +2,8 @@ _site
 .sass-cache
 .jekyll-cache
 .jekyll-metadata
+.bundle
 vendor
+*Zone.Identifier
 node_modules
 _config.version.yml
diff --git a/docs/.vscode/launch.json b/docs/.vscode/launch.json
@@ -1,15 +1,19 @@
 {
-  "version": "0.2.0",
   "configurations": [
     {
+      "console": "integratedTerminal",
       "name": "Debug",
+      "preLaunchTask": "stop-already-running",
       "request": "launch",
-      "runtimeArgs": ["debug"],
+      "runtimeArgs": [
+        "debug"
+      ],
       "runtimeExecutable": "make",
-      "skipFiles": ["<node_internals>/**"],
-      "type": "node",
-      "preLaunchTask": "stop-already-running",
-      "console": "integratedTerminal"
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "type": "node"
     }
-  ]
+  ],
+  "version": "0.2.0"
 }
diff --git a/docs/.vscode/tasks.json b/docs/.vscode/tasks.json
@@ -1,13 +1,13 @@
 {
-  "version": "2.0.0",
   "tasks": [
     {
+      "command": "kill $(lsof -ti :4000); exit 0;",
       "label": "stop-already-running",
       "options": {
         "cwd": "${workspaceFolder}"
       },
-      "command": "kill $(lsof -ti :4000); exit 0;",
       "type": "shell"
     }
-  ]
+  ],
+  "version": "2.0.0"
 }
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -34,3 +34,4 @@ gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
 gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
 
 gem "just-the-docs"
+gem 'jemoji'
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -1,11 +1,25 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
     cgi (0.4.1)
     colorator (1.1.0)
     concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    drb (2.2.1)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
@@ -14,7 +28,11 @@ GEM
     eventmachine (1.2.7)
     ffi (1.16.3)
     forwardable-extended (2.6.0)
+    gemoji (4.1.0)
     google-protobuf (3.25.3-x86_64-linux)
+    html-pipeline (2.14.3)
+      activesupport (>= 2)
+      nokogiri (>= 1.4)
     http_parser.rb (0.8.0)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
@@ -48,6 +66,10 @@ GEM
       jekyll (>= 3.8, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
+    jemoji (0.13.0)
+      gemoji (>= 3, < 5)
+      html-pipeline (~> 2.2)
+      jekyll (>= 3.0, < 5.0)
     just-the-docs (0.8.2)
       jekyll (>= 3.8.5)
       jekyll-include-cache
@@ -66,6 +88,8 @@ GEM
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
+    minitest (5.24.1)
+    mutex_m (0.2.0)
     nokogiri (1.16.5-x86_64-linux)
       racc (~> 1.4)
     pathutil (0.16.2)
@@ -86,6 +110,8 @@ GEM
     strscan (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
     webrick (1.8.1)
 
@@ -97,11 +123,12 @@ DEPENDENCIES
   jekyll (~> 4.3.3)
   jekyll-drawio
   jekyll-feed (~> 0.12)
+  jemoji
   just-the-docs
   minima (~> 2.5)
   tzinfo (>= 1, < 3)
   tzinfo-data
   wdm (~> 0.1.1)
 
 BUNDLED WITH
-  2.5.10
+   2.5.10
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		FROM --platform=linux/amd64 mcr.microsoft.com/devcontainers/jekyll:2-bullseye
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,3 +34,4 @@ gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
		gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

		gem "just-the-docs"
		gem 'jemoji'