Skip to content

Commit

Permalink
docs: clarify docs (#39)
Browse files Browse the repository at this point in the history
Signed-off-by: ashnamehrotra <[email protected]>
  • Loading branch information
ashnamehrotra authored Feb 20, 2024
1 parent fa30cbf commit eeead82
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
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

0 comments on commit eeead82

Please sign in to comment.