Skip to content

Commit 74e1dd2

Browse files
Update CHANGELOG and docs on project settings
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 653d804 commit 74e1dd2

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

CHANGELOG.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,16 @@ v34.9.4 (unreleased)
4343
sheets with a dedicated VULNERABILITIES sheet.
4444
https://github.com/aboutcode-org/scancode.io/issues/1519
4545

46+
- Update scancode-toolkit to v32.3.2. See CHANGELOG for updates:
47+
https://github.com/aboutcode-org/scancode-toolkit/releases/tag/v32.3.2
48+
https://github.com/aboutcode-org/scancode-toolkit/releases/tag/v32.3.1
49+
50+
- Adds a project settings `scan_max_file_size` and a scancode.io settings field
51+
`SCANCODEIO_SCAN_MAX_FILE_SIZE` to skip scanning files above a certain
52+
file size (in bytes) as a temporary fix for large memory spikes while
53+
scanning for licenses in certain large files.
54+
https://github.com/aboutcode-org/scancode-toolkit/issues/3711
55+
4656
v34.9.3 (2024-12-31)
4757
--------------------
4858

docs/project-configuration.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Content of a ``scancode-config.yml`` file:
5454
ignored_patterns:
5555
- '*.tmp'
5656
- 'tests/*'
57+
scan_max_file_size: 5242880
5758
ignored_dependency_scopes:
5859
- package_type: npm
5960
scope: devDependencies
@@ -86,6 +87,24 @@ product_version
8687

8788
The product version of this project, as specified within the DejaCode application.
8889

90+
scan_max_file_size
91+
^^^^^^^^^^^^^^^^^^
92+
93+
Maximum file size allowed for a file to be scanned when scanning a codebase.
94+
95+
The value unit is bytes and is defined as an integer, see the following
96+
example of setting this at 5 MB::
97+
98+
scan_max_file_size=5242880
99+
100+
Default is ``None``, in which case all files will be scanned.
101+
102+
.. note::
103+
This is the same as the scancodeio setting ``SCANCODEIO_SCAN_MAX_FILE_SIZE``
104+
set using the .env file, and the project setting ``scan_max_file_size`` takes
105+
precedence over the scancodeio setting ``SCANCODEIO_SCAN_MAX_FILE_SIZE``.
106+
107+
89108
ignored_patterns
90109
^^^^^^^^^^^^^^^^
91110

0 commit comments

Comments
 (0)