Skip to content

Commit f016ef9

Browse files
Update CHANGELOG and Output Format Version
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 4ad28c8 commit f016ef9

File tree

2 files changed

+52
-1
lines changed

2 files changed

+52
-1
lines changed

CHANGELOG.rst

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,57 @@ v33.0.0 (next next, roadmap)
1717
v32.1.0 (next, roadmap)
1818
----------------------------
1919

20+
Major API/other changes:
21+
22+
- Output Format Version updated to 3.1.0 (minor version bump)
23+
- Drops python 3.7 and adopts python 3.12
24+
- New license match attributes:
25+
- ``from_file``
26+
- ``matched_text_diagnostics`` is added for ``--license-text-diagnostics``
27+
- In codebase-level ``license_detections`` we have a new attribute
28+
``reference_matches``
29+
- SPDX license expressions everywhere side-by-side with ScanCode
30+
license expressions.
31+
- All rule attribute level data provided in codebase level ``todo`` items.
32+
33+
Changes in Output Data Structure:
34+
35+
- The data structure of the JSON output has changed for
36+
licenses at file level, and license detections at top-level.
37+
But note that all the changes are additions to the JSON output,
38+
so we have a minor version bump ``3.0.0`` to ``3.1.0``:
39+
40+
- There is a new attribute ``from_file`` in ``matches`` which is in
41+
``license_detections`` in:
42+
* File level ``license_detections``
43+
* Codebase level ``license_detections``
44+
* ``license_detections`` and ``other_license_detections`` in
45+
file-level ``package_data``
46+
* ``license_detections`` and ``other_license_detections`` in
47+
codebase level ``packages``
48+
49+
- On using the CLI option ``--license-text-diagnostics`` there is
50+
now a new license match attribute ``matched_text_diagnostics``
51+
with the matched text and highlighted diagnostics, instead of
52+
having this replace the plain ``matched_text``.
53+
54+
- A new ``reference_matches`` attribute is added to codebase-level
55+
``license_detections`` which is same as the ``matches`` attribute
56+
in other license detections.
57+
58+
- We now have SPDX license expressions everywhere we have
59+
ScanCode license expressions for ease of use and adopting
60+
SPDX everywhere. A new attribute ``license_expression_spdx``
61+
is added to:
62+
- ``license_detections`` in file and codebase level
63+
- in package ``license_detections`` and ``other_license_detections``
64+
- ``matches`` for ``license_detections`` everywhere
65+
66+
- Adds all rule atrribute level info in codebase level ``todo``
67+
data, to assist in review. This includes length, text, notes,
68+
referenced_filenames, and the boolean attributes (like
69+
is_license_notice, is_license_intro etc, as applicable).
70+
2071
- A new field in packages with the license category for the
2172
detected license expression and also an API function to
2273
compute license categories from license expressions.

src/scancode_config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ def _create_dir(location):
141141

142142
# See https://github.com/nexB/scancode-toolkit/issues/2653 for more information
143143
# on the data format version
144-
__output_format_version__ = '3.0.0'
144+
__output_format_version__ = '3.1.0'
145145

146146
#
147147
spdx_license_list_version = '3.22'

0 commit comments

Comments
 (0)