Skip to content

Commit 00da81d

Browse files
committed
update docs
1 parent 0127a8f commit 00da81d

2 files changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ The base image contains
3333
- asdf
3434
- aws cli
3535
- aws sam cli
36+
- gitleaks
37+
- shellcheck
38+
- direnv
39+
- yq
40+
- zizmor
41+
- grype
42+
- syft
43+
- grant
3644

3745
It installs the following dev container features
3846
- docker outside of docker
@@ -41,14 +49,10 @@ The base image contains
4149
As the vscode user the following also happens
4250

4351
asdf install and setup for these so they are available globally as vscode user
44-
- shellcheck
45-
- direnv
4652
- actionlint
4753
- ruby (for GitHub Pages)
48-
- yq
4954

5055
Install and setup git-secrets.
51-
Install [zizmor](https://github.com/zizmorcore/zizmor).
5256

5357
# Using the images
5458
## Project setup
@@ -176,7 +180,7 @@ Check targets (`check.mk`)
176180
- `cfn-guard-cdk` - validates `cdk.out` against cfn-guard rulesets and writes outputs to `.cfn_guard_out/`
177181
- `cfn-guard-terraform` - validates `terraform_plans` against cfn-guard rulesets and writes outputs to `.cfn_guard_out/`
178182
- `actionlint` - runs actionlint against GitHub Actions
179-
- `secret-scan` - runs git-secrets (including scanning history) against the repository
183+
- `secret-scan` - runs git-secrets or gitleaks (including scanning history) against the repository
180184
- `guard-<ENVIRONMENT_VARIABLE>` - checks if an environment variable is set and errors if it is not
181185
- `zizmor` - runs [zizmor](https://github.com/zizmorcore/zizmor) in the local directory to check github workflows and actions
182186
- `syft-generate-sbom` - uses syft to generate an sbom in cyclonedx-json format. This *does not* include dev dependencies. Outputs file to .sbom/sbom.cdx.json.
@@ -369,7 +373,7 @@ CONTAINER_NAME=base \
369373

370374
# Cleaning up unused container images
371375

372-
There is a script to delete unused container images. This runs on every merge to main and deletes pull request images, and on a weekly schedule it deletes images created by CI.
376+
There is a script to delete unused container images on github. This runs on every merge to main and deletes pull request images, and on a weekly schedule it deletes images created by CI.
373377
You can run it manually using the following. Using the `dry-run` flag just shows what would be deleted
374378

375379
```

src/base/.devcontainer/Mk/check.mk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ secret-scan:
8787
@if [ -f .gitallowed ]; then \
8888
git-secrets --scan-history .; \
8989
else \
90-
gitleaks -v git; \
90+
gitleaks -v --redact git; \
9191
fi
9292

9393
guard-%:

0 commit comments

Comments
 (0)