Skip to content

Commit f99b3f5

Browse files
committed
update readme
1 parent cd69436 commit f99b3f5

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

.github/workflows/quality-checks.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,10 +209,10 @@ jobs:
209209
run: make lint
210210

211211
- name: actionlint
212-
uses: raven-actions/actionlint@v2
212+
uses: raven-actions/actionlint@3a24062651993d40fed1019b58ac6fbdfbf276cc
213213

214214
- name: Run ShellCheck
215-
uses: ludeeus/action-shellcheck@master
215+
uses: ludeeus/action-shellcheck@00cae500b08a931fb5698e11e79bfbd38e612a38
216216
with:
217217
ignore_paths: >-
218218
*test*

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,18 @@ It also contains a dockerfile that builds an image that contains git-secrets whi
1111

1212
The main quality checks workflow runs comprehensive checks for EPS repositories. The steps executed by this workflow are as follows:
1313

14+
- **Scan git history for secrets**: Scans for secret-like patterns, using https://github.com/NHSDigital/software-engineering-quality-framework/blob/main/tools/nhsd-git-secrets/git-secrets
1415
- **Install Project Dependencies**
16+
- **Check Licenses**: Runs `make check-licenses`.
17+
- **Run Linting** Runs `make lint`.
18+
- **Run actionlint** Runs actionlint using [actionlint](https://github.com/raven-actions/actionlint)
19+
- **Run shellcheck**: Runs shellcheck using [action-shellcheck](https://github.com/ludeeus/action-shellcheck)
20+
- **Run cfn-lint** Runs [cfn-lint](https://github.com/aws-cloudformation/cfn-lint) against files in cloudformation and SAMtemplates folders
21+
- **Run Unit Tests** Runs `make test`.
22+
- **CDK Synth** (*Conditional*): Runs `make cdk-synth` if packages/cdk folder exists
23+
- **Run cloudformation-guard** (*Conditional*): Runs [cfn-guard](https://github.com/aws-cloudformation/cloudformation-guard) if CloudFormation, AWS SAM templates or CDK are present
1524
- **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.
16-
- **Run Linting**
17-
- **Run Unit Tests**
18-
- **Scan git history for secrets**: Scans for secret-like patterns, using https://github.com/NHSDigital/software-engineering-quality-framework/blob/main/tools/nhsd-git-secrets/git-secrets
1925
- **SonarCloud Scan**: Performs code analysis using SonarCloud to detect quality issues and vulnerabilities.
20-
- **Validate CloudFormation Templates** (*Conditional*): If CloudFormation, AWS SAM templates or CDK are present, runs `cfn-lint` (SAM and cloudformation only) and `cfn-guard` to validate templates against AWS best practices and security rules.
21-
- **CDK Synth** (*Conditional*): Runs `make cdk-synth` if packages/cdk folder exists
22-
- **Check Licenses**: Runs `make check-licenses`.
2326
-- **Build dev containers**: Builds dev containers (for x64 and arm64 architecture), pushes to ECR and checks vulnerability scan results
2427

2528

0 commit comments

Comments
 (0)