Skip to content

Commit 7ee2ba0

Browse files
committed
Fix some mistakes in README
1 parent ef6a915 commit 7ee2ba0

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
# Sysdig Secure Inline Scan Action
22

3-
This action performs image analysis on locally built container image and posts the result of the analysis to Sysdig Secure. For more information about Secure Inline Scan, see https://github.com/sysdiglabs/secure-inline-scan and read [Sysdig Secure documentation](https://docs.sysdig.com/en/image-scanning.html)
3+
This action performs analysis on locally built container image and posts the result to Sysdig Secure. For more information about Secure Inline Scan, see https://github.com/sysdiglabs/secure-inline-scan and read [Sysdig Secure documentation](https://docs.sysdig.com/en/image-scanning.html).
44

55
## Inputs
66

77
### `image-tag`
88

9-
**Required** The tag of the image to scan. The image needs to be build on a previous step, as the scan is done locally. Example: `"sysdiglabs/dummy-vuln-app:latest"`
9+
**Required** The tag of the local image to scan. Example: `"sysdiglabs/dummy-vuln-app:latest"`.
1010

1111
### `sysdig-secure-token`
1212

13-
**Required** API token for Sysdig Scanning auth. Example: `"924c7ddc-4c09-4d22-bd52-2f7db22f3066"`
13+
**Required** API token for Sysdig Scanning auth. Example: `"924c7ddc-4c09-4d22-bd52-2f7db22f3066"`.
1414

15-
It is not recommended to hardcode the API token in the action, but [store it in Github secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) instead and use `${{ secrets.MY_SECRET_NAME }}` instead.
15+
Directly specifying the API token in the action configuration is not recommended. A better approach is to [store it in GitHub secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets), and reference `${{ secrets.MY_SECRET_NAME }}` instead.
1616

1717
### `sysdig-secure-url`
1818

19-
URL to Sysdig Secure URL (ex: "https://secure-sysdig.com").
19+
Sysdig Secure URL. Example: "https://secure-sysdig.svc.cluster.local".
2020

21-
If not specified, it will default to Sysdig Secure SaaS URL (https://secure.sysdig.com)
21+
If not specified, it will default to Sysdig Secure SaaS URL (https://secure.sysdig.com/).
2222

2323
### `dockerfile-path`
2424

25-
Path to Dockerfile (ex: "./Dockerfile")
25+
Path to Dockerfile. Example: `"./Dockerfile"`.
2626

2727
### `pull-from-registry`
2828

29-
Pull docker image from registry instead of using locally built image.
29+
Pull container image from registry instead of using the locally built image.
3030

3131
## Example usage
3232

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ inputs:
88
description: 'API token for Sysdig Scanning auth'
99
required: true
1010
sysdig-secure-url:
11-
description: 'URL to Sysdig Secure URL (ex: "https://secure-sysdig.com")'
11+
description: 'Sysdig Secure URL (ex: "https://secure-sysdig.com")'
1212
required: false
1313
default: https://secure.sysdig.com
1414
dockerfile-path:

0 commit comments

Comments
 (0)