Add changelog entry and documentation for the new pipeline #1182

Signed-off-by: tdruez <tdruez@nexb.com>
aboutcode-org · May 29, 2024 · 1f4cce4 · 1f4cce4
1 parent 997cd6a
commit 1f4cce4
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,6 +4,9 @@ Changelog
 v34.6.0 (unreleased)
 --------------------
 
+- Add a new ``scan_for_virus`` add-on pipeline based on ClamAV scan.
+  https://github.com/nexB/scancode.io/issues/1182
+
 - Add ability to filter by tag on the resource list view.
   https://github.com/nexB/scancode.io/issues/1217
 

diff --git a/docs/built-in-pipelines.rst b/docs/built-in-pipelines.rst
@@ -182,6 +182,14 @@ Scan Codebase
     :members:
     :member-order: bysource
 
+.. _pipeline_scan_for_virus:
+
+Scan For Virus
+--------------
+.. autoclass:: scanpipe.pipelines.scan_for_virus.ScanForVirus()
+    :members:
+    :member-order: bysource
+
 .. _pipeline_scan_single_package:
 
 Scan Single Package

diff --git a/scanpipe/pipelines/scan_for_virus.py b/scanpipe/pipelines/scan_for_virus.py
@@ -28,7 +28,7 @@
 
 
 class ScanForVirus(Pipeline):
-    """Run a ClamAV scan on the uploaded file to detect virus infection."""
+    """Run a ClamAV scan on the codebase directory to detect virus infection."""
 
     download_inputs = False
     is_addon = True