{"id":23421124,"url":"https://github.com/nhsdigital/nhs-notify-shared-modules","last_synced_at":"2026-02-24T10:13:43.330Z","repository":{"id":254411449,"uuid":"846078675","full_name":"NHSDigital/nhs-notify-shared-modules","owner":"NHSDigital","description":"Terraform Shared Modules repo for all Notify AMET repos","archived":false,"fork":false,"pushed_at":"2026-02-19T08:46:23.000Z","size":1596,"stargazers_count":2,"open_issues_count":14,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-19T13:57:24.399Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NHSDigital.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-08-22T13:44:33.000Z","updated_at":"2026-02-19T08:44:07.000Z","dependencies_parsed_at":"2024-12-13T15:27:06.852Z","dependency_job_id":"78a89798-6a74-4b3a-b4f5-9321e1fa1b1a","html_url":"https://github.com/NHSDigital/nhs-notify-shared-modules","commit_stats":null,"previous_names":["nhsdigital/nhs-notify-shared-modules"],"tags_count":112,"template":false,"template_full_name":"NHSDigital/nhs-notify-repository-template","purl":"pkg:github/NHSDigital/nhs-notify-shared-modules","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fnhs-notify-shared-modules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fnhs-notify-shared-modules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fnhs-notify-shared-modules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fnhs-notify-shared-modules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NHSDigital","download_url":"https://codeload.github.com/NHSDigital/nhs-notify-shared-modules/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fnhs-notify-shared-modules/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29779284,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-24T04:54:30.205Z","status":"ssl_error","status_checked_at":"2026-02-24T04:53:58.628Z","response_time":75,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-23T02:14:05.758Z","updated_at":"2026-02-24T10:13:43.325Z","avatar_url":"https://github.com/NHSDigital.png","language":"HCL","readme":"# NHS Notify Repository Template\n\n[![CI/CD Pull Request](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=repository-template\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=repository-template)\n\nStart with an overview or a brief description of what the project is about and what it does. For example -\n\nWelcome to our repository template designed to streamline your project setup! This robust template provides a reliable starting point for your new projects, covering an essential tech stack and encouraging best practices in documenting.\n\nThis repository template aims to foster a user-friendly development environment by ensuring that every included file is concise and adequately self-documented. By adhering to this standard, we can promote increased clarity and maintainability throughout your project's lifecycle. Bundled within this template are resources that pave the way for seamless repository creation. Currently supported technologies are:\n\n- Terraform\n- Docker\n\nMake use of this repository template to expedite your project setup and enhance your productivity right from the get-go. Enjoy the advantage of having a well-structured, self-documented project that reduces overhead and increases focus on what truly matters - coding!\n\n## Table of Contents\n\n- [NHS Notify Repository Template](#nhs-notify-repository-template)\n  - [Table of Contents](#table-of-contents)\n  - [Documentation](#documentation)\n  - [Setup](#setup)\n    - [Prerequisites](#prerequisites)\n    - [Configuration](#configuration)\n  - [Usage](#usage)\n    - [Testing](#testing)\n  - [Design](#design)\n    - [Diagrams](#diagrams)\n    - [Modularity](#modularity)\n  - [Contributing](#contributing)\n  - [Contacts](#contacts)\n  - [Licence](#licence)\n\n## Documentation\n\n- [Built](/)\n\n## Setup\n\nBy including preferably a one-liner or if necessary a set of clear CLI instructions we improve user experience. This should be a frictionless installation process that works on various operating systems (macOS, Linux, Windows WSL) and handles all the dependencies.\n\nClone the repository\n\n```shell\ngit clone https://github.com/nhs-england-tools/repository-template.git\ncd nhs-england-tools/repository-template\n```\n\n### Prerequisites\n\nThe following software packages, or their equivalents, are expected to be installed and configured:\n\n- [Docker](https://www.docker.com/) container runtime or a compatible tool, e.g. [Podman](https://podman.io/),\n- [asdf](https://asdf-vm.com/) version manager,\n- [GNU make](https://www.gnu.org/software/make/) 3.82 or later,\n\n\u003e [!NOTE]\u003cbr\u003e\n\u003e The version of GNU make available by default on macOS is earlier than 3.82. You will need to upgrade it or certain `make` tasks will fail. On macOS, you will need [Homebrew](https://brew.sh/) installed, then to install `make`, like so:\n\u003e\n\u003e ```shell\n\u003e brew install make\n\u003e ```\n\u003e\n\u003e You will then see instructions to fix your [`$PATH`](https://github.com/nhs-england-tools/dotfiles/blob/main/dot_path.tmpl) variable to make the newly installed version available. If you are using [dotfiles](https://github.com/nhs-england-tools/dotfiles), this is all done for you.\n\n- [GNU sed](https://www.gnu.org/software/sed/) and [GNU grep](https://www.gnu.org/software/grep/) are required for the scripted command-line output processing,\n- [GNU coreutils](https://www.gnu.org/software/coreutils/) and [GNU binutils](https://www.gnu.org/software/binutils/) may be required to build dependencies like Python, which may need to be compiled during installation,\n\n\u003e [!NOTE]\u003cbr\u003e\n\u003e For macOS users, installation of the GNU toolchain has been scripted and automated as part of the `dotfiles` project. Please see this [script](https://github.com/nhs-england-tools/dotfiles/blob/main/assets/20-install-base-packages.macos.sh) for details.\n\n- [Python](https://www.python.org/) required to run Git hooks,\n- [`jq`](https://jqlang.github.io/jq/) a lightweight and flexible command-line JSON processor.\n\n### Configuration\n\nInstallation and configuration of the toolchain dependencies\n\n```shell\nmake config\n```\n\n## Usage\n\nThis repository provides shared resources for NHS Notify service repositories:\n\n### Terraform Modules\n\nReusable Terraform modules are published as GitHub release assets. Service repos reference them via release URLs:\n\n```hcl\nmodule \"lambda_example\" {\n  source = \"https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip\"\n  # ... module configuration\n}\n```\n\nSee [infrastructure/modules/](./infrastructure/modules/) for available modules.\n\n### Pre-commit Hooks\n\nCentralised pre-commit hooks are defined in [.pre-commit-hooks.yaml](./.pre-commit-hooks.yaml) and can be consumed by service repos:\n\n```yaml\n# In service repo's scripts/config/pre-commit.yaml\nrepos:\n  - repo: https://github.com/NHSDigital/nhs-notify-shared-modules\n    rev: v2.1.0  # Use specific tag for version control\n    hooks:\n      - id: sort-dictionary\n      - id: scan-secrets\n        args: [check=whole-history]\n      - id: check-file-format\n        args: [check=branch]\n```\n\n**Available hooks:**\n\n- `sort-dictionary` - Sorts Vale dictionary files to avoid merge conflicts\n- `scan-secrets` - Scans for hard-coded secrets using Gitleaks\n- `check-file-format` - Validates EditorConfig compliance\n\n**Arguments:**\n\n- `scan-secrets`: `check={whole-history,last-commit,staged-changes}` (default: `staged-changes`)\n- `check-file-format`: `check={all,staged-changes,working-tree-changes,branch}` (default: `working-tree-changes`)\n\n### GitHub Composite Actions\n\nReusable GitHub Actions can be referenced directly from service repository workflows:\n\n```yaml\n# In service repository's .github/workflows/*.yaml\njobs:\n  scan-secrets:\n    steps:\n      - uses: actions/checkout@v4\n      - uses: NHSDigital/nhs-notify-shared-modules/.github/actions/scan-secrets@v2.1.0\n```\n\nSee the `.github/actions/` directory for available actions.\n\n### Versioning Strategy\n\n- Use **semantic versioning** for releases (e.g., `v2.1.0`)\n- Service repositories should **pin specific tags** rather than using `main`\n- Update service repository references after testing new shared-modules releases\n- Breaking changes require major version bump\n\n### Testing\n\nThere are `make` tasks for you to configure to run your tests.  Run `make test` to see how they work.  You should be able to use the same entry points for local development as in your CI pipeline.\n\n## Design\n\n### Diagrams\n\nThe [C4 model](https://c4model.com/) is a simple and intuitive way to create software architecture diagrams that are clear, consistent, scalable and most importantly collaborative. This should result in documenting all the system interfaces, external dependencies and integration points.\n\nThe source for diagrams should be in Git for change control and review purposes. Recommendations are [draw.io](https://app.diagrams.net/) and [Mermaids](https://github.com/mermaid-js/mermaid). Here is an example Mermaids sequence diagram:\n\n```mermaid\nsequenceDiagram\n    User-\u003e\u003e+Service: GET /users?params=...\n    Service-\u003e\u003eService: auth request\n    Service-\u003e\u003eDatabase: get all users\n    Database--\u003e\u003eService: list of users\n    Service-\u003e\u003eService: filter users\n    Service--\u003e\u003e-User: list[User]\n```\n\n### Modularity\n\nMost of the projects are built with customisability and extendability in mind. At a minimum, this can be achieved by implementing service level configuration options and settings. The intention of this section is to show how this can be used. If the system processes data, you could mention here for example how the input is prepared for testing - anonymised, synthetic or live data.\n\n## Contributing\n\nDescribe or link templates on how to raise an issue, feature request or make a contribution to the codebase. Reference the other documentation files, like\n\n- Environment setup for contribution, i.e. `CONTRIBUTING.md`\n- Coding standards, branching, linting, practices for development and testing\n- Release process, versioning, changelog\n- Backlog, board, roadmap, ways of working\n- High-level requirements, guiding principles, decision records, etc.\n\n## Contacts\n\nProvide a way to contact the owners of this project. It can be a team, an individual or information on the means of getting in touch via active communication channels, e.g. opening a GitHub discussion, raising an issue, etc.\n\n## Licence\n\n\u003e The [LICENCE.md](./LICENCE.md) file will need to be updated with the correct year and owner\n\nUnless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.\n\nAny HTML or Markdown documentation is [© Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/) and available under the terms of the [Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fnhs-notify-shared-modules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhsdigital%2Fnhs-notify-shared-modules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fnhs-notify-shared-modules/lists"}