Skip to content

Commit d561069

Browse files
committed
update readme
1 parent e51383d commit d561069

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

.github/workflows/quality-checks.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,10 @@ jobs:
114114
echo "cdk_exists=false" >> $GITHUB_OUTPUT
115115
fi
116116
117+
- name: Check licenses (Makefile)
118+
run: |
119+
make check-licenses
120+
117121
- name: Check licenses (Python)
118122
if: steps.check_poetry.outputs.uses_poetry == 'true'
119123
run: |

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ A workflow to run the quality checks for EPS repositories. The steps executed by
66
- **Run Linting**
77
- **Run Unit Tests**
88
- **SonarCloud Scan**: Performs code analysis using SonarCloud to detect quality issues and vulnerabilities.
9-
- **Validate CloudFormation Templates** (*Conditional*): If CloudFormation or AWS SAM templates are present, runs `cfn-lint` and `cfn-guard` to validate templates against AWS best practices and security rules.
9+
- **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.
10+
- **CDK Synth** (*Conditional*): Runs `make cdk-synth` if packages/cdk folder exists
11+
- **Check Licenses**: Runs `make check-licenses`.
1012
- **Check Python Licenses** (*Conditional*): If the project uses Poetry, scans Python dependencies for incompatible licenses.
1113

1214
# Usage
@@ -24,6 +26,8 @@ In order to run, these `make` commands must be present. They may be mocked, if t
2426
- `install`
2527
- `lint`
2628
- `test`
29+
- `check-licenses`
30+
- `cdk-synth` - only needed if packages/cdk folder exists
2731

2832
## Environment variables
2933

0 commit comments

Comments
 (0)