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

SCP-166 Updates readme.md #34

Merged
merged 1 commit into from
Mar 4, 2024
Merged

SCP-166 Updates readme.md #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file modified .github/assets/img_checks.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/img_job_summary.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .github/assets/img_pr_comment.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@
The SCANOSS Scan Action enhances your software development process by automatically scanning your code for security
vulnerabilities and license compliance with configurable policies.

![JOB Summary](./.github/assets/img_job_summary.jpg)
<div style="text-align: center">

![JOB Summary](./.github/assets/img_job_summary.png)

</div>

## Usage

Expand Down Expand Up @@ -43,8 +47,8 @@ jobs:
uses: scanoss/actions-scan@main
```

For example workflow runs, check out the
[Actions Tab](https://github.com/scanoss/actions-scan/actions)! :rocket:
For example workflow runs, check out our
[GitHub Action Usage Example](https://github.com/scanoss/integration-test) :rocket:

### Action Input Parameters

Expand All @@ -55,10 +59,10 @@ For example workflow runs, check out the
| sbom.filepath | Filepath of the SBOM file to be used for scanning | Optional | `sbom.json` |
| sbom.type | Type of SBOM operation: either 'identify' or 'ignore | Optional | `identify` |
| dependencies.enabled | Option to enable or disable scanning of dependencies. | Optional | `false` |
| policies | List of policies separated by commas, options available are: copyleft, undeclared. | Optional | `true` |
| policies | List of policies separated by commas, options available are: copyleft, undeclared. | Optional | - |
| policies.halt_on_failure | Halt check on policy failure. If set to false checks will not fail. | Optional | `true` |
| api.url | SCANOSS API URL | Optional | `https://osskb.org/api/scan/direct` |
| api.key | SCANOSS API Key token | Optional | - |
| api.key | SCANOSS API Key | Optional | - |

### Action Output Parameters

Expand All @@ -70,8 +74,7 @@ the output into your custom workflow
| result-filepath | Scanner results filepath |
| stdout-scan-command | Scanner command output |

## Policy Checks (wip)

## Policy Checks
The SCANOSS Scan action includes two configurable policies:

1. Copyleft: This policy checks if any component or code snippet is associated with a copyleft license. If such a
Expand Down
Loading