Perform SPDX license and copyright checks with reuse by lurtz · Pull Request #81 · eclipse-score/devcontainer

lurtz · 2026-02-09T10:55:10Z

reuse is specialized to check for SPDX license and copyright information in source files. It is capable of checking way more file types than we currently check with opengrep and faster. In addition to that the Eclipse foundation recommends to use it.

reuse annotate is run in pre-commit hooks, which automatically fixes missing / incorrect headers.

reuse is specialized to check for SPDX license and copyright information in source files. It is capable of checking way more file types than we currently check with opengrep and faster. However it only checks for SPDX information and not the full mandatory copyright header. Therefore opengrep will still be used to check that, but SPDX information will be checked with reuse.

lurtz · 2026-02-09T10:58:30Z

.pre-commit-config.yaml

+  - repo: https://codeberg.org/fsfe/reuse-tool
+    rev: a1bb792acda6fd0724936b4ebbdbc8eceb9c0459 # v6.2.0
+    hooks:
+      - id: reuse-lint-file
+        exclude: devcontainer-lock.json|.*\.png


For the reviewer: reuse is added here

Can you add it to some readme somewhere on how to use the tool (without precommit)? Where is the config?

at the moment there is no config. I will try your template proposal

Is this enough?

https://github.com/elektrobit-contrib/eclipse-score_devcontainer/blob/90d00f48718d96ef8a515c33d1b9a0e03b50e3af/README.md?plain=1#L119-L125

AlexanderLanin · 2026-02-09T11:03:42Z

.github/workflows/ci.yaml

 # terms of the Apache License Version 2.0 which is available at
 # https://www.apache.org/licenses/LICENSE-2.0
 #
+# SPDX-FileCopyrightText: Copyright (c) 2026 Contributors to the Eclipse Foundation


We need to figure out where this header came from and if this change is ok

AlexanderLanin · 2026-02-09T11:07:41Z

.pre-commit-config.yaml

+  - repo: https://codeberg.org/fsfe/reuse-tool
+    rev: a1bb792acda6fd0724936b4ebbdbc8eceb9c0459 # v6.2.0
+    hooks:
+      - id: reuse-lint-file
+        exclude: devcontainer-lock.json|.*\.png


Can you add it to some readme somewhere on how to use the tool (without precommit)? Where is the config?

AlexanderLanin · 2026-02-09T11:11:57Z

However it only checks for SPDX information and not the full mandatory copyright

Sure? https://reuse.readthedocs.io/en/stable/man/reuse-annotate.html#templates

.github/CODEOWNERS

lurtz · 2026-02-09T14:17:39Z

However it only checks for SPDX information and not the full mandatory copyright

Sure? https://reuse.readthedocs.io/en/stable/man/reuse-annotate.html#templates

I removed the opengrep solution now, but reuse still does not enforce the full header and only checks for SPDX lines. It fails when these are missing.

For example this CODEOWNERS file would be compliant, when running reuse lint:

# SPDX-FileCopyrightText: 2026 Contributors to the Eclipse Foundation
# SPDX-License-Identifier: Apache-2.0

* @opajonk @lurtz

However whenever reuse annotate is run via scripts/run_reuse_annotate.sh, reuse will apply the template and add the full header.

lurtz · 2026-02-09T14:20:52Z

LICENSES/Apache-2.0.txt

note the rename. Maybe we still need to keep a copy at LICENSE

AlexanderLanin · 2026-02-09T14:31:39Z

.pre-commit-config.yaml

+      - id: reuse-lint-file
+        name: reuse-lint-file (fix with `./scripts/run_reuse_annotate.sh`)


should pre-commit not run ./scripts/run_reuse_annotate.sh directly?

I would love to, but I did not find a way to achieve that. I might need to write a custom rule to do that

I assume you can do it like this: https://github.com/eclipse-score/dash-license-scan/blob/420c21c753db1494aacb8ce824e49af5d7a54862/.pre-commit-config.yaml#L20

it is now done using a custom pre-commit rule

lurtz commented Feb 9, 2026

View reviewed changes

lurtz marked this pull request as ready for review February 9, 2026 10:59

AlexanderLanin reviewed Feb 9, 2026

View reviewed changes

lurtz added 6 commits February 9, 2026 12:44

use reuse template to write license / copyright header

57a391b

remove opengrep

097dc9a

fix header of NOTICE file

4f32d08

fix more forgotten files

2c61ead

add script for running reuse

3a7c0bc

add instructions how to use reuse

ebfc31d

lurtz commented Feb 9, 2026

View reviewed changes

.github/CODEOWNERS Outdated Show resolved Hide resolved

fix codeowners

90d00f4

lurtz commented Feb 9, 2026

View reviewed changes

LICENSES/Apache-2.0.txt

Copy link

Contributor Author

lurtz Feb 9, 2026

Choose a reason for hiding this comment

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

note the rename. Maybe we still need to keep a copy at LICENSE

AlexanderLanin reviewed Feb 9, 2026

View reviewed changes

lurtz added 4 commits February 12, 2026 11:39

Merge remote-tracking branch 'origin/main' into check-licenses-via-reuse

b0c8b90

Fix license headers with pre-commit hooks

47dddc2

remove deleted and unstaged files from the set of files to annotate

cb3f5d6

do not pass filenames to reuse

944d06a

AlexanderLanin approved these changes Feb 12, 2026

View reviewed changes

AlexanderLanin merged commit 74c2964 into eclipse-score:main Feb 12, 2026
4 checks passed

lurtz deleted the check-licenses-via-reuse branch February 12, 2026 13:18

		- id: reuse-lint-file
		name: reuse-lint-file (fix with `./scripts/run_reuse_annotate.sh`)

Conversation

lurtz commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin commented Feb 9, 2026

Uh oh!

Uh oh!

lurtz commented Feb 9, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lurtz commented Feb 9, 2026 •

edited

Loading

AlexanderLanin Feb 9, 2026 •

edited

Loading

AlexanderLanin Feb 9, 2026 •

edited

Loading