Skip to content

Commit

Permalink
Merge branch 'fix/vulnerabilities' into feature/license-review-status
Browse files Browse the repository at this point in the history
  • Loading branch information
OmkarPh committed Nov 4, 2023
2 parents 642615e + 0a1f75b commit ee8970a
Show file tree
Hide file tree
Showing 18 changed files with 9,611 additions and 20,491 deletions.
10 changes: 9 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on `Keep a
Changelog <https://keepachangelog.com/en/1.0.0/>`__

[Unreleased (v4.0.0)]
[v4.0.0] - 2023-10-26
--------------------------

**This ScanCode-Workbench release contains schema changes: scans will have to be re-imported**
Expand All @@ -20,6 +20,7 @@ Entire source code is refactored to TypeScript + React
New Features
~~~~~~~~~~~~

- Add support for ScanCode Toolkit v32.x
- Maintain history of imports for quick access
- Updated dependencies
- Support for top level packages-deps obtained in latest scans
Expand All @@ -43,7 +44,14 @@ New Features
- Remove ability to edit conclusions & remove conclusions view
- Search in licenses explorer
- Filters for packages based on dependencies flags & data_source_id
- License clues section in Licenses explorer view
- Normalize Chart summary data
- Close file & cleanup option
- Unit tests
- Dependency Info dashboard - Dependency Scope summary by Package Type
- Working indicator for queries
- Diff modal for Matched text & Rule text in Matches table


Bug Fixes
~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Description
Please leave a brief discription of the bug or feature request:
* if reporting a bug, tell us how to reproduce the issue.
* Check the Develop Console tab and copy any error text there might be: https://scancode-workbench.readthedocs.io/en/develop/basics/check_for_errors_in_the_developer_tools.html
* Check the Develop Console tab and copy any error text there might be: https://scancode-workbench.readthedocs.io/en/latest/basics/check_for_errors_in_the_developer_tools.html

### System configuration
For bug reports, it really helps us to know:
Expand Down
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# <p align="center"><img src="src/assets/images/scancode-workbench-logo.png" align="center" alt="ScanCode Workbench">
<p align="center"><img src="src/assets/images/scancode-workbench-logo.png" align="center" alt="ScanCode Workbench">
</p>

[![Test CI](https://github.com/nexB/scancode-workbench/actions/workflows/Test.yml/badge.svg)](https://github.com/nexB/scancode-workbench/actions/workflows/Test.yml)
Expand All @@ -13,10 +13,9 @@ and other interesting information in your code.
ScanCode Workbench is based on
[Electron](https://www.electronjs.org/) and will be the primary desktop/GUI tool
for using nexB’s [AboutCode tools](https://github.com/nexB/aboutcode). This app
works on Windows, OS X and Linux operating systems.

![ScanCode Workbench](https://user-images.githubusercontent.com/48476025/185114433-7340ee70-57cd-4586-b7e7-964fe736451a.gif)
works on Windows, macOS and Linux operating systems.

![ScanCode Workbench](/src/assets/images/workbench_intro.gif)

## Using

Expand All @@ -40,13 +39,13 @@ information captured by a scan. The samples are located at
the [documentation](https://scancode-workbench.readthedocs.io) for more
information on how to use ScanCode Workbench.

[Import a JSON file](https://scancode-workbench.readthedocs.io/en/develop/how-to-guides/load-your-data/import-json.html)
[Import a JSON file](https://scancode-workbench.readthedocs.io/en/latest/how-to-guides/load-your-data/import-json.html)

## Running locally

You'll need [Node.js](https://nodejs.org) (which comes with [npm](http://npmjs.com))
installed on your computer in order to build this app. For a list of platform
specific requirements, see the Building section of the [documentation](https://scancode-workbench.readthedocs.io/en/develop/contribute/building.html).
specific requirements, see the Building section of the [documentation](https://scancode-workbench.readthedocs.io/en/latest/contribute/building.html).
Then, from your command line:

```bash
Expand Down
11 changes: 9 additions & 2 deletions Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,13 @@
- Diff modal for Matched text & Rule text in Matches table https://github.com/nexB/scancode-workbench/pull/577
- Working indicator for queries https://github.com/nexB/scancode-workbench/pull/583
- Dashboard updates https://github.com/nexB/scancode-workbench/pull/585
- Close file & cleanup https://github.com/nexB/scancode-workbench/pull/600
- Unit tests https://github.com/nexB/scancode-workbench/pull/591
- Dependency Info dashboard updates https://github.com/nexB/scancode-workbench/pull/594
- Updated documentation https://github.com/nexB/scancode-workbench/pull/602

## ScanCode Toolkit Compatibility
This beta version of ScanCode Workbench is compatible with scans from any [ScanCode Toolkit](https://github.com/nexB/scancode-toolkit/) releases at or after [`v32.0.0rc4`](https://github.com/nexB/scancode-toolkit/releases/tag/v32.0.0rc4) and also from the latest develop, but using the latest `v32.x` stable releases is recommended: [latest SCTK release](https://github.com/nexB/scancode-toolkit/releases/latest).
This v4.0.0 of ScanCode Workbench is compatible with scans from any [ScanCode Toolkit](https://github.com/nexB/scancode-toolkit/) releases at or after [`v32.0.0`](https://github.com/nexB/scancode-toolkit/releases/tag/v32.0.0rc4) and also from the latest develop, but using the latest `v32.x` stable releases is recommended: [latest SCTK release](https://github.com/nexB/scancode-toolkit/releases/latest).

## Bug fixes
- Prevent crashes on unsupported scans
Expand All @@ -30,4 +34,7 @@ This beta version of ScanCode Workbench is compatible with scans from any [ScanC
- window title update & occasional sqlite error for packages https://github.com/nexB/scancode-workbench/pull/560
- license detection parser issues, trimmed filter options, hide empty 'other dependencies' https://github.com/nexB/scancode-workbench/pull/569
- Refined UX including consistent scrollbars, tooltips, Search in licenses, filters for dependencies https://github.com/nexB/scancode-workbench/pull/587
- Updated piechart tooltip https://github.com/nexB/scancode-workbench/pull/582
- Updated piechart tooltip https://github.com/nexB/scancode-workbench/pull/582
- Automatic height for tables https://github.com/nexB/scancode-workbench/pull/606
- Fixed Empty directory being shown with file icon https://github.com/nexB/scancode-workbench/pull/604
- Fix irregular scroll behavior for files in deeply nested FileTree https://github.com/nexB/scancode-workbench/pull/599
2 changes: 1 addition & 1 deletion archive_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import platform

# Expected output file name: ScanCode-Workbench-{platform}-{arch}-{version}.tar.gz
# Example: ScanCode-Workbench-linux-x64-3.1.1.tar.gz
# Example: ScanCode-Workbench-linux-x64-4.0.0.tar.gz

# Archive properties
APP_NAME = 'ScanCode-Workbench'
Expand Down
1 change: 0 additions & 1 deletion electron-builder.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"appId": "com.electron.scancode-workbench",
"productName": "ScanCode Workbench",
"directories": {
"app": ".",
"output": "out",
"buildResources": "build-res"
},
Expand Down
Loading

0 comments on commit ee8970a

Please sign in to comment.