Skip to content

Commit 3738e97

Browse files
authored
Docs: [AEA-0000] - Tweak the README (#11)
## Summary - Routine Change ### Details Just making the README a bit clearer.
1 parent 18c2e69 commit 3738e97

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# eps-workflow-quality-checks
2-
A workflow to run the quality checks for EPS repositories. The steps executed by this script are as follows:
2+
3+
4+
A workflow to run the quality checks for EPS repositories. The main element of this lives in the [`quality-checks.yml`](./.github/workflows/quality-checks.yml) configuration file. The steps executed by this workflow are as follows:
35

46
- **Install Project Dependencies**
57
- **Generate and Check SBOMs**: Creates Software Bill of Materials (SBOMs) to track dependencies for security and compliance. Uses [THIS](https://github.com/NHSDigital/eps-action-sbom) action.
@@ -23,7 +25,7 @@ In order to enable the pre-commit hook for secret scanning (to prevent developer
2325
```json
2426
{
2527
"remoteEnv": { "LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}" },
26-
"postAttachCommand": "docker build -f https://raw.githubusercontent.com/NHSDigital/eps-workflow-quality-checks/refs/tags/v3.0.0/dockerfiles/nhsd-git-secrets.dockerfile -t git-secrets . && pre-commit install --install-hooks -f",
28+
"postAttachCommand": "docker build -f https://raw.githubusercontent.com/NHSDigital/eps-workflow-quality-checks/refs/tags/v4.0.2/dockerfiles/nhsd-git-secrets.dockerfile -t git-secrets . && pre-commit install --install-hooks -f",
2729
"features": {
2830
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {
2931
"version": "latest",
@@ -33,6 +35,7 @@ In order to enable the pre-commit hook for secret scanning (to prevent developer
3335
}
3436
}
3537
```
38+
3639
And the this pre-commit hook to the `.pre-commit-config.yaml` file:
3740
```yaml
3841
repos:
@@ -85,7 +88,7 @@ on:
8588
8689
jobs:
8790
quality_checks:
88-
uses: NHSDigital/eps-workflow-quality-checks/.github/workflows/quality-checks.yml@main
91+
uses: NHSDigital/eps-workflow-quality-checks/.github/workflows/quality-checks.yml@4.0.2
8992
secrets:
9093
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
9194
```

0 commit comments

Comments
 (0)