Skip to content

Commit 9992d15

Browse files
committed
Update class description #1763
Signed-off-by: Chin Yeung Li <tli@nexb.com>
1 parent 97a109b commit 9992d15

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

scanpipe/pipelines/scan_maven_package.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,19 @@
2929

3030
class ScanMavenPackage(ScanSinglePackage, DeployToDevelop):
3131
"""
32-
Scan a single maven package archive.
32+
Scan a single maven package archive, or run a D2D scan for a maven package.
3333
3434
This pipeline scans a single maven package for package metadata,
3535
declared dependencies, licenses, license clarity score and copyrights.
3636
37+
In addition, if the `deploy_to_develop` option is enabled, it performs a
38+
D2D (deploy to develop) scan for Maven projects.
39+
40+
It requires a minimum of two archive files, each properly tagged with:
41+
42+
- **from** for archives containing the development source code.
43+
- **to** for archives containing the deployment compiled code.
44+
3745
The output is a summary of the scan results in JSON format.
3846
"""
3947

0 commit comments

Comments
 (0)