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.

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-209 Rename GH Action to SCANOSS Code Scan Action #40

Merged
merged 1 commit into from
Mar 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/test-action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
uses: ./
with:
dependencies.enabled: false
policies: copyleft, undeclared
policies: copyleft


- name: Print stdout scan command
Expand Down
40 changes: 19 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# SCANOSS Action
# SCANOSS Code Scan Action

[![GitHub Super-Linter](https://github.com/scanoss/actions-scan/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
![CI](https://github.com/scanoss/actions-scan/actions/workflows/ci.yml/badge.svg)
[![Check dist/](https://github.com/scanoss/actions-scan/actions/workflows/check-dist.yml/badge.svg)](https://github.com/scanoss/actions-scan/actions/workflows/check-dist.yml)
[![CodeQL](https://github.com/scanoss/actions-scan/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/scanoss/actions-scan/actions/workflows/codeql-analysis.yml)
[![GitHub Super-Linter](https://github.com/scanoss/code-scan-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
![CI](https://github.com/scanoss/code-scan-action/actions/workflows/ci.yml/badge.svg)
[![Check dist/](https://github.com/scanoss/code-scan-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/scanoss/scanoss-code-scan-step/actions/workflows/check-dist.yml)
[![CodeQL](https://github.com/scanoss/code-scan-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/scanoss/scanoss-code-scan-step/actions/workflows/codeql-analysis.yml)

The SCANOSS Scan Action enhances your software development process by automatically scanning your code for security
The SCANOSS Code Scan Action enhances your software development process by automatically scanning your code for security
vulnerabilities and license compliance with configurable policies.

<div style="text-align: center">
Expand Down Expand Up @@ -33,18 +33,17 @@ permissions:
checks: write

jobs:
scanoss-analysis:
name: SCANOSS Analysis
scanoss-code-scan:
name: SCANOSS Code Scan
runs-on: ubuntu-latest

steps:
- name: Checkout code
id: checkout
uses: actions/checkout@v4

- name: Run SCANOSS analysis
id: scanoss-scan-action
uses: scanoss/actions-scan@main
- name: Run SCANOSS Code Scan
id: scanoss-code-scan-step
uses: scanoss/code-scan-action@main
```

For example workflow runs, check out our
Expand Down Expand Up @@ -75,7 +74,7 @@ the output into your custom workflow
| stdout-scan-command | Scanner command output |

## Policy Checks
The SCANOSS Scan action includes two configurable policies:
The SCANOSS Code 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
license is detected, the pull request (PR) is rejected.
Expand Down Expand Up @@ -108,18 +107,17 @@ permissions:
checks: write

jobs:
scanoss-analysis:
name: SCANOSS Analysis
scanoss-code-scan:
name: SCANOSS Code Scan
runs-on: ubuntu-latest

steps:
- name: Checkout code
id: checkout
uses: actions/checkout@v4

- name: Run SCANOSS analysis
id: scanoss-scan-action
uses: scanoss/actions-scan@main
- name: Run SCANOSS Code Scan
id: scanoss-code-scan-step
uses: scanoss/code-scan-action@main
with:
policies: copyleft, undeclared #NOTE: undeclared policy requires a sbom.json in the project root
dependencies.enabled: true
Expand All @@ -128,8 +126,8 @@ jobs:


- name: Print stdout scan command
run: echo "${{ steps.scanoss-scan-action.outputs.stdout-scan-command }}"
run: echo "${{ steps.scanoss-code-scan-step.outputs.stdout-scan-command }}"

- name: Print Results
run: cat "${{ steps.scanoss-scan-action.outputs.result-filepath }}"
run: cat "${{ steps.scanoss-code-scan-step.outputs.result-filepath }}"
```
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 7 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
{
"name": "scanoss-actions-scan",
"name": "scanoss-code-scan-action",
"description": "SCANOSS Action",
"version": "0.1.0",
"author": "",
"author": "SCANOSS",
"private": true,
"homepage": "https://github.com/scanoss/actions-scan/",
"homepage": "https://github.com/scanoss/code-scan-action/",
"repository": {
"type": "git",
"url": "git+https://github.com/scanoss/actions-scan.git"
"url": "git+https://github.com/scanoss/code-scan-action.git"
},
"bugs": {
"url": "https://github.com/scanoss/actions-scan/issues"
"url": "https://github.com/scanoss/code-scan-action/issues"
},
"keywords": [
"actions",
"code-scan",
"code-scan-action",
"node",
"setup"
],
Expand Down
2 changes: 1 addition & 1 deletion sbom.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"components": [
{
"purl": "pkg:github/scanoss/actions-scan"
"purl": "pkg:github/scanoss/code-scan-action"
}
]
}
Loading