Skip to content

Commit 16ea4c2

Browse files
committed
chore:SP-3582 Adds documentation for the new GitLab Code Quality format and GitLab matches summary features in CLIENT_HELP.md
1 parent 1add83e commit 16ea4c2

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99
### Added
1010
- Upcoming changes...
1111

12-
## [1.38.0] - 2025-10-22
12+
## [1.38.0] - 2025-10-23
1313
### Added
1414
- Added `glc-codequality` format to convert subcomand
1515
- Added `inspect gitlab matches` subcommand to generate GitLab-compatible Markdown match summary from SCANOSS scan results

CLIENT_HELP.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ scanoss-py scan src -hdr "x-api-key:12345" -hdr "Authorization: Bearer <access_t
260260
```
261261

262262
### Converting RAW results into other formats
263-
The following command provides the capability to convert the RAW scan results from a SCANOSS scan into multiple different formats, including CycloneDX, SPDX Lite, CSV, etc.
263+
The following command provides the capability to convert the RAW scan results from a SCANOSS scan into multiple different formats, including CycloneDX, SPDX Lite, CSV and GitLab Code Quality Report.
264264
For the full set of formats, please run:
265265
```bash
266266
scanoss-py cnv --help
@@ -271,6 +271,12 @@ The following command converts `scan-results.json` to SPDX Lite:
271271
scanoss-py cnv --input scan-results.json --format spdxlite --output scan-results-spdxlite.json
272272
```
273273

274+
The following command converts `scan-results.json` to GitLab Code Quality Report:
275+
```bash
276+
scanoss-py cnv --input scan-results.json --format glc-codequality --output gl-code-quality-report.json
277+
```
278+
279+
274280
### Component Commands
275281
The `component` command has a suite of sub-commands designed to operate on OSS components. For example:
276282
* Vulnerabilities (`vulns`)
@@ -432,6 +438,7 @@ For example:
432438
* License Summary (`license-summary`)
433439
* Component Summary (`component-summary`)
434440
* Dependency Track project violations (`dependency-track project-violations`)
441+
* GitLab Components Match Summary (`gitlab matches`)
435442
436443
For the latest list of sub-commands, please run:
437444
```bash
@@ -551,6 +558,11 @@ Example with project name and version:
551558
scanoss-py inspect dt project-violations --dt-upload-token <dt-upload-token> --dt-url <dependency-track-url> --dt-projectname <dependency-track-project-name> --dt-projectversion <dependency-track-project-version> --dt-apikey <dependency-track-api-key> --format md --output project-violations.md
552559
```
553560
561+
#### Inspect GitLab Component Match Summary Markdown Output
562+
The following command can be used to generate a component match summary in Markdown format for GitLab:
563+
```bash
564+
scanoss-py inspect gitlab matches --input <scanoss-scan-results.json> -lpr <line-range-prefix> --output gitlab-component-match-summary.md
565+
```
554566
555567
### Folder-Scan a Project Folder
556568

0 commit comments

Comments
 (0)