Skip to content

Commit

Permalink
docs: enhanced documentation of the docker-scan-image-dir
Browse files Browse the repository at this point in the history
Refs: AAE-17459
  • Loading branch information
gicappa committed Oct 25, 2023
1 parent 1d42f08 commit de8c713
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,7 @@ The two vars in the previous snippet are [workflow configuration variables](http
Build docker image based on supplied jar files. It replaces `image-dir` and `image-tag` in the
docker file and build it. After the build if `grype-scan-enabled` is `true` it scans the image using grype and upload the result in GitHub security.
Finally, it push the created image into:

- RedHat quay.io
- GitHub ghcr
- AWS ECR
Expand All @@ -374,6 +375,7 @@ Finally, it push the created image into:
# preview-label: ${{ vars.PREVIEW_LABEL }} # optional
```

| Input | Required | Description |
|-----------------------|----------|----------------------------------------------------------------------|
| base-directory | false | base working directory directory |
Expand Down Expand Up @@ -404,6 +406,8 @@ It is also possible to specify the output archive name when providing the `outpu

### docker-scan-image-dirs

Scan the directories were the Dockerfiles are to feed the scanner.

```yaml
- uses: Alfresco/alfresco-build-tools/.github/actions/docker-scan-image-dirs@ref
```
Expand Down

0 comments on commit de8c713

Please sign in to comment.