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

Use REUSE framework #3546

Merged
merged 12 commits into from
Jul 20, 2022
Merged

Use REUSE framework #3546

merged 12 commits into from
Jul 20, 2022

Conversation

nlohmann
Copy link
Owner

See https://reuse.software

  • Added license headers to relevant source files.
  • Added CI step to check REUSE compliance.

@coveralls
Copy link

coveralls commented Jun 18, 2022

Coverage Status

Coverage remained the same at 100.0% when pulling 71aa668 on reuse into 2a9ae2b on develop.

@nlohmann nlohmann self-assigned this Jun 21, 2022
@nlohmann nlohmann added the review needed It would be great if someone could review the proposed changes. label Jun 21, 2022
@gregmarr
Copy link
Contributor

Is it expected that the single include now has all the individual license blocks in it?

@nlohmann
Copy link
Owner Author

Is it expected that the single include now has all the individual license blocks in it?

I guess yes. It’s not nice, but accurate.

@gregmarr
Copy link
Contributor

Is the removal of the license files from tools and tests/thirdparty expected? Are they located somewhere else now?

@falbrechtskirchinger
Copy link
Contributor

They've all moved into the LICENSES/ folder, right?

@gregmarr
Copy link
Contributor

Those files in LICENSES/ just look like templates, not specific licenses for specific files.

@falbrechtskirchinger
Copy link
Contributor

falbrechtskirchinger commented Jun 21, 2022

This seems to be the way to handle this today. Keep the specific copyright information with SPDX identifier in the source and bundle the license "templates".

That's the idea I'm getting based on other projects' usage. anyway.

@gregmarr
Copy link
Contributor

After digging further, it looks like the licenses are also in the source files in those directories, so no separate license file is needed.

@nlohmann
Copy link
Owner Author

The idea of REUSE is to make the project a bit more machine-readable. You can call pipx run reuse spdx to get a bill of materials that contains, for each file, the license and copyright.

I removed all license files from the project, because REUSE only requires one copy in the LICENSES folder for every used license - all things that would be filled in there are exactly the copyrights we have in the files. I kept the root LICENSE.MIT to help GitHub understand that the main part of the project is MIT-licensed. If I have to guess, GitHub will eventually also overwork their license support.

nlohmann and others added 2 commits June 21, 2022 20:50
Co-authored-by: Florian Albrechtskirchinger <falbrechtskirchinger@gmail.com>
@nlohmann nlohmann added release item: 🔨 further change and removed review needed It would be great if someone could review the proposed changes. labels Jul 20, 2022
@nlohmann nlohmann added this to the Release 3.11.0 milestone Jul 20, 2022
@nlohmann nlohmann merged commit 527da54 into develop Jul 20, 2022
@nlohmann nlohmann deleted the reuse branch July 20, 2022 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants