-
Notifications
You must be signed in to change notification settings - Fork 7
Perform SPDX license and copyright checks with reuse #81
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
base: main
Are you sure you want to change the base?
Perform SPDX license and copyright checks with reuse #81
Conversation
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.
.pre-commit-config.yaml
Outdated
| - repo: https://codeberg.org/fsfe/reuse-tool | ||
| rev: a1bb792acda6fd0724936b4ebbdbc8eceb9c0459 # v6.2.0 | ||
| hooks: | ||
| - id: reuse-lint-file | ||
| exclude: devcontainer-lock.json|.*\.png |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the reviewer: reuse is added here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add it to some readme somewhere on how to use the tool (without precommit)? Where is the config?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
at the moment there is no config. I will try your template proposal
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.github/workflows/ci.yaml
Outdated
| # 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to figure out where this header came from and if this change is ok
.pre-commit-config.yaml
Outdated
| - repo: https://codeberg.org/fsfe/reuse-tool | ||
| rev: a1bb792acda6fd0724936b4ebbdbc8eceb9c0459 # v6.2.0 | ||
| hooks: | ||
| - id: reuse-lint-file | ||
| exclude: devcontainer-lock.json|.*\.png |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add it to some readme somewhere on how to use the tool (without precommit)? Where is the config?
Sure? https://reuse.readthedocs.io/en/stable/man/reuse-annotate.html#templates |
I removed the opengrep solution now, but For example this However whenever |
There was a problem hiding this comment.
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
| - id: reuse-lint-file | ||
| name: reuse-lint-file (fix with `./scripts/run_reuse_annotate.sh`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should pre-commit not run ./scripts/run_reuse_annotate.sh directly?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
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. If only SPDX information is needed we can trim the header and remove opengrep.