Add license check script for incompatible licenses in pip dependencies #16753
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seanbudd
changed the title
See test results for failed build of commit a842aade39 |
WalkthroughThe recent changes focus on enhancing license compliance checks within the project. A new PowerShell and batch script have been added to automate license checks during the build process. The documentation has been updated to reflect these changes, and dependencies have been modified to ensure compatibility with the new license-checking requirements. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant BuildSystem as Build System
participant LicenseCheck as licenseCheck.ps1
participant BatchScript as runlicensecheck.bat
Developer->>BuildSystem: Pushes code to repository
BuildSystem->>BuildSystem: Triggers build process
BuildSystem->>LicenseCheck: Executes licenseCheck.ps1 script
LicenseCheck->>LicenseCheck: Create license output directory
LicenseCheck->>BatchScript: Calls runlicensecheck.bat
BatchScript->>LicenseCheck: Sets up environment and runs license check
LicenseCheck->>BuildSystem: Sets build variables based on check results
BuildSystem->>Developer: Provides feedback on license check success/failure
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
seanbudd
commented
Jun 28, 2024
gerald-hartig
approved these changes
Jul 1, 2024
|
|
||
| ### License checks | ||
|
|
||
| NVDA uses GPLv2 which is incompatible with certain licenses like Apache. |
There was a problem hiding this comment.
is it "v2" or "v2 or later"
There was a problem hiding this comment.
our current license is just GPLv2 with 2 modifications
https://github.com/nvaccess/nvda/blob/8fb8ffcaba3950b1e4ca7b58e165267fc5369eb9/copying.txt
| rem Runs a license check for python dependencies | ||
| set hereOrig=%~dp0 | ||
| set here=%hereOrig% | ||
| if #%hereOrig:~-1%# == #\# set here=%hereOrig:~0,-1% |
There was a problem hiding this comment.
Is this perhaps clearer in intent?
Suggested change
| if #%hereOrig:~-1%# == #\# set here=%hereOrig:~0,-1% | |
| if #%here:~-1%# == #\# set here=%here:~0,-1% |
There was a problem hiding this comment.
I'm not sure, this is magic sauce at the top of each of our .bat files. I'm afraid to change it without updating them all, and concerned this suggestion is different in handling
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link to issue number:
None
Summary of the issue:
NVDA is licensed with GPL2 which is incompatible with certain licenses like Apache.
Currently there are 2 python dependencies bundled with NVDA with incompatible licenses:
Description of user facing changes
runlicensecheck.batDescription of development approach
Testing strategy:
Known issues with pull request:
This doesn't check other dependencies such as those in
includeormiscDepsCode Review Checklist:
Summary by CodeRabbit
New Features
Documentation
runlicensecheck.batscript.Dependencies
licensecheckpackage torequirements.txt.Pillow,wxPython, andconfigobj.