Skip to content

Commit 60ef36f

Browse files
authored
Clean up unneeded resources and documentation (#44)
1 parent cedcb3d commit 60ef36f

File tree

63 files changed

+9855
-11405
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+9855
-11405
lines changed

.editorconfig

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,6 @@ trim_trailing_whitespace = unset
2929
indent_style = unset
3030
indent_size = unset
3131
generated_code = true
32+
33+
[/packages/events/**/*.schema.json]
34+
insert_final_newline = unset

.editorconfig-checker.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"AllowedContentTypes": [],
3+
"Debug": false,
4+
"Disable": {
5+
"EndOfLine": false,
6+
"IndentSize": false,
7+
"Indentation": false,
8+
"InsertFinalNewline": false,
9+
"MaxLineLength": false,
10+
"TrimTrailingWhitespace": false
11+
},
12+
"Exclude": [
13+
"\\.schema\\.json$"
14+
],
15+
"IgnoreDefaults": false,
16+
"NoColor": false,
17+
"PassedFiles": [],
18+
"SpacesAfterTabs": false,
19+
"Verbose": false
20+
}

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# NHS Notify Code Owners
22

33
# Notify default owners
4-
* @NHSDigital/nhs-notify-client-config
4+
* @NHSDigital/nhs-notify-supplier-config
55

66
/.github/ @NHSDigital/nhs-notify-admins
77
*.code-workspace @NHSDigital/nhs-notify-admins

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,46 @@ Event publishing strategies include:
3535
- CLI tools (tactical)
3636
- Admin/Web UI (strategic, single source of truth)
3737

38+
## Event Builder CLI
39+
40+
The Excel parsing and event publishing functionality now lives in the `event-builder` package, exposed via a single CLI with subcommands.
41+
42+
### Commands
43+
44+
- `parse` – Parse an Excel specification file and emit JSON to stdout (packs + variants).
45+
- `publish` – Build specialised (non-draft) LetterVariant events and publish them to an AWS EventBridge bus.
46+
47+
### Quick Start
48+
49+
```bash
50+
# Parse
51+
npm run cli:events --workspace=nhs-notify-supplier-config-event-builder -- parse -f ./specifications.xlsx
52+
53+
# Dry-run publish (no AWS calls)
54+
npm run cli:events --workspace=nhs-notify-supplier-config-event-builder -- publish -f ./specifications.xlsx -b my-bus --dry-run
55+
56+
# Publish (requires AWS credentials with events:PutEvents)
57+
npm run cli:events --workspace=nhs-notify-supplier-config-event-builder -- publish -f ./specifications.xlsx -b my-bus -r eu-west-2
58+
```
59+
60+
### Envelope Defaults
61+
62+
Source: `/control-plane/supplier-config/<env>/<service>` built from `EVENT_ENV` (default `dev`) and `EVENT_SERVICE` (default `events`).
63+
64+
Other generated fields:
65+
66+
- `severitytext` INFO / `severitynumber` 2
67+
- `partitionkey` LetterVariant id
68+
- `sequence` Incrementing zero-padded 20-digit counter per run
69+
- `traceparent` Random W3C trace context value
70+
- `dataschema` & `dataschemaversion` fixed to example `1.0.0`
71+
72+
Set environment overrides:
73+
74+
```bash
75+
EVENT_ENV=staging EVENT_SERVICE=config npm run cli:events --workspace=nhs-notify-supplier-config-event-builder -- publish -f specs.xlsx -b staging-bus -r eu-west-2
76+
```
77+
3878
## Usage
3979

4080
### Testing

docs/_includes/notify-repo-list.html

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/_includes/notify-repo-table.html

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/_layouts/notify-repo.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

docs/_posts/2024-05-22-welcome-to-jekyll.markdown

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/adr/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md

Lines changed: 0 additions & 161 deletions
This file was deleted.

0 commit comments

Comments
 (0)