From ce22fddff6ddf0e908cfe998177d2df7e82bee78 Mon Sep 17 00:00:00 2001 From: ashnamehrotra Date: Tue, 20 Feb 2024 11:54:01 -0800 Subject: [PATCH 1/2] clarify docs Signed-off-by: ashnamehrotra --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8a82b29..f4cd6b3 100644 --- a/README.md +++ b/README.md @@ -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 From 9a900a8dd8465cad2ac39259278e661793cee17c Mon Sep 17 00:00:00 2001 From: ashnamehrotra Date: Tue, 20 Feb 2024 11:57:20 -0800 Subject: [PATCH 2/2] remove extra space Signed-off-by: ashnamehrotra --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f4cd6b3..d220420 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Copacetic Action is supported with Copa version 0.3.0 and later. | `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) | +| `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.