Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/1_support_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ body:
- type: checkboxes
attributes:
label: Code of Conduct
description: By submitting this issue you agree to follow our [Code of Conduct](../../docs/CODE_OF_CONDUCT.md)
description: By submitting this issue you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/2_feature_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ body:
- type: checkboxes
attributes:
label: Code of Conduct
description: By submitting this issue you agree to follow our [Code of Conduct](../../docs/CODE_OF_CONDUCT.md)
description: By submitting this issue you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/3_bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ body:
- type: checkboxes
attributes:
label: Code of Conduct
description: By submitting this issue you agree to follow our [Code of Conduct](../../docs/CODE_OF_CONDUCT.md)
description: By submitting this issue you agree to follow our Code of Conduct
options:
- label: I agree to follow this project's Code of Conduct
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->

- [ ] I am familiar with the [contributing guidelines](../docs/CONTRIBUTING.md)
- [ ] I am familiar with the [contributing guidelines](../CONTRIBUTING.md)
- [ ] I have followed the code style of the project
- [ ] I have added tests to cover my changes
- [ ] I have updated the documentation accordingly
Expand Down
44 changes: 0 additions & 44 deletions .github/actions/build-docs/action.yml

This file was deleted.

54 changes: 0 additions & 54 deletions .github/workflows/cicd-3-deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,57 +64,3 @@ jobs:
export VERSION="${{ steps.variables.outputs.version }}"
# export TAG="${{ steps.variables.outputs.tag }}"
make list-variables

deploy-jekyll:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: metadata
steps:
- name: "Checkout code"
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: "Get version"
id: get-asset-version
shell: bash
env:
GH_TOKEN: ${{ github.token }}
INCLUDE_PRERELEASES: ${{ inputs.include_prereleases }}
REQUESTED_VERSION: ${{ inputs.version }}
run: |
if [[ "$INCLUDE_PRERELEASES" == "true" ]]; then
json=$(gh release list --json tagName --limit 1 --exclude-drafts)
else
json=$(gh release list --json tagName --limit 1 --exclude-drafts --exclude-pre-releases)
fi

echo $json

release_version=$(echo $json | (jq -r '.[0].tagName'))
if [[ $release_version == null ]]; then exit 1; else echo $release_version; fi

if [[ "$REQUESTED_VERSION" == "latest" ]]; then
echo "release_version=$release_version" >> "$GITHUB_OUTPUT"
else
echo "release_version=$REQUESTED_VERSION" >> "$GITHUB_OUTPUT"
fi

- name: "Get release version"
id: download-asset
shell: bash
env:
GH_TOKEN: ${{ github.token }}
RELEASE_VERSION: ${{ steps.get-asset-version.outputs.release_version }}
run: |
gh release download "$RELEASE_VERSION" -p jekyll-docs-*.tar --output artifact.tar

- uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: jekyll-docs-${{steps.get-asset-version.outputs.release_version}}
path: artifact.tar

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0
with:
artifact_name: jekyll-docs-${{steps.get-asset-version.outputs.release_version}}
16 changes: 0 additions & 16 deletions .github/workflows/stage-3-build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,6 @@ on:
type: string

jobs:
artefact-jekyll-docs:
name: "Build Docs"
runs-on: ubuntu-latest
timeout-minutes: 3
steps:
- name: "Checkout code"
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: "Setup pnpm"
uses: pnpm/action-setup@0ebf47130e4866e96fce0953f49152a61190b271 # v6.0.9
with:
version: "${{ inputs.pnpm_version }}"
cache: true
- name: "Build docs"
uses: ./.github/actions/build-docs
with:
version: "${{ inputs.version }}"
artefact-1:
name: "Artefact 1"
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ At a glance, the main areas are:
- `infrastructure/terraform/` – Terraform components, and shared modules for AWS accounts and environments.
- `lambdas/` – TypeScript lambda projects (each with their own `package.json`, Jest config, etc.). Root level packages.json defines scripts. Tests for the lambda are stored in `lambdas/{name}/src/__test`.
- `src/` and `utils/` – Shared code and utilities (for example `utils/logger`).
- `docs/` – Documentation site, ADRs, RFCS, and other long‑form docs.
- `CONTRIBUTING.md` – Contribution guidance and repository working practices.
- `.github/workflows/` and `.github/actions/` – GitHub Actions workflows and composite actions.
- `scripts/` – Helper scripts and tooling used by humans and workflows.
- `tests/` – Cross‑cutting tests and harnesses for the repo.
Expand Down
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing

This repository provides a reusable starting point for NHS Notify projects.
Contributions that improve its clarity, quality, and maintainability are welcome.

## Before Opening A Pull Request

- Keep changes focused and explain the reason for them.
- Do not commit secrets, credentials, tokens, or personal information.
- Update relevant configuration and documentation when behaviour changes.
- Add or update tests where applicable.
- Check that generated files remain consistent with their source files.

## Validation

Run the checks relevant to your change from the repository root. The standard Make targets include:

```bash
make config
make test
```

For workflow, YAML, Make, and configuration changes, also validate the edited files and run `git diff --check`.

## Pull Requests

- Use a clear, concise title that includes the relevant work item where one exists.
- Describe what changed and why.
- Include the validation commands you ran and their results.
- Call out known limitations, follow-up work, or deployment considerations.
- Ensure required reviews and CI checks have passed before merging.
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Any code files or example documentation that is not used in the new repository s

- [NHS Notify Repository Template](#nhs-notify-repository-template)
- [Table of Contents](#table-of-contents)
- [Documentation](#documentation)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Configuration](#configuration)
Expand All @@ -33,11 +32,6 @@ Any code files or example documentation that is not used in the new repository s
- [Contacts](#contacts)
- [Licence](#licence)

## Documentation

- [Built](/)
- [Source](/docs/README.md)

## Setup

By 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.
Expand Down Expand Up @@ -85,7 +79,7 @@ make config

## Usage

After a successful installation, provide an informative example of how this project can be used. Additional code snippets, screenshots and demos work well in this space. You may also link to the other documentation resources, e.g. the [User Guide](./docs/user-guide.md) to demonstrate more use cases and to show more features.
After a successful installation, provide an informative example of how this project can be used. Additional code snippets, screenshots and demos work well in this space.

### Testing

Expand All @@ -97,9 +91,7 @@ There are `make` tasks for you to configure to run your tests. Run `make test`

The [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.

![Repository Template](./docs/diagrams/Repository_Template_GitHub_Generic.png)

The source for diagrams should be in Git for change control and review purposes. Recommendations are [draw.io](https://app.diagrams.net/) (example above in [docs](.docs/diagrams/) folder) and [Mermaids](https://github.com/mermaid-js/mermaid). Here is an example Mermaids sequence diagram:
The 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:

```mermaid
sequenceDiagram
Expand All @@ -119,7 +111,7 @@ Most of the projects are built with customisability and extendability in mind. A

Describe or link templates on how to raise an issue, feature request or make a contribution to the codebase. Reference the other documentation files, like

- Environment setup for contribution, i.e. `CONTRIBUTING.md`
- [Contribution guide](./CONTRIBUTING.md)
- Coding standards, branching, linting, practices for development and testing
- Release process, versioning, changelog
- Backlog, board, roadmap, ways of working
Expand Down
2 changes: 0 additions & 2 deletions docs/.bundle/config

This file was deleted.

9 changes: 0 additions & 9 deletions docs/.gitignore

This file was deleted.

19 changes: 0 additions & 19 deletions docs/.vscode/launch.json

This file was deleted.

13 changes: 0 additions & 13 deletions docs/.vscode/tasks.json

This file was deleted.

25 changes: 0 additions & 25 deletions docs/404.html

This file was deleted.

37 changes: 0 additions & 37 deletions docs/Gemfile

This file was deleted.

Loading
Loading