Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 31 additions & 6 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,52 @@ Changelog
=========

v33.0.0 (next next, roadmap)

----------------------------


- We now support new package manifest formats:

- OpenWRT packages.
- Yocto/BitBake .bb recipes.

- Fallback packages for non-native dependencies of SCTK.
- Dependencies for
- Support for copyright detection objects.

v32.0.0 (next, roadmap)
-----------------------
v32.1.0 (next, roadmap)
----------------------------

- A new field in packages with the license category for the
detected license expression and also an API function to
compute license categories from license expressions.
See https://github.com/nexB/scancode-toolkit/issues/2897

- More support for tabular output formats: New command-line
options for XSLX output, and the old `--csv` command line
option is removed.
See https://github.com/nexB/scancode-toolkit/issues/830

- `--unknown-licenses` is removed and this is always enabled
and only used in case of improper detections automatically.
Also tag all license rules with required phrases to improve
license detection and reduce false positives.
See https://github.com/nexB/scancode-toolkit/issues/3300

- File categorization support added, a post scan plugin tagging
files with priority levels for review, and also take advantage
of these in other summary plugins.
See https://github.com/nexB/scancode-toolkit/issues/1745

v32.0.0 - 2023-05-23
---------------------

Important API changes:
~~~~~~~~~~~~~~~~~~~~~~

This is a major release with major API and output format changes and signicant
feature updates.

In particular changed to the output format for the licenses and packages, and
we changed some of the command line options.
In particular the output format has changed for the licenses and packages, and
also for some of the command line options.

The output format version is now 3.0.0.

Expand Down
11 changes: 9 additions & 2 deletions ROADMAP.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ This is for SCTK first.

Status: This has been completed in SCTK and also included in SCIO. We use
an updated --summary option and a new license clarity score for this.
Some work is still in progress as part of 3.) "detections"
We also have LicenseDetections for resources/packages and a top level
unique license detections as a summary.


2. Package files.
Expand All @@ -50,11 +51,15 @@ This has been completed in SCTK and also included in SCIO.
- package: object of its own, and related set of files, not always in the same
directory

This is completed in SCTK.

*License*:

- many detections in a file at different locations, could be merged into a single reported license
- same for primary licenses

This is completed in SCTK.

*Copyright*:

- Copyright and author detection, which are tracked at the line level
Expand All @@ -76,6 +81,7 @@ Roadmap

- SCTK: add primary license field in package output and populate this based on
package-type/ecosystem conventions.
- SCTK: also populate secondary license fields
- SCIO: add primary license field in DiscoveredPackage models and feed it with
the data from packages
- SCIO: Do we track secondary? or is this just data aggregated on the fly.
Expand All @@ -87,7 +93,7 @@ Roadmap

- This is closely tied to the primary license detection and should focus
on package manifests and key files.

- Support copyright parsing from all package ecosystems.

3. Package files
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -122,3 +128,4 @@ Roadmap
- Revamp how common list of suprrious licenses are detected (this is a bug)
- Use important key phrases for license detection https://github.com/nexB/scancode-toolkit/issues/2637

This is mostly completed, for follow up see https://github.com/nexB/scancode-toolkit/issues/2878.
2 changes: 1 addition & 1 deletion setup-mini.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = scancode-toolkit
version = 32.0.0rc4
version = 32.0.0
license = Apache-2.0 AND CC-BY-4.0 AND LicenseRef-scancode-other-permissive AND LicenseRef-scancode-other-copyleft

# description must be on ONE line https://github.com/pypa/setuptools/issues/1390
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = scancode-toolkit
version = 32.0.0rc4
version = 32.0.0
license = Apache-2.0 AND CC-BY-4.0 AND LicenseRef-scancode-other-permissive AND LicenseRef-scancode-other-copyleft

# description must be on ONE line https://github.com/pypa/setuptools/issues/1390
Expand Down
2 changes: 1 addition & 1 deletion src/scancode_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ def _create_dir(location):
# 4. hardcoded This is the default, fallback version in case package is not installed or we
# do not have a proper version otherwise.
if not __version__:
__version__ = '32.0.0rc4'
__version__ = '32.0.0'

#######################
# used to warn user when the version is out of date
Expand Down