Skip to content

feat: check headers regarding copyright and license #35

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.

Sign up for GitHub

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

Merged
yocaba merged 2 commits into from
Sep 25, 2026
Merged

feat: check headers regarding copyright and license #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74a6c43
chore: keep templating in the LICENSE file
yocaba Sep 22, 2026
f0d6000
feat: check headers regarding copyright and license, not just header …
yocaba Sep 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2026 Open Defense Cloud contributors
Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
28 changes: 27 additions & 1 deletion common.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,14 +135,40 @@ OSV_SCANNER_CONFIG ?= ./.osv-scanner.toml
scan: $(OSV_SCANNER) ## scan for vulnerabilities
$(OSV_SCANNER) scan --config $(OSV_SCANNER_CONFIG) -r .

# Files subject to a license header: everything matching `pattern`, minus
# generated files.
addlicense_files = git ls-files '$(pattern)' | (xargs -r grep -L -E '^(//|\#) Code generated .* DO NOT EDIT\.$$' || true)

# The SPDX identifier expected in the header, and what addlicense writes for
# `license=apache`. Override `spdx` should a repository ever use another one.
spdx ?= Apache-2.0

# addlicense with -check, only ever sees a *missing* header, never an outdated
# one, and it never inspects the SPDX line at all;
# `|| true` because grep -L exits 1 when it selects nothing, which
# .SHELLFLAGS = -ec would make fatal.
addlicense_mismatch = $$({ $(addlicense_files) | xargs -r grep -L -F 'Copyright $(comment)' || true; \
$(addlicense_files) | xargs -r grep -L -F 'SPDX-License-Identifier: $(spdx)' || true; } | sort -u)
Comment thread
coderabbitai[bot] marked this conversation as resolved.

.PHONY: addlicense
addlicense: $(ADDLICENSE) ## Add License headers containing of `license` and `comment` to files matched by `pattern`.
@test -n "$(license)" && test -n "$(comment)" && test -n "$(pattern)" && \
git ls-files '$(pattern)' | xargs -r $(ADDLICENSE) -c '$(comment)' -l '$(license)' -s=only $(extraargs)
$(addlicense_files) | xargs -r $(ADDLICENSE) -c '$(comment)' -l '$(license)' -s=only -y '' $(extraargs)

.PHONY: addlicense-list
addlicense-list: ## List files matched by `pattern` whose header does not carry `Copyright $(comment)` and `SPDX-License-Identifier: $(spdx)`.
@test -n "$(comment)" && test -n "$(pattern)"
@files=$(addlicense_mismatch); \
if [ -n "$$files" ]; then \
echo "Unexpected license header, expected 'Copyright $(comment)' and 'SPDX-License-Identifier: $(spdx)':"; \
echo "$$files" | sed 's/^/ /'; \
fi

.PHONY: addlicense-check
addlicense-check:
$(MAKE) addlicense extraargs='-check'
@$(MAKE) addlicense-list
@test -z "$(addlicense_mismatch)"

# Local dev environment
.PHONY: setup-local-cluster
Expand Down
Loading