You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-10Lines changed: 20 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,16 +13,8 @@ This is a service used within the NHS for managing and recording school-aged vac
13
13
|[Training](https://github.com/nhsuk/manage-vaccinations-in-schools/deployments/training)|[training.manage-vaccinations-in-schools.nhs.uk](https://training.manage-vaccinations-in-schools.nhs.uk)| External training | ❌ |`release` branch | manual |[`staging`](config/environments/staging.rb)|
14
14
|[Production](https://github.com/nhsuk/manage-vaccinations-in-schools/deployments/production)|[www.manage-vaccinations-in-schools.nhs.uk](https://www.manage-vaccinations-in-schools.nhs.uk)| Live service | ✅ |`release` branch | manual |[`production`](config/environments/production.rb)|
15
15
16
-
## Releasing
17
-
18
-
See the [releasing documentation](docs/releasing.md) for more information.
19
-
20
16
## Development
21
17
22
-
### Branching strategy
23
-
24
-
See the [branching strategy documentation](docs/branching.md) for more information.
25
-
26
18
### Prerequisites
27
19
28
20
This project depends on:
@@ -99,12 +91,26 @@ To run the project locally:
99
91
bin/setup
100
92
```
101
93
94
+
### Branching strategy
95
+
96
+
See the [branching strategy documentation](docs/branching.md) for more information.
97
+
102
98
### Linting
103
99
104
-
To run the linters:
100
+
The linters are configured to run using [`hk`](https://hk.jdx.dev/) which is a tool for running hooks in a Git repository.
101
+
102
+
If using `mise` this should have already been installed as it's listed in `.tool-versions`, but it can be installed manually by running:
105
103
106
104
```shell
107
-
bin/lint
105
+
mise use hk pkl
106
+
```
107
+
108
+
To run the linters you can use `hk check` and `hk fix` to check and fix any linting issues respectively. Alternatively `bin/lint` is provided as a way of running the linters without needing to know about `hk`.
109
+
110
+
`hk` allows for the linters to be installed as Git hook, ensuring they are run on each commit. This can be configured by running:
111
+
112
+
```shell
113
+
hk install
108
114
```
109
115
110
116
### Intellisense
@@ -315,6 +321,10 @@ automatically be added to the JWKS generated for `/oidc/jwks`, but the old
315
321
public key can also be added to `JWKSController::EXTRA_JWK` to ensure a smooth
316
322
roll-over.
317
323
324
+
## Releasing
325
+
326
+
See the [releasing documentation](docs/releasing.md) for more information.
0 commit comments