REUSE compliance#2269
Open
brownbaerchen wants to merge 13 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces REUSE compliance infrastructure for the Heat repository by adding a REUSE configuration, moving the MIT license text into the REUSE-expected LICENSES/ layout, and wiring up CI to lint licensing metadata.
Changes:
- Add
REUSE.tomlwith global MIT licensing annotations and per-dataset overrides. - Add
LICENSES/MIT.txtand update the README to reference the new license location and include a REUSE status badge. - Add a GitHub Actions workflow to run
reuse lintin CI.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
REUSE.toml |
Defines global SPDX annotations and dataset-specific license overrides for REUSE linting. |
README.md |
Adds a REUSE badge and updates the license link to the new LICENSES/MIT.txt path. |
LICENSES/MIT.txt |
Provides the MIT license text in the machine-readable location expected by REUSE. |
.github/workflows/reuse_compliance.yml |
Adds CI automation to run reuse lint. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| [](https://bestpractices.coreinfrastructure.org/projects/7688) | ||
| [](https://doi.org/10.5281/zenodo.2531472) | ||
| [](https://930000e0-e69a-4939-912e-89a92316b420.ka.bw-cloud-instance.org/grafana) | ||
| [](https://api.reuse.software/info/git.fsfe.org/reuse/api) |
Collaborator
Author
There was a problem hiding this comment.
We need to use a status badge for push to main because this is part of that action, actually.
This file contains hidden or 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
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.
We have promised in the HeatHub project to achieve and enforce REUSE compliance. This is about licensing. We need to specify a license and integrate the
reuselinting tool to check the licensing.Now, we already have a
LICENSEfile, which specifies MIT license globally and we don't want to change that at this time. However, this is apparently not machine readable. In order to make the machine accept our global license, we need to move the license toLICENSES/MIT.txtand specify that this should apply globally inREUSE.toml. Annoyingly, we cannot merge that withpyproject.tomlat this time.Note that the linter runs on push to main, which is sufficient because added files will automatically fall under the global license. So the only way to fail the linter is to change the licenses in
REUSE.toml.In order to create the proper badge, we need to merge this first so the action on push to main is actually triggered. Then we can address #2318 and replace the fake badge from here with a proper one.
Changes proposed:
Type of change
Delivering deliverables
Does this change modify the behaviour of other functions? If so, which?
no