Skip to content

REUSE compliance#2269

Open
brownbaerchen wants to merge 13 commits into
helmholtz-analytics:mainfrom
brownbaerchen:reuse_linter
Open

REUSE compliance#2269
brownbaerchen wants to merge 13 commits into
helmholtz-analytics:mainfrom
brownbaerchen:reuse_linter

Conversation

@brownbaerchen

@brownbaerchen brownbaerchen commented Apr 28, 2026

Copy link
Copy Markdown
Collaborator

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 reuse linting tool to check the licensing.

Now, we already have a LICENSE file, 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 to LICENSES/MIT.txt and specify that this should apply globally in REUSE.toml. Annoyingly, we cannot merge that with pyproject.toml at 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:

  • Implement reuse linting GitHub workflow on push to main
  • Make global MIT license machine readable
  • Reference original licenses of datasets packaged with Heat
  • Remove unused images

Type of change

Delivering deliverables

Does this change modify the behaviour of other functions? If so, which?

no

@brownbaerchen brownbaerchen added the HeatHub The HeatHub project, as part of Science Serve, aims to foster the Heat community. label Apr 28, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Roadmap Apr 28, 2026
@brownbaerchen brownbaerchen marked this pull request as ready for review May 5, 2026 14:02
Copilot AI review requested due to automatic review settings May 5, 2026 14:02

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.toml with global MIT licensing annotations and per-dataset overrides.
  • Add LICENSES/MIT.txt and update the README to reference the new license location and include a REUSE status badge.
  • Add a GitHub Actions workflow to run reuse lint in 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.

Comment thread REUSE.toml
Comment thread REUSE.toml
Comment thread README.md
[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7688/badge)](https://bestpractices.coreinfrastructure.org/projects/7688)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2531472.svg)](https://doi.org/10.5281/zenodo.2531472)
[![Benchmarks](https://img.shields.io/badge/Grafana-Benchmarks-2ea44f)](https://930000e0-e69a-4939-912e-89a92316b420.ka.bw-cloud-instance.org/grafana)
[![REUSE status](https://api.reuse.software/badge/git.fsfe.org/reuse/api)](https://api.reuse.software/info/git.fsfe.org/reuse/api)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to use a status badge for push to main because this is part of that action, actually.

Comment thread .github/workflows/reuse_compliance.yml Outdated
Comment thread .github/workflows/reuse_compliance.yml Outdated
@brownbaerchen brownbaerchen marked this pull request as draft May 5, 2026 14:17
@brownbaerchen brownbaerchen marked this pull request as ready for review May 22, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

benchmark PR HeatHub The HeatHub project, as part of Science Serve, aims to foster the Heat community.

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants