Skip to content

Commit

Permalink
Change: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@pascalholthaus @greenbonebot
pascalholthaus authored and greenbonebot committed Feb 14, 2024
1 parent 0202c37 commit 80b5515
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 22 deletions.
43 changes: 23 additions & 20 deletions container-build-push-generic/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,26 +37,29 @@ jobs:

## Inputs

| Name | Description | |
|------------------------------|--------------------------------------------------------------------------------------------------------------------|----------|
| build-context | Path to image build context. Default is "." | Optional |
| build-docker-file | Path to the docker file. Default is "./Dockerfile" | Optional |
| build-args | Use these build-args for the docker build process. Default is empty | Optional |
| build-secrets | Use these build-secrets for the docker build process. Default is empty | Optional |
| cosign-key | Cosign key to sign the image. Will be skipped if empty. Default is empty | Optional |
| cosign-key-password | Cosign key password. Will be skipped if empty. Default is empty | Optional |
| cosign-tlog-upload | Turn on or turn off the cosign tlog upload function. Possible options: true/false Default is true | Optional |
| image-labels | Image labels. | Required |
| image-url | Image url/name without registry. Default is github.repository | Optional |
| image-platforms | Image platforms to build for. Default is "linux/amd64" | Optional |
| image-tags | Image tags. | Required |
| registry | Registry url. | Required |
| registry-username | Login registry username. | Required |
| registry-password | Login registry password. | Required |
| scout-user | Dockerhub user for docker scout. Will be skipped if empty. Default is empty | Optional |
| scout-password | Dockerhub user password for docker scout. Will be skipped if empty. Default is empty | Optional |
| scout-keep-previous-comments | Keep but hide previous comment. If not set, keep and update one single comment per job. Default is `false` | Optional |
| sarif-retention-days | Days to store the sarif artifact. Default is 1 | Optional |
| Name | Description | |
|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|----------|
| build-context | Path to image build context. Default is "." | Optional |
| build-docker-file | Path to the docker file. Default is "./Dockerfile" | Optional |
| build-args | Use these build-args for the docker build process. Default is empty | Optional |
| build-secrets | Use these build-secrets for the docker build process. Default is empty | Optional |
| cosign-key | Cosign key to sign the image. Will be skipped if empty. Default is empty | Optional |
| cosign-key-password | Cosign key password. Will be skipped if empty. Default is empty | Optional |
| cosign-tlog-upload | Turn on or turn off the cosign tlog upload function. Possible options: true/false Default is true | Optional |
| image-labels | Image labels. | Required |
| image-url | Image url/name without registry. Default is github.repository | Optional |
| image-platforms | Image platforms to build for. Default is "linux/amd64" | Optional |
| image-tags | Image tags. | Required |
| meta-annotations-levels | Comma separated list. Options are manifest, index, manifest-descriptor, index-descriptor. Default is manifest,manifest-descriptor . | Optional |
| registry | Registry url. | Required |
| registry-username | Login registry username. | Required |
| registry-password | Login registry password. | Required |
| scout-command | Comma separated list of several commands. Options are quickview, compare, cves, recommendations, sbom, environment. Default is cves,sbom . | Optional |
| scout-user | Dockerhub user for docker scout. Will be skipped if empty. Default is empty | Optional |
| scout-password | Dockerhub user password for docker scout. Will be skipped if empty. Default is empty | Optional |
| scout-keep-previous-comments | Keep but hide previous comment. If not set, keep and update one single comment per job. Default is `false` | Optional |
| sarif-retention-days | Days to store the sarif artifact. Default is 1 | Optional |
| qemu-platforms | Comma separated list of platforms to install. Options are amd64, arm64, arm, riscv64, s390x, 386. Default is arm64 (amd64 is default arch). | Optional |

## Action Output

Expand Down
4 changes: 2 additions & 2 deletions container-build-push-generic/action.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ inputs:
description: "Image platforms to build for. Default is linux/amd64"
default: "linux/amd64"
meta-annotations-levels:
description: "Comma separated list of annotations levels. Options are manifest, index, manifest-descriptor, index-descriptor. Default is manifest,manifest-descriptor ."
description: "Comma separated list. Options are manifest, index, manifest-descriptor, index-descriptor. Default is manifest,manifest-descriptor ."
default: "manifest,manifest-descriptor"
registry:
description: "Registry url."
Expand All @@ -57,7 +57,7 @@ inputs:
description: "Days to store the sarif artifact. Default is 1"
default: 1
qemu-platforms:
description: "Comma separated list of platforms to install. Options are amd64, arm64, arm, riscv64, s390x, 386. Default is arm64. We don't need amd64 because it is the default arch."
description: "Comma separated list of platforms to install. Options are amd64, arm64, arm, riscv64, s390x, 386. Default is arm64 (amd64 is default arch)."
default: "arm64"

outputs:
Expand Down

0 comments on commit 80b5515

Please sign in to comment.