Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify docs #39

Merged
merged 2 commits into from
Feb 20, 2024
Merged

docs: clarify docs #39

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce22fdd
clarify docs
ashnamehrotra Feb 20, 2024
9a900a8
remove extra space
ashnamehrotra Feb 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@ Copacetic Action is supported with Copa version 0.3.0 and later.

## Inputs

| Name | Type | Required | Default | Description |
| ------------------ | ------ | -------- | --------- | -------------------------------------------------------------------------- |
| `image` | String | True | | Image reference to patch |
| `image-report` | String | True | | Trivy JSON vulnerability report of the image to patch |
| `patched-tag` | String | True | | Patched image tag |
| `timeout` | String | False | `5m` | Timeout for `copa patch` |
| `buildkit-version` | String | False | `latest` | Buildkit version |
| `copa-version` | String | False | `latest` | Copa version |
| `output` | String | False | | Output filename (available with copa-action v0.6.1 and later) |
| `format` | String | False | `openvex` | Output format (available with copa-action v0.6.1 and later) |
| `custom-socket` | String | False | | Custom Docker socket address (available with copa-action v0.6.1 and later) |
| Name | Type | Required | Default | Description |
| ------------------ | ------ | -------- | --------- | ------------------------------------------------------------------------------------- |
| `image` | String | True | | Image reference to patch |
| `image-report` | String | True | | Trivy JSON vulnerability report of the image to patch |
| `patched-tag` | String | True | | Patched image tag |
| `timeout` | String | False | `5m` | Timeout for `copa patch` |
| `buildkit-version` | String | False | `latest` | Buildkit version |
| `copa-version` | String | False | `latest` | Copa version |
| `output` | String | False | | Output filename (available using copa-action with copa v0.6.1 and later) |
| `format` | String | False | `openvex` | Output format (available using copa-action with copa v0.6.1 and later) |
| `custom-socket` | String | False | | Custom Docker socket address (available using copa-action with copa v0.6.1 and later) |

> [!NOTE]
> Features that are supported with new Copacetic releases will not neccessarily align with what is supported with Copa Action versions.
> For example, the `output` file feature was released in Copa v0.5.0, but is supported with Copa Action v0.6.1 and later.
> Features that are supported with new Copacetic releases will not neccessarily align with what is supported with Copa Action.
> For example, the `output` file feature was released in Copa v0.5.0, but is supported with Copa Action when using Copa version v0.6.1 and later.

## Outputs

Expand Down
Loading