|
1 | 1 | # Sysdig Secure Inline Scan Action |
2 | 2 |
|
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). |
4 | 4 |
|
5 | 5 | ## Inputs |
6 | 6 |
|
7 | 7 | ### `image-tag` |
8 | 8 |
|
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"`. |
10 | 10 |
|
11 | 11 | ### `sysdig-secure-token` |
12 | 12 |
|
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"`. |
14 | 14 |
|
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. |
16 | 16 |
|
17 | 17 | ### `sysdig-secure-url` |
18 | 18 |
|
19 | | -URL to Sysdig Secure URL (ex: "https://secure-sysdig.com"). |
| 19 | +Sysdig Secure URL. Example: "https://secure-sysdig.svc.cluster.local". |
20 | 20 |
|
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/). |
22 | 22 |
|
23 | 23 | ### `dockerfile-path` |
24 | 24 |
|
25 | | -Path to Dockerfile (ex: "./Dockerfile") |
| 25 | +Path to Dockerfile. Example: `"./Dockerfile"`. |
26 | 26 |
|
27 | 27 | ### `pull-from-registry` |
28 | 28 |
|
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. |
30 | 30 |
|
31 | 31 | ## Example usage |
32 | 32 |
|
|
0 commit comments