Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for (collected) license files via directories, globs, list files #4121

Closed
mbargull opened this issue Nov 3, 2020 · 2 comments · Fixed by #4153
Closed

Support for (collected) license files via directories, globs, list files #4121

mbargull opened this issue Nov 3, 2020 · 2 comments · Fixed by #4153
Labels
locked [bot] locked due to inactivity

Comments

@mbargull
Copy link
Member

mbargull commented Nov 3, 2020

Actual Behavior

Currently, we can specify either single files or a list of files for the about: license_file: field.

In some language ecosystems like Rust or Go it is common to vendor dependencies.
The license files of these dependencies are then included in the source distributions but often/usually there is no readily composed list of them available. Hence, it would make sense to use helper scripts during the build to gather a list of those license files and use that list as an input for the about: license_file: field.

Expected Behavior

Allow one or more of the following:

  1. Allow entries in license_file to point to directories and recursive include all files in them as "license files".
    (Appending a suffix / could be made a requirement to make this behavior opt-in.)
  2. Allow (recursive) globs in license_file entries to be given instead of only static file names.
  3. Allow some additional syntax to recognize entries in license_file not as "license files" directly, but just as list files.
    (e.g., have a gather_licenses script create a ${SRC_DIR}/thirdparty-licenses file in which every line references the actual license files and have license_file: <some new syntax>thirdparty-licenses expand to the file list.)

All of the options above bare the possibility to accidentally include additional non-license files. But I believe it can be rather subjective to judge if one or the other is more prone to it. Hence, I think all of them more or less equally good and I would probably go with the one that is easiest to use and document*, i.e., option 1.

(* usage instruction could be simple as "move thirdparty license files to a $SRC_DIR/additional-licenses folder and add to license_file an entry additional-licenses/ (ending with / to denote a directory for which all files are included recursively)".)

@mbargull
Copy link
Member Author

mbargull commented Nov 3, 2020

This feature request is only for the license_file field and not the license field. One could argue that it would be nice to parse all these additional licenses and compose a SPDX license expression (or a similar summary) from them. That, however, would be an elaborate undertaking and should be a separate feature request -- and, frankly, composing such expressions/summary should be done in a separate tool, IMO.

@github-actions
Copy link

github-actions bot commented Mar 6, 2022

Hi there, thank you for your contribution!

This issue has been automatically locked because it has not had recent activity after being closed.

Please open a new issue if needed.

Thanks!

@github-actions github-actions bot added the locked [bot] locked due to inactivity label Mar 6, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
locked [bot] locked due to inactivity
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant