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

Add CI check for SPDX/copyright headers #229

Merged
merged 1 commit into from
Feb 13, 2025
Merged

Conversation

qmonnet
Copy link
Member

@qmonnet qmonnet commented Feb 13, 2025

Let's automate the check on SPDX header and copyright notice for new files. This commit introduces a workflow to ensure that all source code files have these headers. It's simpler to rely on the check than to expect reviewers to think about it each time a new file is added to the repository.

"Source code files" are currently defined as Rust files (.rs), shell scripts (.sh), and justfile.

We could optimize this workflow to run only when source files are modified. But the check is to trivial that it's currently not worth the pain.

@qmonnet qmonnet added the ci Continuous Integration label Feb 13, 2025
@qmonnet qmonnet requested a review from a team as a code owner February 13, 2025 11:58
@qmonnet qmonnet requested review from Fredi-raspall and removed request for a team February 13, 2025 11:58
Let's automate the check on SPDX header and copyright notice for new
files. This commit introduces a workflow to ensure that all source code
files have these headers. It's simpler to rely on the check than to
expect reviewers to think about it each time a new file is added to the
repository.

"Source code files" are currently defined as Rust files (.rs), shell
scripts (.sh), and justfile.

We could optimize this workflow to run only when source files are
modified. But the check is to trivial that it's currently not worth the
pain.

Signed-off-by: Quentin Monnet <[email protected]>
@qmonnet qmonnet force-pushed the pr/qmonnet/ci-spdx-check branch from 18e6c79 to e6409d7 Compare February 13, 2025 12:01
@qmonnet
Copy link
Member Author

qmonnet commented Feb 13, 2025

Works as I expected:
image

I'm removing the test commit.

@qmonnet qmonnet force-pushed the pr/qmonnet/ci-spdx-check branch from e6409d7 to f960351 Compare February 13, 2025 12:02
@mvachhar mvachhar self-requested a review February 13, 2025 14:36
@mvachhar mvachhar added this pull request to the merge queue Feb 13, 2025
Merged via the queue into main with commit 80150bc Feb 13, 2025
13 checks passed
@mvachhar mvachhar deleted the pr/qmonnet/ci-spdx-check branch February 13, 2025 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants