Skip to content

Commit

Permalink
Merge pull request #242 from abelsromero/add-cve-scan-steps-to-README
Browse files Browse the repository at this point in the history
Add Trivy CVE scan info to README
  • Loading branch information
dduportal authored Feb 15, 2022
2 parents 5863c41 + 66206b6 commit aeb5b20
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
2 changes: 0 additions & 2 deletions .github/containerscan/allowedlist.yaml

This file was deleted.

16 changes: 16 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ You need the following tools:
* link:http://man7.org/linux/man-pages/man1/make.1.html[GNU make]
* link:https://github.com/sstephenson/bats[Bats] installed and in your bash PATH
* Docker installed and in your path
* link:https://github.com/aquasecurity/trivy[Trivy] cli in case you want to scan images for vulnerabilities

=== How to build and test?

Expand All @@ -145,6 +146,21 @@ export DOCKER_IMAGE_NAME_TO_TEST=your-image-name
bats tests/*.bats
----

=== How to scan for vulnerabilities?

* Trivy scans a docker image looking for software versions containing known vulnerabilities (CVEs).
It's always a good idea to scan the image to ensure no new issues are introduced.

* Run the following command to replicate the repo's `CVE Scan` pipeline on an image build locally.
Note the pipeline runs nightly on the latest release version, so it can display issues solved in main branch.
+
[source,bash]
----
trivy image --severity HIGH,CRITICAL asciidoctor:latest
----



==== Deploy

The goal for deploying is to make the Docker image available with the correct Docker tag in Docker Hub.
Expand Down

0 comments on commit aeb5b20

Please sign in to comment.